Update documentation around CRD removal #3422
Merged
Conversation
This file contains 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
matthchr
reviewed
Oct 17, 2023
|
|
||
| -- Retrieved from [**helm.sh**](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/) on Monday, 16 October 2023 | ||
|
|
||
| ### Uninstalling with kubectl |
There was a problem hiding this comment.
After this, wonder if we should have a ### Uninstalling the CRDs section, which explains that:
- Neither of the above commands for Helm or kubectl will uninstall the CRDs, nor automatically delete any Custom Resource instances.
- Uninstalling the CRDs is dangerous (risk of data loss), and should only be done on a cluster that has ASO already uninstalled via one of the above methods and no existing instances of the CRDs. This can be verified by running the (somewhat slow to execute):
kubectl api-resources -o name | grep azure.com | paste -sd "," - | xargs kubectl get -A - Deleting the CRDs can be accomplished by running
kubectl delete -f https://github.com/Azure/azure-service-operator/releases/download/v2.3.0/azureserviceoperator_customresourcedefinitions_v2.3.0.yaml
I don't have a Windows version of the command for kubectl api-resources -o name | grep azure.com | paste -sd "," - | xargs kubectl get -A, and there might be a better command for it... I will play around and see if I can find one... but that one is better than what we have currently so might be worth including.
There was a problem hiding this comment.
I'll add a warning section; we can add specific commands in a later PR.
matthchr
approved these changes
Oct 30, 2023
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.
What this PR does / why we need it:
Fixes incorrect documentation.
Closes #3416
How does this PR make you feel:
If applicable: