readme: add diagram
This commit is contained in:
parent
ebc3ca0098
commit
53714884c3
28
README.md
28
README.md
|
@ -18,11 +18,32 @@ Useful tools for administration:
|
||||||
- stackspin docs:
|
- stackspin docs:
|
||||||
https://docs.stackspin.net/en/v2/system_administration/customizing.html
|
https://docs.stackspin.net/en/v2/system_administration/customizing.html
|
||||||
|
|
||||||
|
## Explanation - Typical App Deployment in Stackspout with Flux on Kubernetes
|
||||||
|
|
||||||
|
The diagram illustrates generically how continuous app deployment works in our Kubernetes cluster
|
||||||
|
from Infrastructure-as-Code using flux.
|
||||||
|
Not every app has database, backend and frontend,
|
||||||
|
but in the end the deployments all work very similarly
|
||||||
|
so there is no point showing it for each individual app.
|
||||||
|
Except for the Single-Sign On,
|
||||||
|
apps also do not really depend on each other.
|
||||||
|
|
||||||
|
Explanations:
|
||||||
|
- deploy :: creates a resource on the cluster from a file in the GitRepository
|
||||||
|
- create :: creates a resource on the cluster using Kubernetes logic
|
||||||
|
- ... all :: creates multiple independent resources
|
||||||
|
|
||||||
|
All Flux Kustomizations refer to a directory in the GitRepository,
|
||||||
|
but for clarity I omitted it beyond the initial one.
|
||||||
|
|
||||||
|
Clouds are created not via Flux GitOps,
|
||||||
|
but through one-time scripts.
|
||||||
|
|
||||||
|
![Flux Diagram](./stackspout.png)
|
||||||
|
|
||||||
### Guide: Creating OAuth Credentials for an external service
|
### Guide: Creating OAuth Credentials for an external service
|
||||||
- add a line in `install.sh` and run it to generate the secret (TODO: Update to new stackspin mechanism)
|
- push an OAuth2Client definition like for the apps,
|
||||||
- append another OAuth2Client definition to `overrides/oauth-clients.yaml`,
|
|
||||||
adjusting `metadata.name` and `spec.secretName` as well as `spec.redirectUris`
|
adjusting `metadata.name` and `spec.secretName` as well as `spec.redirectUris`
|
||||||
- apply changes to the cluster
|
|
||||||
- obtain the generated `client_secret` for your application from kubernetes:
|
- obtain the generated `client_secret` for your application from kubernetes:
|
||||||
|
|
||||||
kubectl get secret -n flux-system stackspin-APP-oauth-variables --template '{{.data.client_secret}}' | base64 -d
|
kubectl get secret -n flux-system stackspin-APP-oauth-variables --template '{{.data.client_secret}}' | base64 -d
|
||||||
|
@ -31,6 +52,7 @@ Useful tools for administration:
|
||||||
|
|
||||||
kubectl get secret -n flux-system stackspin-APP-oauth-variables --template '{{.data.client_id}}{{"\n"}}{{.data.client_secret}}{{"\n"}}' | while read in; do echo $in | base64 -d; echo; done
|
kubectl get secret -n flux-system stackspin-APP-oauth-variables --template '{{.data.client_id}}{{"\n"}}{{.data.client_secret}}{{"\n"}}' | while read in; do echo $in | base64 -d; echo; done
|
||||||
|
|
||||||
|
|
||||||
## Customizations
|
## Customizations
|
||||||
|
|
||||||
### Overrides
|
### Overrides
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 134 KiB |
Loading…
Reference in New Issue