This repository has been archived by the owner on Jul 11, 2023. It is now read-only.
ref(docs): update uninstall guide #3003
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
draychev
reviewed
Mar 25, 2021
michelleN
force-pushed
the
uninstall
branch
2 times, most recently
from
7defd42
to
051c322
Compare
nojnhuh
suggested changes
Mar 30, 2021
| @@ -8,44 +8,136 @@ weight: 3 | |||
|
|
|||
| # Uninstallation Guide | |||
|
|
|||
| This guide describes how to uninstall Open Service Mesh (OSM) from a Kubernetes cluster using the `osm` CLI. | |||
| This guide describes how to uninstall Open Service Mesh (OSM) from a Kubernetes cluster. This guide assumes there is a single OSM control plane (mesh) running. If there are multiple meshes in a cluster, repeat the process described for each control plane in the cluster before uninstalling any cluster wide resources at the end of the guide. Taking into consideration both the control plane and dataplane, this guide aims to walk through uninstalling all reminents of OSM with minimal downtime. | |||
There was a problem hiding this comment.
Suggested change
| This guide describes how to uninstall Open Service Mesh (OSM) from a Kubernetes cluster. This guide assumes there is a single OSM control plane (mesh) running. If there are multiple meshes in a cluster, repeat the process described for each control plane in the cluster before uninstalling any cluster wide resources at the end of the guide. Taking into consideration both the control plane and dataplane, this guide aims to walk through uninstalling all reminents of OSM with minimal downtime. | |
| This guide describes how to uninstall Open Service Mesh (OSM) from a Kubernetes cluster. This guide assumes there is a single OSM control plane (mesh) running. If there are multiple meshes in a cluster, repeat the process described for each control plane in the cluster before uninstalling any cluster wide resources at the end of the guide. Taking into consideration both the control plane and dataplane, this guide aims to walk through uninstalling all remnants of OSM with minimal downtime. |
| once part of the mesh. Identify these resources by using the `kubectl get ingress -n <namespace>` command in each namespace that was | ||
| removed from the mesh earlier. | ||
|
|
||
| If there are ingress resources and they are configured to allow HTTPS traffic, SSL related annotations will need to be update appropriately. |
There was a problem hiding this comment.
Suggested change
| If there are ingress resources and they are configured to allow HTTPS traffic, SSL related annotations will need to be update appropriately. | |
| If there are ingress resources and they are configured to allow HTTPS traffic, SSL related annotations will need to be updated appropriately. |
|
|
||
| If there are ingress resources and they are configured to allow HTTPS traffic, SSL related annotations will need to be update appropriately. | ||
|
|
||
| If ingress resources need to be reconfigured, this may result in some down time of traffic from outside the cluster not being able to get to the applications. |
There was a problem hiding this comment.
This might be a bit of a cleaner way to say the same thing:
Suggested change
| If ingress resources need to be reconfigured, this may result in some down time of traffic from outside the cluster not being able to get to the applications. | |
| Applications may be unavailable from outside the cluster if ingress resources need to be reconfigured. |
|
|
||
| ## Resource Management | ||
| Once the sidecar is removed, there is no need for the Envoy bootstrap config secrets OSM created. These are stored in the application namespace and can be deleted manually with `kubectl`. |
There was a problem hiding this comment.
It would be good to give a hint here as to what those secrets look like, like a label, annotation, or example name.
|
|
||
| ``` | ||
| Error: rendered manifests contain a resource that already exists. Unable to continue with install: ClusterRole "osm" in namespace "" exists and cannot be imported into the current release: invalid ownership metadata; annotation validation error: key "meta.helm.sh/release-namespace" must equal "osm-system2": current value is "osm-system" | ||
| As a result, one may see this error during a subsequent install of a new mesh with the same name but different namespace: |
There was a problem hiding this comment.
I wonder if this may fit better in the install troubleshooting doc since it's an error that occurs at install time.
|
Thanks for the feedback @nojnhuh. Please re-review when you have a few minutes. |
nojnhuh
approved these changes
Mar 31, 2021
SanyaKochhar
approved these changes
Apr 1, 2021
+ update uninstall guide + update uninstall troubleshooting guide + resolves openservicemesh#2880 Signed-off-by: Michelle Noorali <minooral@microsoft.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Signed-off-by: Michelle Noorali minooral@microsoft.com
Please mark with X for applicable areas.
-->
Affected area:
Please answer the following questions with yes/no.