Skip to content

ADR: Split platform configuration into public and private repositories - #49

Open
knikolla wants to merge 1 commit into
CCI-MOC:mainfrom
knikolla:adr_public_private
Open

knikolla wants to merge 1 commit into
CCI-MOC:mainfrom
knikolla:adr_public_private

Conversation

@knikolla

Copy link
Copy Markdown

We discussed this during the touch base with the information security team and decided to propose an ADR.

NIST 800-171 requires us to keep some information private, and to salvage from having to make every IaC repo private we can split it out into two in a templated fashion.

We discussed this during the touch base with the information
security team and decided to propose an ADR.

NIST 800-171 requires us to keep some information private, and to
salvage from having to make every IaC repo private we can split it
out into two in a templated fashion.
@github-actions github-actions Bot added the ops-adr This is an arthiectural decision record label Oct 28, 2026
@bu-renm

bu-renm commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

LGTM. Whichever repo we choose, we should put the information in the private moc-compliance repo there.

@larsks larsks left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a policy, not an ADR. The ADR would be a description of exactly how we have managed the split between public/private repositories, how we are handling things like permissions in CI jobs, how we are handling templating values, etc.

Or if this is an ADR, it should describe a more concrete implementation.

- A change that touches a placeholder and its value needs coordinated pull requests in two repositories, and the two can drift apart.
- The EKS jobs need a read-only credential for the private repositories, which must be rotated at least every 90 days.
- The private repositories hold sensitive configuration, so access to them must be limited and reviewed.
- A real value committed to a public repository stays in its history. It must be treated as exposed and replaced.

@larsks larsks Oct 28, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I agree with this for the types of information we're talking about here. If we accidentally expose an ip address, we have to..."replace it"? These are not security credentials, and in our current environment addresses are almost exclusively assigned dynamically.

@bu-renm bu-renm Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can grandfather in the existing IPs that have been documented? Once the private repo is up, you'd have to go out of your way to expose IPs in the public repo.

For the sake of the compliant environment though, I think this rotation is necessary.

### Changes

- A change that touches a placeholder and its value needs coordinated pull requests in two repositories, and the two can drift apart.
- The EKS jobs need a read-only credential for the private repositories, which must be rotated at least every 90 days.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This, at least, I think is a solved problem: we use github apps to acquire repository credentials in CI workflows, and those credentials are ephemeral: they existing only for the duration of the workflow.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case we'd need a private key to sign the JWT that we're sending to GitHub, so we'd still need a credential that we rotate every 90 days. https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps

@knikolla

Copy link
Copy Markdown
Author

I think this is a policy, not an ADR. The ADR would be a description of exactly how we have managed the split between public/private repositories, how we are handling things like permissions in CI jobs, how we are handling templating values, etc.

Or if this is an ADR, it should describe a more concrete implementation.

Most of this is also included in the SDLC policy that I just proposed. #50 so this may potentially be superseded by that.

@larsks

larsks commented Oct 30, 2026

Copy link
Copy Markdown
Member

Most of this is also included in the SDLC policy that I just proposed. #50 so this may potentially be superseded by that.

Do you want to close this one for now and resubmit later with more technical details?

@hpdempsey

Copy link
Copy Markdown

@knikolla please either close this as superceded or make requested changes/resolve them so we can proceed with either an ADR or Policy PR and approvals.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ops-adr This is an arthiectural decision record

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants