Skip to content

Commit ccb712c

Browse files
maltesanderadwk67
andauthored
Apply suggestions from code review
Co-authored-by: Andrew Kenworthy <1712947+adwk67@users.noreply.github.com>
1 parent 91ff3dd commit ccb712c

2 files changed

Lines changed: 14 additions & 9 deletions

File tree

demos/argo-cd-git-ops/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This demo uses [Sealed Secrets](https://github.com/bitnami-labs/sealed-secrets)
66

77
The CLI tool `kubeseal` must be installed as described in the [Sealed Secrets readme](https://github.com/bitnami-labs/sealed-secrets?tab=readme-ov-file#kubeseal).
88

9-
The easiest way to seal secrets via `kubeseal` is to have the `argo-cd-git-ops` Stack installed. It provides the Sealed Secrets controller and
10-
a generated certificate that is automatically used for signing via `kubeseal`.
9+
The easiest way to seal secrets via `kubeseal` is to have the `argo-cd-git-ops` Stack installed.
10+
It provides the Sealed Secrets controller and a generated certificate that is automatically used for signing via `kubeseal`.
1111

1212
```sh
1313
kubeseal -n stackable-airflow --format=yaml < airflow-credentials.yaml > sealed-airflow-credentials.yaml

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ $ stackablectl demo install argo-cd-git-ops --namespace argo-cd
3333

3434
WARNING: This demo should not be run alongside other demos.
3535

36-
NOTE: ArgoCD will be deployed in the `argo-cd` namespace by `stackablectl`. ArgoCD itself will create other namespaces for the deployed products.
36+
NOTE: ArgoCD will be deployed in the `argo-cd` namespace by `stackablectl`.
37+
ArgoCD itself will create other namespaces for the deployed products.
3738

3839
[#system-requirements]
3940
== System requirements
@@ -65,7 +66,7 @@ This demo consists of multiple parts:
6566

6667
When managing all resources and configs via Git, deploying sensitive properties like certificates or credentials via Git becomes a problem.
6768

68-
There are multiple solutions like Hashicorp or Bitwarden, which heavily depend on the infrastructure already available.
69+
There are multiple solutions to this such as Hashicorp or Bitwarden, which depend heavily on the infrastructure already available.
6970

7071
For the sake of this demo, {sealed-secrets}[Bitnami's Sealed Secrets] are utilized.
7172
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`.
@@ -74,7 +75,8 @@ This way, everything will be stored and managed in Git.
7475

7576
== ArgoCD UI
7677

77-
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.
78+
ArgoCD will be the first product that is deployed in this Demo.
79+
Once the pods are ready, you can port-forward the argocd-server in order to access the web UI.
7880

7981
[source,console]
8082
----
@@ -83,7 +85,8 @@ kubectl --namespace argo-cd port-forward service/argocd-server 8443:https
8385

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

86-
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.
88+
NOTE: There will be an initial warning from the browser, stating that the site is insecure due to self-signed certificates.
89+
This can be ignored in this case.
8790

8891
The ArgoCD Web UI entry page shows an overview of deployed applications and their status and other metadata as the repository or the date of the last synchronization run.
8992

@@ -94,7 +97,7 @@ Single applications can be inspected closer after clicking on e.g. the `airflow`
9497
TODO: Screenshot - Argo UI - Airflow
9598

9699
Detailed information about the cluster, the cluster status and deployed components can be accessed in the application details.
97-
Additionally, if the Git repository and the cluster state itself differ, possible applied changes can be previewed in a code diff similar to Git pull requests.
100+
Additionally, if the Git repository and the cluster state itself differ, these differences can be previewed in a code diff similar to Git pull requests.
98101

99102
TODO: Screenshot - Argo UI - application details Network / List tab -> mark network tabs etc.
100103

@@ -275,9 +278,11 @@ the logs are fetched from S3 instead of the (already deleted) executor pods. The
275278
kubectl --namespace minio port-forward service/minio-console 9001:9001
276279
----
277280

278-
Minio then is reachable via `https://localhost:9001` with username `admin` and password `adminadmin`. After the successful Airflow DAG run, logs should be stored in `demo/airflow-task-logs`.
281+
Minio then is reachable via `https://localhost:9001` with username `admin` and password `adminadmin`.
282+
After the successful Airflow DAG run, logs should be stored in `demo/airflow-task-logs`.
279283

280-
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.
284+
NOTE: There will be an initial warning from the browser, stating that the site is insecure due to self-signed certificates.
285+
This can be ignored in this case.
281286

282287
TODO: Screenshot - minio UI with log data
283288

0 commit comments

Comments
 (0)