Document registry_enabled limitation and add tests#580
Open
cipheraxat wants to merge 1 commit intodigitalocean:mainfrom
Open
Document registry_enabled limitation and add tests#580cipheraxat wants to merge 1 commit intodigitalocean:mainfrom
cipheraxat wants to merge 1 commit intodigitalocean:mainfrom
Conversation
Fixes digitalocean#433 The registry_enabled field is read-only in Kubernetes cluster responses and cannot be set during cluster creation. This is a limitation of the DigitalOcean API, not the pydo client. Changes: - Added comprehensive documentation in README explaining the correct approach for enabling container registry integration - Added integration test demonstrating the proper workflow: 1. Create cluster (registry_enabled defaults to False) 2. Call add_registry to enable integration 3. Verify registry_enabled is True 4. Call remove_registry to disable integration 5. Verify registry_enabled is False - Added mocked test showing the expected behavior - Both tests reference issue digitalocean#433 for context The correct approach is to use the add_registry operation after cluster creation, rather than attempting to pass registry_enabled during creation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #433
This PR addresses the confusion around the
registry_enabledfield in Kubernetes cluster creation. The field is read-only in the API and cannot be set during cluster creation.Problem
Users expect to be able to pass
registry_enabled: Truewhen creating a Kubernetes cluster, but this parameter is ignored because it's a read-only field in the API response.Solution
This PR:
The Correct Approach
To enable container registry integration with a Kubernetes cluster:
Changes
test_kubernetes_cluster_registry_integrationintegration testtest_kubernetes_cluster_with_registry_integrationmocked testTesting
All existing tests continue to pass, and the new tests verify the correct behavior.