Open
Conversation
…ground into feature/update-docs
We now use k3d's registry functionallity to setup and bind an registry to an empty cluster, mirroring the necessary images and finally creating a gop config which can be used for testing
…base url and an optional argument "harbor". If you pass, beside the base url, also the "harbor", the script will perform various api calls, assuming the target registry is the product "harbor". if the second argument is omitted, it simply copies images used by gop into the target registry
nihussmann
reviewed
Mar 31, 2026
nihussmann
reviewed
Mar 31, 2026
nihussmann
reviewed
Mar 31, 2026
docs/Applications.md
Outdated
|
|
||
| ### Repositories and layout | ||
|
|
||
| When installing the GitOps playground, the following Git repositories are created and initialized: |
Contributor
There was a problem hiding this comment.
example apps is not installed by default
nihussmann
reviewed
Mar 31, 2026
docs/Applications.md
Outdated
|
|
||
| * Separation of app repo (e.g. `petclinic-plain`) and GitOps repo (e.g. `argocd/example-app`) | ||
| * Config is maintained in app repo, | ||
| * CI Server writes to GitOps repo and creates PullRequests. |
Contributor
There was a problem hiding this comment.
ref to gitops build lib?
nihussmann
reviewed
Mar 31, 2026
docs/Applications.md
Outdated
|
|
||
| The applications implement a simple staging mechanism: | ||
|
|
||
| * After a successful Jenkins build, the staging application will be deployed into the cluster by the GitOps operator. |
nihussmann
reviewed
Mar 31, 2026
docs/Deploy-Ingress-Controller.md
Outdated
| It is possible to deploy `Ingress` objects for all components. You can either | ||
|
|
||
| * set a common base url (`--base-url=https://example.com`) or | ||
| * individual URLS: <- falsch! |
Contributor
There was a problem hiding this comment.
- individual URLS: <- falsch! ?
external config?
nihussmann
reviewed
Mar 31, 2026
| * on a local k3d cluster | ||
| Works best on Linux, but is possible on [Windows and Mac](./Running-on-Windows-Mac.md). | ||
| * on a remote k8s cluster | ||
| * each with the option |
Co-authored-by: Niklas Hußmann <niklas.hussmann-extern@cloudogu.com>
Co-authored-by: Niklas Hußmann <niklas.hussmann-extern@cloudogu.com>
…ground into feature/update-docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Right now we basically have all of our documentation inside the README.md. This PR will split and update the documentation, creating multiple markdown files in ./docs/ as well as introduce a new method to automatically create ./docs/Configuration.md