Skip to content

Commit 07092e0

Browse files
seedling: Fix typo in charts README (#665)
Signed-off-by: zhujian <jiazhu@redhat.com> Co-authored-by: zhujian <jiazhu@redhat.com>
1 parent 6c475a9 commit 07092e0

File tree

2 files changed

+17
-19
lines changed

2 files changed

+17
-19
lines changed

deploy/cluster-manager/chart/cluster-manager/README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,38 @@
33
The cluster-manager provides the multicluster hub, which can manage Kubernetes-based clusters across data centers,
44
public clouds, and private clouds. This operator supports the installation and upgrade of ClusterManager.
55

6-
# Get Repo Info
6+
## Get Repo Info
77

88
```bash
99
helm repo add ocm https://open-cluster-management.io/helm-charts
1010
helm repo update
1111
helm search repo ocm
1212
```
1313

14-
# Install the Chart
14+
## Install the Chart
1515

1616
For example, install the chart into `open-cluster-management` namespace.
1717

1818
```bash
19-
$ helm install cluster-manager --version <version> ocm/cluster-manager --namespace=open-cluster-management --create-namespace
19+
helm install cluster-manager --version <version> ocm/cluster-manager --namespace=open-cluster-management --create-namespace
2020
```
2121

22-
# Uninstall the Chart
22+
## Uninstall
2323

24-
## Delete all managedClusters before uninstall the Chart.
24+
### Delete all managedClusters before uninstall the Chart
2525

2626
```bash
2727
kubectl get managedcluster | awk '{print $1}' | xargs kubectl delete managedcluster
2828
```
2929

30-
## And then delete the clusterManager CR.
30+
### And then delete the clusterManager CR
3131

3232
``` bash
3333
kubectl delete clustermanagers cluster-manager
3434
```
3535

36-
## Uninstall the Chart
36+
### Uninstall the Chart
3737

3838
```bash
39-
helm uninstall cluster-manager
39+
helm uninstall cluster-manager --namespace=open-cluster-management
4040
```
41-

deploy/klusterlet/chart/klusterlet/README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@
33
The klusterlet provides the registration to the Hub clusters as a managed cluster.
44
This operator supports the installation and upgrade of klusterlet.
55

6-
# Prerequisites
6+
## Prerequisites
77

88
You need a Hub cluster which has installed clusterManager operator.
99

10-
# Get Repo Info
10+
## Get Repo Info
1111

1212
```bash
1313
helm repo add ocm https://open-cluster-management.io/helm-charts
1414
helm repo update
1515
helm search repo ocm
1616
```
1717

18-
# Install the Chart
18+
## Install the Chart
1919

20-
### Run klusterlet on Default mode.
20+
### Run klusterlet on Default mode
2121

2222
Install the Chart on the managed cluster:
2323

@@ -43,7 +43,7 @@ helm install klusterlet --version <version> ocm/klusterlet \
4343
> You can create the `bootstrap-hub-kubeconfig` secret in the `open-cluster-management-agent` namespace
4444
> after install the chart without setting `bootstrapHubKubeConfig`.
4545
46-
### Run klusterlet on Hosted mode.
46+
### Run klusterlet on Hosted mode
4747

4848
Install the Chart on the hosting cluster without installing operator:
4949

@@ -68,17 +68,16 @@ helm install <klusterlet name> --version <version> ocm/klusterlet \
6868
> You can create the `bootstrap-hub-kubeconfig` and `externalManagedKubeConfig` secrets in the `klusterlet-<cluster name>` namespace
6969
> after install the chart without setting `bootstrapHubKubeConfig` and `externalManagedKubeConfig`.
7070
71+
## Uninstall
7172

72-
# Uninstall the Chart
73-
74-
## Delete the klusterlet CR.
73+
### Delete the klusterlet CR
7574

7675
``` bash
7776
kubectl delete klusterlet <klusterlet name>
7877
```
7978

80-
## Uninstall the Chart
79+
### Uninstall the Chart
8180

8281
```bash
83-
helm uninstall <klusterlet name>
82+
helm uninstall klusterlet --namespace=open-cluster-management
8483
```

0 commit comments

Comments
 (0)