Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🌱 Fix typo in charts README #664

Merged
merged 1 commit into from
Oct 21, 2024
Merged

🌱 Fix typo in charts README #664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions deploy/cluster-manager/chart/cluster-manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,38 @@
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
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 <version> ocm/cluster-manager --namespace=open-cluster-management --create-namespace
helm install cluster-manager --version <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
```

19 changes: 9 additions & 10 deletions deploy/klusterlet/chart/klusterlet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
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
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:

Expand All @@ -43,7 +43,7 @@ helm install klusterlet --version <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:

Expand All @@ -68,17 +68,16 @@ helm install <klusterlet name> --version <version> ocm/klusterlet \
> You can create the `bootstrap-hub-kubeconfig` and `externalManagedKubeConfig` secrets in the `klusterlet-<cluster name>` 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 <klusterlet name>
```

## Uninstall the Chart
### Uninstall the Chart

```bash
helm uninstall <klusterlet name>
helm uninstall klusterlet --namespace=open-cluster-management
```
Loading