Add GitOps operational documentation #170
Conversation
VajiraPrabuddhaka
force-pushed
the
gitops-op-docs
branch
from
cea60ac to
aa7bddc
Compare
sidebars.ts
Outdated
| { | ||
| type: 'category', | ||
| label: 'Operations Guide', | ||
| label: 'Operational Guides', |
There was a problem hiding this comment.
How about Operator Manual, as this is an in-depth technical documentation?
There was a problem hiding this comment.
+1 for Operator Manual
There was a problem hiding this comment.
Updated as Operator Manual
VajiraPrabuddhaka
force-pushed
the
gitops-op-docs
branch
from
aa7bddc to
76ca403
Compare
|
|
||
| Before you begin, ensure you have: | ||
|
|
||
| - An OpenChoreo installation (see "Get Started" section for installation options) |
There was a problem hiding this comment.
Can we add the link to the installation page?
There was a problem hiding this comment.
I tried, but we can't add link because, here we can't specifically say which type of installation we follow. Also can't link to the top level "Get Started" section.
|
|
||
| ```text | ||
| . | ||
| ├── organization/ # organization and namespace |
There was a problem hiding this comment.
Is this the same when organization units are introduced?
There was a problem hiding this comment.
No, I think we have to change this when org units are introduced.
docs/operations/gitops/overview.md
Outdated
| │ SecretReference │ | ||
| │ (OpenChoreo abstraction) │ | ||
| └──────────────────┬──────────────────┘ | ||
| │ Controller converts to |
There was a problem hiding this comment.
Not all secret references are converted to. Therefore, we need to modify this slightly.
There was a problem hiding this comment.
Updated this as just Coverts to (removed Controller part). Any way we have to somehow conver that to ExternalSecret right? I think we should have a proper documentation for Secret management and point from here to there. Until that shall we keep this?
There was a problem hiding this comment.
Yeah, but we need to mention that not all secret references are converted to external secrets when the secret reference is created. It might be created by different controllers when needed/referenced in other CRs.
|
If we have a sample repository in OpenChoreo Org, it would be easy for users to get an idea. wdyt? @VajiraPrabuddhaka |
VajiraPrabuddhaka
force-pushed
the
gitops-op-docs
branch
from
76ca403 to
9866222
Compare
Yes we can provide a sample repository. Will do it. |
3 participants
Purpose
$subject
Related Issues
openchoreo/openchoreo#698
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors