Repository navigation
adr: Separate hub configuration from oac-apps - #61
atyronesmith wants to merge 1 commit into
Conversation
Ooo, we should see about fixing that. |
|
Nitpick: Please keep commit descriptions meaningful; when viewing the changelog, |
|
#62 adds support for rendering mermaid diagrams on the published site. |
Draft ADR for the proposal in MOC-issues #802: oac-apps becomes the code repository with tagged releases, each hub gets its own configuration repository, and each hub repository names the release it runs. Opened for discussion. The structure follows tzumainn's proposal and the compliance layering described in MOC-issues #803. The default for the configuration repository URL and pinning applicationsets with the charts are additions that have not been agreed.
80fd70c to
f3a98a6
Compare
Not a nitpick... Fixed, thanks. That was the web editor's default; the commit now has a proper subject and description. |
There was a problem hiding this comment.
In general I like the structure of this proposal. It largely matches what I had envisioned in my head when talking about splitting the repository into a chart library/config repositories.
Responding to the questions posted in the ADR:
Is pinning applicationsets together with the charts worth the extra level, or is pinning only the charts enough to start with?
Can you expand on this a bit? Since we're pinning to a release of the repository, aren't we effectively always pinning charts and applicationsets together?
Likewise, is a default of oac-apps for the configuration repository URL acceptable, or should existing hubs get hub repositories too?
I am ambivalent about whether or not existing hubs get converted to the new structure, but I would love to start with a repository that does not contain pre-conversion cruft. I guess I have a slight preference for leaving oac-apps alone and creating a new repository going forward, since we're now managing non-OAC environments.
What is the naming convention for hub repositories?
How about hub-config-<name>?
Who promotes a release to a compliant hub, how often, and who is the compliance reviewer? The discussion in CCI-MOC/MOC-issues#803 suggests roughly monthly promotion and a reviewer from IS&T or InfoSec, possibly with an automated first pass. None of that is settled.
I don't have an answer here (this seems like a policy write-up all by itself), but we should commit to ensure that the answer to "who" is plural, so that we're not bottlenecking the work on one person.
Do all compliant hubs share one release tag to start with, or does each move on its own? The pin allows either.
I'm not entirely sure I understand this question -- is it, "Must all compliant hubs start from the same version (and then potentially drift)"? Or is it "Must all comliant hubs always be at the same version"? Or is it something else and I am not reading the question correctly.
My knee-jerk reaction to the question as phrased is that we don't particularly care what version a compliant hub starts with; it should start with "whatever is current when the cluster is created".
Should per-hub components be driven by markers, as compliance is now, or by a list in values, replacing the drop-ins?
I would love to make "I am a compliant cluster" the same sort of metadata as "I am a GPU cluster", so that we're not managing sets of cluster attributes through different mechanisms.
Do hubs that share an environment (for example development, staging and production for MOC 1.5) each get a repository, or share one with a directory per hub?
If they do share a repository (which probably makes sense), we will still need to figure out a branch workflow for how (or if?) things transition from dev to staging to production.
Are hub repositories private (#49), and which credential does Argo CD use to read them?
With respect to credentials, I think we would set up Github App with appropriate permissions and install it with access to the specific list of repositories that ArgoCD needs. This is supported by ArgoCD:
Draft, opened for discussion at tzumainn's suggestion. Not ready for approval.
This writes up the proposal in CCI-MOC/MOC-issues#802 (per-hub configuration repositories, tagged releases of
oac-apps) together with the compliance layering from CCI-MOC/MOC-issues#803. The structure is tzumainn's and EldritchJS's.Two parts are additions that have not been agreed, and are the main things to react to:
oac-apps, so existing hubs are unaffected.applicationsetsis pinned together with the charts, through an Application file in the hub repository.Seven open questions are listed at the end. Related: #49 (public and private config repositories) and #59 (GitOps reconciliation and change control).
Counts and the render table are from
oac-appsat d513176. Nothing here has been run under Argo CD; the "Not yet tested" section says what that leaves open.The diagrams are Mermaid. They render on GitHub but not on the published site.