typeable/octopod
1
0
Fork 0
mirror of https://github.com/typeable/octopod.git synced 2024-11-22 08:45:20 +03:00
Code Issues Projects Releases Wiki Activity

Small docs fixes (#129)

Browse Source
This commit is contained in:
Alex-Sizov 2021-10-06 11:49:37 +03:00 committed by GitHub
parent 372f5dd635
commit 4b13590e31
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
charts/octopod/README.md
View File

@ -5,6 +5,7 @@
## TL;DR
```console
$ helm repo add typeable https://typeable.github.io/octopod/
$ helm repo update
$ kubectl create ns octopod-deployment
$ helm install octopod typeable/octopod --set octopod.baseDomain="your-domain.com"
```
@ -31,13 +32,14 @@ You'll need to create 2 namespaces before installing:
```
2. A namespace in which Octopod will deploy all your deployments (configured in `octopod.deploymentNamespace`):
```console
$ kubectl create namespace octopod-deployments
$ kubectl create namespace octopod-deployment
```
To install the chart with the release name `my-release` execute:
```console
$ helm repo add typeable https://typeable.github.io/octopod/
$ helm repo update
$ helm -n octopod install my-release typeable/octopod --set octopod.baseDomain="your-domain.com"
```
@ -155,7 +157,7 @@ $ helm install my-release -f values.yaml .
## Configuration and installation details
If 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.
After that you can add following annotations to UI ingress (considering that your oauth provider installed on oath.example.com):
After that you can add following annotations to UI ingress (considering that your oauth provider installed on oauth.example.com):
```yaml
ingress:
ui:

4
docs/en/Octo_user_guide.md
View File

@ -6,14 +6,14 @@ All commands _octo CLI_ executes require the executable to send authenticated re
### `OCTOPOD_URL`
`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`.
`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`.
### `OCTO_AUTHORIZATION_HEADER`
`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:
```bash
kubectl -n octopod get secret octopod-cli-auth-secret -o jsonpath='{.data.cli-secret}' | base64 -d
kubectl -n octopod get secret <HELM_RELEASE_NAME>-cli-auth-secret -o jsonpath='{.data.cli-secret}' | base64 -d
```
## Commands

2
helm-control-scripts/README.md
View File

@ -1,7 +1,7 @@
# Generic scripts
This is a complete suite of Octopod control scripts to deploy helm charts.
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).
You can get pre-built docker images from [typeable/octopod-helm-control-scripts](https://hub.docker.com/repository/docker/typeable/octopod-helm-control-scripts).
### Contents