Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: make the install paths easier to use #303

Merged
merged 1 commit into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 6 additions & 13 deletions docs/deploy-guide/gitops-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,9 @@ has been chosen; other tools like Vault, SOPS, etc should be considered
for production deployments.

```bash
# from your understack checkout
./scripts/gitops-secrets-gen.sh ${UC_DEPLOY}/my-k3s.env
pushd "${UC_DEPLOY}"
git add my-k3s
git commit -m "my-k3s: secrets generation"
popd
./scripts/gitops-secrets-gen.sh ./my-k3s.env
git -C "${UC_DEPLOY}" add secrets/my-k3s
git -C "${UC_DEPLOY}" commit -m "my-k3s: secrets generation"
```

### Defining the app deployment
Expand All @@ -143,12 +140,9 @@ In this section we will use the [App of Apps][app-of-apps] pattern to define
the deployment of all the components of UnderStack.

```bash
# from your understack checkout
./scripts/gitops-deploy.sh ${UC_DEPLOY}/my-k3s.env
pushd "${UC_DEPLOY}"
git add my-k3s
git commit -m "my-k3s: initial cluster config"
popd
git -C "${UC_DEPLOY}" add helm-configs/my-k3s
git -C "${UC_DEPLOY}" commit -m "my-k3s: initial cluster config"
```

## Final modifications of your deployment
Expand Down Expand Up @@ -192,8 +186,7 @@ kubectl label node $(kubectl get nodes -o 'jsonpath={.items[*].metadata.name}')
Finally run the following to have ArgoCD deploy the system:

```bash
# from your understack checkout
kubectl apply -f apps/aio-app-of-apps.yaml
kubectl -n argocd apply -f apps/aio-app-of-apps.yaml
```

At this point ArgoCD will work to deploy Understack.
Expand Down
2 changes: 1 addition & 1 deletion scripts/gitops-secrets-gen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ export HORIZON_DB_PASSWORD
# this is a helm values.yaml but it contains secrets because of the lack
# of secrets references in OpenStack Helm
yq '(.. | select(tag == "!!str")) |= envsubst' \
"./components/openstack-secrets.tpl.yaml" \
"${SCRIPTS_DIR}/../components/openstack-secrets.tpl.yaml" \
> "${DEST_DIR}/secret-openstack.yaml"

echo "Checking undersync"
Expand Down