Skip to content

Commit

Permalink
doc: make the chart installation doc easier to understand.
Browse files Browse the repository at this point in the history
Signed-off-by: jwcesign <[email protected]>
  • Loading branch information
jwcesign committed Nov 22, 2023
1 parent bf1098b commit 59af1bc
Showing 1 changed file with 27 additions and 27 deletions.
54 changes: 27 additions & 27 deletions charts/karmada/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,41 +23,41 @@ To install the chart with the release name `karmada` in namespace `karmada-syste

- local installation

Switch to the `root` directory of the repo.
Switch to the `root` directory of the repo.

```console
helm install karmada -n karmada-system --create-namespace --dependency-update ./charts/karmada
```
```console
helm install karmada -n karmada-system --create-namespace --dependency-update ./charts/karmada
```

- remote installation

First, add the Karmada chart repo to your local repository.
First, add the Karmada chart repo to your local repository.

```console
$ helm repo add karmada-charts https://raw.githubusercontent.com/karmada-io/karmada/master/charts
$ helm repo list
NAME URL
karmada-charts https://raw.githubusercontent.com/karmada-io/karmada/master/charts
```
```console
$ helm repo add karmada-charts https://raw.githubusercontent.com/karmada-io/karmada/master/charts
$ helm repo list
NAME URL
karmada-charts https://raw.githubusercontent.com/karmada-io/karmada/master/charts
```

With the repo added, available charts and versions can be viewed.
With the repo added, available charts and versions can be viewed.

```console
helm search repo karmada
```
```console
helm search repo karmada
```

Install the chart and specify the version to install with the --version argument. Replace <x.x.x> with your desired version.
Install the chart and specify the version to install with the --version argument. Replace <x.x.x> with your desired version.

```console
helm --namespace karmada-system upgrade -i karmada karmada-charts/karmada --version=<x.x.x> --create-namespace
Release "karmada" does not exist. Installing it now.
NAME: karmada
LAST DEPLOYED: Mon May 30 07:19:36 2022
NAMESPACE: karmada-system
STATUS: deployed
REVISION: 1
TEST SUITE: None
```
```console
helm --namespace karmada-system upgrade -i karmada karmada-charts/karmada --version=<x.x.x> --create-namespace
Release "karmada" does not exist. Installing it now.
NAME: karmada
LAST DEPLOYED: Mon May 30 07:19:36 2022
NAMESPACE: karmada-system
STATUS: deployed
REVISION: 1
TEST SUITE: None
```

Get kubeconfig from the cluster:

Expand Down Expand Up @@ -107,7 +107,7 @@ The command removes all the Kubernetes components associated with the chart and
```console
kubectl delete sa/karmada-pre-job -nkarmada-system
kubectl delete clusterRole/karmada-pre-job
kubectl delete clusterRole/karmada-pre-job
kubectl delete clusterRoleBinding/karmada-pre-job
kubectl delete ns karmada-system
```
Expand Down

0 comments on commit 59af1bc

Please sign in to comment.