Skip to content

Commit c4ae615

Browse files
committed
docs fixes
1 parent 957d7e4 commit c4ae615

2 files changed

Lines changed: 19 additions & 43 deletions

File tree

docs/modules/demos/pages/argo-cd-git-ops.adoc

Lines changed: 17 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,17 @@ This demo consists of multiple parts:
5656

5757
TODO: arch overview image
5858

59+
== Sealed Secrets
60+
61+
When managing all resources and configs via Git, deploying sensitive properties like certificates or credentials via Git becomes a problem.
62+
63+
There are multiple solutions like Hashicorp or Bitwarden, which heavily depend on the infrastructure already available.
64+
65+
For the sake of this demo, {sealed-secrets}[Bitnami's Sealed Secrets] are utilized.
66+
Sensitive data is encrypted as a `SealedSecret` before commiting to the Git repository, synced via ArgoCD and decrypted by the Sealed Secrets controller into a standard Kubernetes `Secret`.
67+
68+
This way, everything will be stored and managed in Git.
69+
5970
== ArgoCD UI
6071

6172
ArgoCD will be the first product that is deployed in this Demo. Once the pods are ready, you can port-forward the argocd-server in order to access the Web UI.
@@ -67,21 +78,10 @@ kubectl --namespace argo-cd port-forward service/argocd-server 8443:https
6778

6879
In your browser, go to `https://localhost:8443` and login with username `admin` and password `adminadmin`.
6980

70-
NOTE: There will be an initial warning from the Browser that this site is insecure due to self-signed certificates. This can be ignored in this case.
81+
NOTE: There will be an initial warning from the Browser, that this site is insecure due to self-signed certificates. This can be ignored in this case.
7182

7283
TODO: screenshots
7384

74-
== Sealed Secrets
75-
76-
When managing all resources and configs via Git, deploying sensitive properties like certificates or credentials via Git becomes a problem.
77-
78-
There are multiple solutions like Hashicorp or Bitwarden, which heavily depend on the infrastructure already available.
79-
80-
For the sake of this demo, {sealed-secrets}[Bitnami's Sealed Secrets] are utilized.
81-
Sensitive data is encrypted as a `SealedSecret` before commiting to the Git repository, synced via ArgoCD and decrypted by the Sealed Secrets controller into a standard Kubernetes `Secret`.
82-
83-
This way, everything will be stored and managed in Git.
84-
8585
== Stackable operators
8686

8787
The Stackable operators are deployed via ArgoCD using the Stackable Helm charts and an ArgoCD {argo-cd-applicationset}[`ApplicationSet`].
@@ -90,8 +90,7 @@ using different versions and Git sources (repository & branch) as well as the po
9090

9191
NOTE: This demo does not use a multi cluster environment for the sake of simplicity.
9292

93-
[source,console]
94-
----
93+
[source,yaml]
9594
---
9695
apiVersion: argoproj.io/v1alpha1
9796
kind: ApplicationSet
@@ -100,39 +99,15 @@ metadata:
10099
spec:
101100
generators:
102101
- matrix:
103-
generators:licationSet`.
104-
** Spin up requirements like Minio and Postgres as `Application`.
105-
** Deploy Stackable Airflow manifests in their respective `Projects`.
106-
** DAGs are synced via Airflow gitsync, not ArgoCD.
107-
** Airflow uses the Kubernetes executor and write its logs to S3 / Minio.
108-
** DAGs can be started manually in the Airflow webserver UI
109-
110-
TODO: arch overview image
111-
112-
== ArgoCD UI
113-
114-
ArgoCD will be the first product that is deployed in this Demo. Once the pods are ready, you can port-forward the argocd-server in order to access the Web UI.
115-
102+
generators:
116103
- list:
117104
elements:
118105
- operator: commons
119106
- operator: listener
120107
- operator: secret
121108
- operator: airflow
122109
- operator: druid
123-
- operator: hbaselicationSet`.
124-
** Spin up requirements like Minio and Postgres as `Application`.
125-
** Deploy Stackable Airflow manifests in their respective `Projects`.
126-
** DAGs are synced via Airflow gitsync, not ArgoCD.
127-
** Airflow uses the Kubernetes executor and write its logs to S3 / Minio.
128-
** DAGs can be started manually in the Airflow webserver UI
129-
130-
TODO: arch overview image
131-
132-
== ArgoCD UI
133-
134-
ArgoCD will be the first product that is deployed in this Demo. Once the pods are ready, you can port-forward the argocd-server in order to access the Web UI.
135-
110+
- operator: hbase
136111
- operator: hdfs
137112
- operator: hive
138113
- operator: kafka
@@ -175,7 +150,7 @@ ArgoCD will be the first product that is deployed in this Demo. Once the pods ar
175150
176151
The `matrix.generators.list[].elements[]` will create a union of parameters that may be used in the `ApplicationSet` template as follows:
177152
178-
[source,console]
153+
[source,yaml]
179154
----
180155
# [...]
181156
template:
@@ -212,7 +187,7 @@ template:
212187
213188
The templated version for e.g. the parameters `operator=zookeeper`, `server=https://kubernetes.default.svc` and `targetRevision=25.7.0` will result in the following template:
214189
215-
[source,console]
190+
[source,yaml]
216191
----
217192
# [...]
218193
template:

stacks/argo-cd-git-ops/applications/sealed-secrets.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ spec:
1414
releaseName: sealed-secrets-controller
1515
valuesObject:
1616
secretName: sealed-secrets-key
17-
# TODO: This should be parameterized with customGitUrl and customGitBranch
17+
# TODO: This should be parameterized with customGitUrl and customGitBranch parameters.
1818
# Currently these parameters are defined in the demo-v2.yaml and are
1919
# not picked up in the stack - What to do?
20+
# TODO: adapt to main / 25.7
2021
- repoURL: https://github.com/stackabletech/demos/
2122
targetRevision: spike/argocd-demo
2223
path: stacks/argo-cd-git-ops/secrets/

0 commit comments

Comments
 (0)