diff --git a/deploy/cluster-manager/chart/cluster-manager/README.md b/deploy/cluster-manager/chart/cluster-manager/README.md index c93702b91..8c5ee471a 100644 --- a/deploy/cluster-manager/chart/cluster-manager/README.md +++ b/deploy/cluster-manager/chart/cluster-manager/README.md @@ -3,7 +3,7 @@ The cluster-manager provides the multicluster hub, which can manage Kubernetes-based clusters across data centers, public clouds, and private clouds. This operator supports the installation and upgrade of ClusterManager. -# Get Repo Info +## Get Repo Info ```bash helm repo add ocm https://open-cluster-management.io/helm-charts @@ -11,31 +11,30 @@ helm repo update helm search repo ocm ``` -# Install the Chart +## Install the Chart For example, install the chart into `open-cluster-management` namespace. ```bash -$ helm install cluster-manager --version ocm/cluster-manager --namespace=open-cluster-management --create-namespace +helm install cluster-manager --version ocm/cluster-manager --namespace=open-cluster-management --create-namespace ``` -# Uninstall the Chart +## Uninstall -## Delete all managedClusters before uninstall the Chart. +### Delete all managedClusters before uninstall the Chart ```bash kubectl get managedcluster | awk '{print $1}' | xargs kubectl delete managedcluster ``` -## And then delete the clusterManager CR. +### And then delete the clusterManager CR ``` bash kubectl delete clustermanagers cluster-manager ``` -## Uninstall the Chart +### Uninstall the Chart ```bash -helm uninstall cluster-manager +helm uninstall cluster-manager --namespace=open-cluster-management ``` - diff --git a/deploy/klusterlet/chart/klusterlet/README.md b/deploy/klusterlet/chart/klusterlet/README.md index aebada2ec..6b2168d33 100644 --- a/deploy/klusterlet/chart/klusterlet/README.md +++ b/deploy/klusterlet/chart/klusterlet/README.md @@ -3,11 +3,11 @@ The klusterlet provides the registration to the Hub clusters as a managed cluster. This operator supports the installation and upgrade of klusterlet. -# Prerequisites +## Prerequisites You need a Hub cluster which has installed clusterManager operator. -# Get Repo Info +## Get Repo Info ```bash helm repo add ocm https://open-cluster-management.io/helm-charts @@ -15,9 +15,9 @@ helm repo update helm search repo ocm ``` -# Install the Chart +## Install the Chart -### Run klusterlet on Default mode. +### Run klusterlet on Default mode Install the Chart on the managed cluster: @@ -43,7 +43,7 @@ helm install klusterlet --version ocm/klusterlet \ > You can create the `bootstrap-hub-kubeconfig` secret in the `open-cluster-management-agent` namespace > after install the chart without setting `bootstrapHubKubeConfig`. -### Run klusterlet on Hosted mode. +### Run klusterlet on Hosted mode Install the Chart on the hosting cluster without installing operator: @@ -68,17 +68,16 @@ helm install --version ocm/klusterlet \ > You can create the `bootstrap-hub-kubeconfig` and `externalManagedKubeConfig` secrets in the `klusterlet-` namespace > after install the chart without setting `bootstrapHubKubeConfig` and `externalManagedKubeConfig`. +## Uninstall -# Uninstall the Chart - -## Delete the klusterlet CR. +### Delete the klusterlet CR ``` bash kubectl delete klusterlet ``` -## Uninstall the Chart +### Uninstall the Chart ```bash -helm uninstall +helm uninstall klusterlet --namespace=open-cluster-management ```