This repository has been archived by the owner on Jul 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 277
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ref(docs): update uninstall guide (#3003)
+ update uninstall guide + update uninstall troubleshooting guide + resolves #2880 Signed-off-by: Michelle Noorali <minooral@microsoft.com>
- Loading branch information
Michelle Noorali
committed
Apr 1, 2021
1 parent
60b1a92
commit d5bf349
Showing
5 changed files
with
165 additions
and
44 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: "Install Troubleshooting" | ||
description: "OSM Mesh Install Troubleshooting Guide" | ||
type: docs | ||
--- | ||
|
||
# OSM Mesh Install Troubleshooting Guide | ||
|
||
## Leaked Resources | ||
|
||
During an improper or incomplete uninstallation, it is possible that OSM resources could be left behind in a Kubernetes cluster. | ||
|
||
For example, if the Helm release, OSM controller, or their respective namespaces are deleted, then the `osm` CLI won't be able to uninstall any remaining resources, particularly if they are cluster scoped. | ||
|
||
As a result, one may see this error during a subsequent install of a new mesh with the same name but different namespace: | ||
|
||
```console | ||
Error: rendered manifests contain a resource that already exists. Unable to continue with install: ClusterRole "<mesh-name>" 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 "<new-namespace>": current value is "<old-namespace>" | ||
``` | ||
|
||
In the case of this error, use the [cleanup script](https://github.com/openservicemesh/osm/blob/release-v0.8/scripts/cleanup/osm-cleanup.sh) located in the osm repository to delete any remaining resources. | ||
|
||
To run the script, create a `.env` environment variable file to set the values specified at the top of the script. These values should match the values used to deploy the mesh. | ||
|
||
In the root directory of the osm repository locally, run: | ||
|
||
```console | ||
./scripts/cleanup/osm-cleanup.sh | ||
``` | ||
|
||
Then, try installing OSM again on the cluster. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: "Uninstall Troubleshooting" | ||
description: "OSM Mesh Uninstall Troubleshooting Guide" | ||
type: docs | ||
--- | ||
|
||
# OSM Mesh Uninstall Troubleshooting Guide | ||
|
||
## Unsuccessful Uninstall | ||
|
||
If for any reason, `osm uninstall` is unsuccessful, run the [cleanup script](https://github.com/openservicemesh/osm/blob/release-v0.8/scripts/cleanup/osm-cleanup.sh) which will delete any OSM related resources. | ||
|
||
To run the script, create a `.env` environment variable file to set the values specified at the top of the script. These values should match the values used to deploy the mesh. | ||
|
||
In the root directory of the osm repository locally, run: | ||
|
||
```console | ||
./scripts/cleanup/osm-cleanup.sh | ||
``` |
This file was deleted.
Oops, something went wrong.
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