From c76a973efd9503eca52a590214d8d89d3d5fe92f Mon Sep 17 00:00:00 2001 From: rocky Date: Tue, 20 Feb 2024 16:47:05 -0500 Subject: [PATCH 1/5] Add info about server var modes --- .../sre-playbook/server-environment-variables/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/it-manual/sre-playbook/server-environment-variables/README.md b/docs/it-manual/sre-playbook/server-environment-variables/README.md index 9a2e124b..e8648639 100644 --- a/docs/it-manual/sre-playbook/server-environment-variables/README.md +++ b/docs/it-manual/sre-playbook/server-environment-variables/README.md @@ -10,3 +10,9 @@ corresponding to the release is used to generate markdown documentation of the variables. The generated markdown files are added to this directoy. Use the left sidebar to see the available configuration variables for the CiviForm version you are deploying. + +Variables can have four different modes which determine where they are set and displayed: +1. Admin writeable variables should be set in the admin settings panel which is accessible in CiviForm when logged in as an admin. These variables should NOT be set in your deployment config and setting them there will have no affect on the app. +2. Admin readable variables should be set in your deployment config file. The values for these variables can be seen in the admin settings panel, but not changed there. +3. Server setting variables should be set in your deployment config file and are not visible in the admin settings panel. +4. Managed secret variables should be set in your cloud provider's secrets manager. These are not visible in the admin settings panel. From 711d7819301e1fb6a729356e11ac408711b3b5b1 Mon Sep 17 00:00:00 2001 From: rocky Date: Tue, 20 Feb 2024 16:51:12 -0500 Subject: [PATCH 2/5] where to find mode --- .../sre-playbook/server-environment-variables/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/it-manual/sre-playbook/server-environment-variables/README.md b/docs/it-manual/sre-playbook/server-environment-variables/README.md index e8648639..a720fdc5 100644 --- a/docs/it-manual/sre-playbook/server-environment-variables/README.md +++ b/docs/it-manual/sre-playbook/server-environment-variables/README.md @@ -16,3 +16,5 @@ Variables can have four different modes which determine where they are set and d 2. Admin readable variables should be set in your deployment config file. The values for these variables can be seen in the admin settings panel, but not changed there. 3. Server setting variables should be set in your deployment config file and are not visible in the admin settings panel. 4. Managed secret variables should be set in your cloud provider's secrets manager. These are not visible in the admin settings panel. + +A variable's mode is listed in between the variable name and its description in the generated documentation in this directory. From 98c9a21c972da35d4671d3049e664363854763a8 Mon Sep 17 00:00:00 2001 From: rocky Date: Wed, 21 Feb 2024 10:56:58 -0500 Subject: [PATCH 3/5] add quotes --- .../sre-playbook/server-environment-variables/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/it-manual/sre-playbook/server-environment-variables/README.md b/docs/it-manual/sre-playbook/server-environment-variables/README.md index a720fdc5..acbbb70c 100644 --- a/docs/it-manual/sre-playbook/server-environment-variables/README.md +++ b/docs/it-manual/sre-playbook/server-environment-variables/README.md @@ -12,9 +12,9 @@ left sidebar to see the available configuration variables for the CiviForm version you are deploying. Variables can have four different modes which determine where they are set and displayed: -1. Admin writeable variables should be set in the admin settings panel which is accessible in CiviForm when logged in as an admin. These variables should NOT be set in your deployment config and setting them there will have no affect on the app. -2. Admin readable variables should be set in your deployment config file. The values for these variables can be seen in the admin settings panel, but not changed there. -3. Server setting variables should be set in your deployment config file and are not visible in the admin settings panel. -4. Managed secret variables should be set in your cloud provider's secrets manager. These are not visible in the admin settings panel. +1. "Admin writeable" variables should be set in the admin settings panel which is accessible in CiviForm when logged in as an admin. These variables should NOT be set in your deployment config and setting them there will have no affect on the app. +2. "Admin readable" variables should be set in your deployment config file. The values for these variables can be seen in the admin settings panel, but not changed there. +3. "Server setting" variables should be set in your deployment config file and are not visible in the admin settings panel. +4. "Managed secret" variables should be set in your cloud provider's secrets manager. These are not visible in the admin settings panel. A variable's mode is listed in between the variable name and its description in the generated documentation in this directory. From 595a2a88eafe208ccfb1077524e46a660f2df6b8 Mon Sep 17 00:00:00 2001 From: rocky Date: Wed, 21 Feb 2024 11:04:57 -0500 Subject: [PATCH 4/5] add more details about where to find var mode --- .../sre-playbook/server-environment-variables/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/it-manual/sre-playbook/server-environment-variables/README.md b/docs/it-manual/sre-playbook/server-environment-variables/README.md index acbbb70c..2acb1e46 100644 --- a/docs/it-manual/sre-playbook/server-environment-variables/README.md +++ b/docs/it-manual/sre-playbook/server-environment-variables/README.md @@ -17,4 +17,4 @@ Variables can have four different modes which determine where they are set and d 3. "Server setting" variables should be set in your deployment config file and are not visible in the admin settings panel. 4. "Managed secret" variables should be set in your cloud provider's secrets manager. These are not visible in the admin settings panel. -A variable's mode is listed in between the variable name and its description in the generated documentation in this directory. +A variable's mode is listed in between the variable name and its description in the server environment documentation that is generated on each release and saved in this directory (for example [v1.51.0](https://docs.civiform.us/it-manual/sre-playbook/upgrading-to-a-new-release/server-environment-variables/v1.51.0)). From f92eb98a28c557b3041df34efd05732a7a8b45c0 Mon Sep 17 00:00:00 2001 From: rocky Date: Wed, 21 Feb 2024 11:06:06 -0500 Subject: [PATCH 5/5] Update docs/it-manual/sre-playbook/server-environment-variables/README.md --- .../sre-playbook/server-environment-variables/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/it-manual/sre-playbook/server-environment-variables/README.md b/docs/it-manual/sre-playbook/server-environment-variables/README.md index 2acb1e46..29034318 100644 --- a/docs/it-manual/sre-playbook/server-environment-variables/README.md +++ b/docs/it-manual/sre-playbook/server-environment-variables/README.md @@ -17,4 +17,4 @@ Variables can have four different modes which determine where they are set and d 3. "Server setting" variables should be set in your deployment config file and are not visible in the admin settings panel. 4. "Managed secret" variables should be set in your cloud provider's secrets manager. These are not visible in the admin settings panel. -A variable's mode is listed in between the variable name and its description in the server environment documentation that is generated on each release and saved in this directory (for example [v1.51.0](https://docs.civiform.us/it-manual/sre-playbook/upgrading-to-a-new-release/server-environment-variables/v1.51.0)). +A variable's mode is listed in between the variable name and its description in the server environment variable documentation that is generated on each release and saved in this directory (for example [v1.51.0](https://docs.civiform.us/it-manual/sre-playbook/upgrading-to-a-new-release/server-environment-variables/v1.51.0)).