Skip to content

Commit e0289c2

Browse files
maltesanderadwk67
andauthored
Apply suggestions from code review
Co-authored-by: Andrew Kenworthy <[email protected]>
1 parent e001af8 commit e0289c2

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

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

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ GitOps provides a reliable way to manage infrastructure and applications declara
1919
and changes are automatically synchronized. This tutorial demonstrates how to deploy Stackable operators and products using {argo-cd}[ArgoCD],
2020
following Infrastructure-as-Code (IaC) and GitOps principles.
2121

22-
By the end, you will learn how to:
22+
You will learn how to:
2323
* Deploy Stackable operators and products via Git-managed manifests.
2424
* Use Sealed Secrets to securely manage sensitive credentials.
2525
* Update Airflow DAGs or modify deployments simply by committing to Git.
@@ -33,9 +33,9 @@ All products and manifests are synced and deployed via ArgoCD (except ArgoCD its
3333
== System requirements
3434

3535
To run this demo, ensure you have the following prerequisites:
36-
* Kubernetes Cluster (e.g., Kind, Minikube, or managed services like EKS, GKE, AKS)
36+
* a Kubernetes Cluster (e.g., Kind, Minikube, or managed services like EKS, GKE, AKS).
3737
* `kubectl`: Installed and configured to access your cluster.
38-
* Optional: GitHub Account - Required for forking and interacting with the demo repository.
38+
* Optional: a GitHub account - required for forking and interacting with the demo repository.
3939

4040
Resource requirements for this demo:
4141
* 15 {k8s-cpu}[cpu units] (core/hyperthread)
@@ -291,24 +291,26 @@ The log files contained in the single folders are the same as the logs shown abo
291291

292292
== Conclusion
293293

294-
This demo illustrates a repeatable blueprint for managing complex data platform components with ArgoCD and GitOps.
294+
This demo acts as a blueprint for showing how complex data platform components can be managed with ArgoCD and GitOps.
295295
Once familiar with this pattern, you can extend it to multi-cluster environments, add CI/CD pipelines for automated manifest testing,
296-
or integrate external secret stores like HashiCorp Vault for production use. This setup lays the foundation for a fully automated, scalable, and secure Kubernetes-based data platform.
296+
or integrate external secret stores like HashiCorp Vault for production use.
297+
This setup lays the foundation for a fully automated, scalable, and secure Kubernetes-based data platform.
297298

298-
This tutorial demonstrates how ArgoCD and Stackable integrate to deliver a streamlined GitOps experience:
299+
This tutorial demonstrates how ArgoCD and Stackable can be combined to deliver a streamlined GitOps experience:
299300
* All cluster resources and workloads are managed declaratively via Git.
300301
* ArgoCD continuously ensures the cluster state matches Git.
301302
* Sealed Secrets provide secure and auditable secret management.
302303
* Airflow DAG updates occur automatically by committing code to the repository.
303304

304-
This approach scales naturally across environments—development, staging, and production—while reducing manual operations, improving visibility,
305-
and enforcing consistency. By adopting GitOps with ArgoCD and Stackable, teams gain a clear, auditable, and automated path from code to production.
305+
This approach scales naturally across environments - development, staging, and production - while reducing manual operations, improving visibility,
306+
and enforcing consistency.
307+
By adopting GitOps with ArgoCD and Stackable, teams gain a clear, auditable, and automated path from code to production.
306308

307309
Next steps:
308310
* Explore multi-cluster ApplicationSet deployments to target multiple Kubernetes clusters.
309311
* Integrate CI workflows to automatically validate and merge manifest updates.
310312
* Expand beyond Airflow to manage additional Stackable components (e.g., Kafka, Trino, Superset).
311-
* Experiment with DataOps (e.g., Airflow and Trino)
313+
* Experiment with DataOps (e.g., Airflow and Trino).
312314

313315
[#interact-with-git-repository]
314316
== How to interact with ArgoCD, Airflow and the Git repository
@@ -361,7 +363,8 @@ In the `demos/argo-cd-git-ops/manifests/airflow/airflow.yaml` manifest you have
361363
----
362364

363365
After adding a new DAG to the folder `demos/argo-cd-git-ops/dags/`, Airflow should pick up the new DAG via git-sync and display it in the UI.
364-
This may take a while for the syncing process. Refreshing the Airflow UI might help if no DAGs show up.
366+
This may take a while for the syncing process.
367+
Refreshing the Airflow UI might help if no DAGs show up.
365368

366369
The synchronisation status of the DAGs can be monitored in via the Airflow scheduler:
367370

0 commit comments

Comments
 (0)