diff --git a/docs/images/git.png b/docs/images/git.png new file mode 100644 index 00000000..63b81a05 Binary files /dev/null and b/docs/images/git.png differ diff --git a/docs/pluggable-packages.md b/docs/pluggable-packages.md index 51db3e3c..568e6730 100644 --- a/docs/pluggable-packages.md +++ b/docs/pluggable-packages.md @@ -35,6 +35,7 @@ This document proposes the following: - Use a more configurable Git server, Gitea. - Imperative pipelines for configuring packages are handled with ArgoCD resource hooks. +![git](images/git.png) ### ArgoCD @@ -48,7 +49,6 @@ We could define a spec to support such cases, but considering the main use cases ArgoCD supports resource hooks which allow users to define tasks to be run during application syncing. While there are some limitations to what it can do, for the majority of simple tasks resource hooks should suffice. - ### The in-cluster git server As documented in [this issue](https://github.com/cnoe-io/idpbuilder/issues/32), using `gitea` offers more configurable and user friendly experience. In short, using it enables: @@ -71,7 +71,8 @@ Users are expected to run the `helm template` command to generate manifests. ### Runtime Git server content generation As mentioned earlier, Git server contents are generated at compile time and cannot be changed at run time. -To solve this, Git content should be created at run time by introducing a new flag, `--package-dir`, to idpbuilder. This flag takes a directory and builds an image with the content from the directory. If this flag is not specified, use the embedded FS to provide the "default experience" where it uses the manifests provided at compile time to bootstrap and add predetermined packages to the cluster. +To solve this, Git content should be created at run time by introducing a new flag, `--package-dir`, to idpbuilder. This flag takes a directory that contains ArgoCD Applications. +If this flag is not specified, use the embedded FS to provide the "default experience" where it uses the manifests provided at compile time to bootstrap and add predetermined packages to the cluster. #### Repositories