-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Idpbuilder workflow Diagram #347
Open
Bnjoroge1
wants to merge
6
commits into
cnoe-io:main
Choose a base branch
from
Bnjoroge1:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+36
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
96b27df
Update CONTRIBUTING.md with installation workflow diagram
Bnjoroge1 19b1399
Update CONTRIBUTING.md
Bnjoroge1 f1d3dcc
Update CONTRIBUTING.md to include installation workflow
Bnjoroge1 3d50bf8
Update CONTRIBUTING.md to fix typo
Bnjoroge1 4927877
Merge branch 'cnoe-io:main' into main
Bnjoroge1 18c57fe
Signed-off-by: Bill Njoroge [email protected]. Update CONTRIBU…
Bnjoroge1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -105,12 +105,48 @@ This script runs helm template to generate most files. See the values file for m | |
ingress-nginx manifests are generated using a bash script available [here](./hack/ingress-nginx/generate-manifests.sh). | ||
This script runs kustomize to modify the basic installation manifests provided by ingress-nginx. | ||
|
||
## Installation Flow | ||
This diagram highlights the installation flow of idpbuilder and the various core packages. | ||
|
||
```mermaid | ||
flowchart TD | ||
subgraph MainCluster | ||
direction TB | ||
subgraph ArgoCD[ArgoCD Apps] | ||
ArgoCD_App[ArgoCD] | ||
Ingress[Ingress-nginx] | ||
Gitea_App[Gitea] | ||
end | ||
|
||
subgraph Gitea[Git Repositories] | ||
Gitea_ArgoCD[ArgoCD] | ||
Gitea_Ingress[Ingress-nginx] | ||
Gitea_Gitea[Gitea] | ||
end | ||
|
||
ArgoCD -->|GitOps| Gitea | ||
end | ||
|
||
CorePackages[Core Packages: \nArgoCD, \nGitea, \nIngress-nginx] | ||
LocalDir[Local Directory: \n- argocd-app.yaml \n- manifest files] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can specify remote repository as well in the -p flag. |
||
|
||
subgraph Process | ||
CLI[IDPBUILDER CLI] | ||
CLI -->|1. Create \nKind Cluster| CorePackages | ||
CorePackages -->|2. Install| MainCluster | ||
CorePackages -->|3. Create \nRepositories and hand over \ncontrol to ArgoCD| Gitea | ||
Gitea -->|4. Read| CLI | ||
Gitea -->|5. Sync Custom Packages| LocalDir | ||
end | ||
|
||
``` | ||
## Architecture | ||
|
||
idpbuilder is made of two phases: CLI and Kubernetes controllers. | ||
|
||
![idpbuilder.png](docs/images/idpbuilder.png) | ||
|
||
|
||
### CLI | ||
|
||
When the idpbuilder binary is executed, it starts with the CLI phase. | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be "Target Cluster".