Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eshepelyuk committed May 13, 2022
1 parent bd786d2 commit 5bcd684
Showing 1 changed file with 12 additions and 17 deletions.
29 changes: 12 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,18 @@ CMAK operator comprises following components:

## Installation

It's recommended to install CMAK operator into a dedicated namespace.

1. Search for all available versions
`cmak-operator` chart is published into OCI compatible registry
and requires Helm version >= 3.8.

```sh
helm search repo cmak-operator --versions

NAME CHART VERSION APP VERSION DESCRIPTION
cmak/cmak-operator 0.2.1 3.0.0.5 CMAK operator for K8S.
cmak/cmak-operator 0.2.0 3.0.0.5 CMAK operator for K8S.
```
It's recommended to install CMAK operator into a dedicated namespace.
To install specific `VERSION` use following command.

1. Install specific version
```sh
helm upgrade -i --wait --create-namespace -n cmak cmak-operator \
oci://ghcr.io/eshepelyuk/helm/cmak-operator --version <VERSION>
```

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

### Verify installation

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

```sh
kubectl port-forward -n cmak-ns service/cmak 9000:9000
kubectl port-forward -n cmak service/cmak 9000
```

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

```sh
helm upgrade -i --wait --create-namespace -n cmak cmak-operator \
oci://ghcr.io/eshepelyuk/helm/cmak-operator --version <VERSION> -f cmak-values.yaml
oci://ghcr.io/eshepelyuk/helm/cmak-operator --version <VERSION> \
-f cmak-values.yaml
```

### CMAK application settings
Expand Down

0 comments on commit 5bcd684

Please sign in to comment.