Skip to content

Commit 5bcd684

Browse files
committed
chore: docs
1 parent bd786d2 commit 5bcd684

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,18 @@ CMAK operator comprises following components:
2323

2424
## Installation
2525

26-
It's recommended to install CMAK operator into a dedicated namespace.
27-
28-
1. Search for all available versions
26+
`cmak-operator` chart is published into OCI compatible registry
27+
and requires Helm version >= 3.8.
2928

30-
```sh
31-
helm search repo cmak-operator --versions
32-
33-
NAME CHART VERSION APP VERSION DESCRIPTION
34-
cmak/cmak-operator 0.2.1 3.0.0.5 CMAK operator for K8S.
35-
cmak/cmak-operator 0.2.0 3.0.0.5 CMAK operator for K8S.
36-
```
29+
It's recommended to install CMAK operator into a dedicated namespace.
30+
To install specific `VERSION` use following command.
3731

38-
1. Install specific version
32+
```sh
33+
helm upgrade -i --wait --create-namespace -n cmak cmak-operator \
34+
oci://ghcr.io/eshepelyuk/helm/cmak-operator --version <VERSION>
35+
```
3936

40-
```sh
41-
helm upgrade -i --wait --create-namespace -n cmak cmak-operator \
42-
oci://ghcr.io/eshepelyuk/helm/cmak-operator --version <VERSION>
43-
```
37+
To install the latest version - omit `--version` flag from previous command.
4438

4539
### Verify installation
4640

@@ -50,7 +44,7 @@ nor any other K8s resources to expose UI via HTTP.
5044
The simpliest test is to port forward CMAK UI HTTP port and access it from browser.
5145

5246
```sh
53-
kubectl port-forward -n cmak-ns service/cmak 9000:9000
47+
kubectl port-forward -n cmak service/cmak 9000
5448
```
5549

5650
Then, open http://localhost:9000 in a browser.
@@ -61,7 +55,8 @@ Configuration should be passed to helm via command line during installation or u
6155

6256
```sh
6357
helm upgrade -i --wait --create-namespace -n cmak cmak-operator \
64-
oci://ghcr.io/eshepelyuk/helm/cmak-operator --version <VERSION> -f cmak-values.yaml
58+
oci://ghcr.io/eshepelyuk/helm/cmak-operator --version <VERSION> \
59+
-f cmak-values.yaml
6560
```
6661

6762
### CMAK application settings

0 commit comments

Comments
 (0)