From e830c63ad2581be9ddae8486e14193cb346fe28a Mon Sep 17 00:00:00 2001 From: Sylvie Date: Fri, 20 Dec 2024 10:06:22 -0600 Subject: [PATCH] lil bit of shuffling Co-Authored-By: jcrichlake <145698165+jcrichlake@users.noreply.github.com> --- adr/012-configs.md | 8 +------- docs/configs.md | 10 +++++++--- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/adr/012-configs.md b/adr/012-configs.md index f854a01..08f04cb 100644 --- a/adr/012-configs.md +++ b/adr/012-configs.md @@ -16,12 +16,6 @@ In order to enable the usage of partner-specific settings in the different parts in a config container in our Azure storage account. Each partner will have its own separate file within the container to minimize potential blast radius when changing settings. - -## Notes -- config files should only contain non-secret values -- secrets will use a consistent naming pattern based on the partner ID used in config (so we can dynamically assemble the key names in code) -- config keys are their file names (minus .json) and match org names in ReportStream - ## Impact ### Positive @@ -40,4 +34,4 @@ blast radius when changing settings. ## Related Issues -- #1082 +- #[1082](https://github.com/CDCgov/trusted-intermediary/issues/1082) diff --git a/docs/configs.md b/docs/configs.md index 986b4b0..d5d7dff 100644 --- a/docs/configs.md +++ b/docs/configs.md @@ -1,7 +1,11 @@ # FAQ - -- We don't load configs in the PR environment. +- We use the partner's organization name in ReportStream as the partner ID +- Config files are the partner ID plus `.json` +- Config keys in code are the partner ID +- We don't load configs in the PR environment - See [The partner settings struct](/src/config/config.go) for the config structure - Configs load prior to the application running. Any changes to the config will require a restart of the Azure container to load those changes - For local non-partner specific testing, we have a Flexion based config that can be used in non-prod environments - +- Config files should only contain non-secret values. Secrets will remain in Azure Key Vault + - secrets will use a consistent naming pattern based on the same partner ID used in config + (so we can dynamically assemble the key names in code)