Skip to content

Commit 71ac5c7

Browse files
committed
improve intro message, point to git interaction section
1 parent 5d82cba commit 71ac5c7

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

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

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,36 @@
55
:argo-cd: https://argoproj.github.io/cd/
66
:argo-cd-application: https://argo-cd.readthedocs.io/en/stable/operator-manual/declarative-setup/#applications
77
:argo-cd-applicationset: https://argo-cd.readthedocs.io/en/stable/user-guide/application-set/
8+
:argo-cd-core-concepts: https://argo-cd.readthedocs.io/en/stable/core_concepts/
89
:sealed-secrets: https://github.com/bitnami-labs/sealed-secrets
910
:stackable-demo-repository: https://github.com/stackabletech/demos/
1011
:airflow: https://airflow.apache.org/
12+
:airflow-git-sync: https://docs.stackable.tech/home/stable/airflow/usage-guide/mounting-dags/#_via_git_sync
1113
:github-fork: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
1214

13-
This demo shows how to utilize GitOps and Infrastructure as Code (IaC) with Stackable and {argo-cd}[ArgoCD].
15+
This demo shows how to utilize GitOps and Infrastructure as Code (IaC) with Stackable and {argo-cd}[ArgoCD].
16+
Basic knowledge about ArgoCD and its {argo-cd-core-concepts}[core concepts] are assumed and not explained further.
17+
1418
All products and manifests are synced and deployed via ArgoCD (except ArgoCD itself, which is bootstrapped via `stackablectl`).
1519

1620
The key points to show are:
1721

18-
* GitOps: How to deploy changes from a Git repository to a cluster?
19-
* Secrets: How to safely store and deploy credentials or access keys from a Git repository?
20-
* Interaction with Stackable products (e.g. Airflow and DAGs via gitsync)
22+
* Infrastructure - GitOps
23+
** How to synchronize changes from a Git repository?
24+
** How to apply the Git version and branch control to different Kubernetes clusters (development, staging, production)?
25+
** How to safely store and deploy sensitive data from a Git repository?
26+
* Interaction with Stackable products and Git
27+
** Use Airflow and {airflow-git-sync}[git-sync] to fetch DAGs from a Git repository
28+
** Add or update existing DAGs by commiting to the Git repository
2129
2230
ArgoCD and other deployed products and dependencies are illustrated in the following diagram:
2331

2432
image::argo-cd-git-ops/architecture-overview.drawio.svg[]
2533

2634
Install this demo on an existing Kubernetes cluster:
2735

28-
// TODO: We need a pointer here to the last paragraph (forking repo) if people want to "interact" and not just install the demo (install command requires extra parameters)
36+
NOTE: In order to interact with the Git repository, this repository must be forked and additional parameters must be provided to `stackablectl`.
37+
This is explained in more detail in the section <<interact-with-git-repository,How to interact with the Git repository>>.
2938

3039
[source,console]
3140
----
@@ -288,7 +297,8 @@ This demo illustrates the combination of ArgoCD and Stackable, using the full po
288297

289298
As a last step, in order to synchronize changes made to manifests or secrets from the Git repository, the following paragraph demonstrates on how to run this demo on a forked GitHub repository.
290299

291-
== How to interact with ArgoCD and the Git repository
300+
[#interact-with-git-repository]
301+
== How to interact with ArgoCD, Airflow and the Git repository
292302

293303
Since this Demo is hosted in the {stackable-demo-repository}[Stackable Demo repository], where merging etc. requires approval, the recommendation is to fork the {stackable-demo-repository}[Stackable Demo repository].
294304
This {github-fork}[GitHub tutorial] shows how to fork a repository.
@@ -311,7 +321,7 @@ Once this is pushed / merged, ArgoCD should sync the changes and you should see
311321

312322
=== Add new Airflow DAGs
313323

314-
In the `demos/argo-cd-git-ops/manifests/airflow/airflow.yaml` manifest you have to adapt the gitsync configuration for DAGs to the forked repository:
324+
In the `demos/argo-cd-git-ops/manifests/airflow/airflow.yaml` manifest you have to adapt the git-sync configuration for DAGs to the forked repository:
315325

316326
[source,yaml]
317327
----
@@ -321,4 +331,4 @@ In the `demos/argo-cd-git-ops/manifests/airflow/airflow.yaml` manifest you have
321331
[...]
322332
----
323333

324-
Similar to ArgoCD, after adding a new DAG to the folder `demos/argo-cd-git-ops/dags`, Airflow should pick up the new DAG via gitsync and display it in the UI.
334+
Similar to ArgoCD, 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.

0 commit comments

Comments
 (0)