4b13590 · typeable/octopod

git.iko.soy/typeable/octopod

Small docs fixes (#129)

commit4b13590e31d3bf44d4c3cec730fe7418d1c9de04 authorAlex-Sizov <45825279+Alex-Sizov@users.noreply.github.com> dateWed 6 Oct 2021, 11:49 (5 years ago) parent372f5dd

3 files changed+7−5

compare with master

unifiedsplit

charts/octopod/README.md+4−2 docs/en/Octo_user_guide.md+2−2 helm-control-scripts/README.md+1−1

charts/octopod/README.md+4−2

@@ -5,6 +5,7 @@

55## TL;DR

66```console

77$ helm repo add typeable https://typeable.github.io/octopod/

8+$ helm repo update

89$ kubectl create ns octopod-deployment

910$ helm install octopod typeable/octopod --set octopod.baseDomain="your-domain.com"

1011```

@@ -31,13 +32,14 @@ You'll need to create 2 namespaces before installing:

3132 ```

32332. A namespace in which Octopod will deploy all your deployments (configured in `octopod.deploymentNamespace`):

3334 ```console

34− $ kubectl create namespace octopod-deployments

35+ $ kubectl create namespace octopod-deployment

3536 ```

3637

3738To install the chart with the release name `my-release` execute:

3839

3940```console

4041$ helm repo add typeable https://typeable.github.io/octopod/

42+$ helm repo update

4143$ helm -n octopod install my-release typeable/octopod --set octopod.baseDomain="your-domain.com"

4244```

4345

@@ -155,7 +157,7 @@ $ helm install my-release -f values.yaml .

155157## Configuration and installation details

156158

157159If you want to have authentication for Octopod UI you can use project like [Oauth2-Proxy](https://github.com/oauth2-proxy/oauth2-proxy) or directly use your oauth provider.

158−After that you can add following annotations to UI ingress (considering that your oauth provider installed on oath.example.com):

160+After that you can add following annotations to UI ingress (considering that your oauth provider installed on oauth.example.com):

159161```yaml

160162ingress:

161163 ui:

docs/en/Octo_user_guide.md+2−2

@@ -6,14 +6,14 @@ All commands _octo CLI_ executes require the executable to send authenticated re

77### `OCTOPOD_URL`

9−`OCTOPOD_URL` is an environment variable _octo CLI_ reads to find your particular _Octopod Server_ installation. For example, it could contain `https://octopod-power-app.example.com:443`.

9+`OCTOPOD_URL` is an environment variable _octo CLI_ reads to find your particular _Octopod Server_ installation. For example, it could contain `https://octopod-powerapp.example.com:443`.

1010

1111### `OCTO_AUTHORIZATION_HEADER`

1212

1313`OCTO_AUTHORIZATION_HEADER` is an environment variable that should contain the `Authorization` header to use to authenticate requests to your Octopod server. You can obtain the header value by running the following command after installing Octopod:

1414

1515```bash

16−kubectl -n octopod get secret octopod-cli-auth-secret -o jsonpath='{.data.cli-secret}' | base64 -d

16+kubectl -n octopod get secret <HELM_RELEASE_NAME>-cli-auth-secret -o jsonpath='{.data.cli-secret}' | base64 -d

1717```

1818

1919## Commands

helm-control-scripts/README.md+1−1

@@ -1,7 +1,7 @@

11# Generic scripts

33This is a complete suite of Octopod control scripts to deploy helm charts.

4−You can get pre-built docker images from [hub.docker.com/r/typeable/octopod-generic-utils](https://hub.docker.com/r/typeable/octopod-generic-utils).

4+You can get pre-built docker images from [typeable/octopod-helm-control-scripts](https://hub.docker.com/repository/docker/typeable/octopod-helm-control-scripts).

66### Contents