From 9794f82f44e4e5091b82b96486565f02b2cf6820 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 24 Nov 2023 16:34:14 -0500 Subject: [PATCH 1/5] Add .profile file information to docs This changeset adds a bit of documentation to explain with the .profile file is used for with our application. Signed-off-by: Carlo Costino --- docs/all.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/all.md b/docs/all.md index 8ce47aa09..e4e9cb1e3 100644 --- a/docs/all.md +++ b/docs/all.md @@ -360,6 +360,15 @@ Public env vars make up the configuration in `deploy-config`. These are pulled i - [ ] The relevant YAML file in `deploy-config` using the format `var_name: value` - [ ] The manifest using the format `((var_name))` +## Managing application initiatlization + +In addition to the environment variable management, there may be some [additional application initialization](https://docs.cloudfoundry.org/devguide/deploy-apps/deploy-app.html#profile) that needs to be accounted for. This can include the following: + +- Setting other environment variables that require host environment information directly that the application will run in as opposed to being managed by the `manifest.yml` file or or a user-provided service. +- Running app initializing scripts that require host environment information directly prior to starting the application itself. + +These initialization steps are taken care of in the `.profile` file, which we use to set a couple of host environment-specific environment variables. + ## Sandbox environment There is a sandbox space, complete with terraform and `deploy-config/sandbox.yml` file available From 7d145a08723b15fefd93f76833944399b149aa49 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Tue, 28 Nov 2023 11:41:20 -0500 Subject: [PATCH 2/5] Added new section to the table of contents h/t to @stvnrlly for catching that! Signed-off-by: Carlo Costino --- docs/all.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/all.md b/docs/all.md index e4e9cb1e3..4444f9ff2 100644 --- a/docs/all.md +++ b/docs/all.md @@ -14,6 +14,7 @@ - [Deploying](#deploying) - [Egress Proxy](#egress-proxy) - [Managing environment variables](#managing-environment-variables) + - [Managing application initiatlization](#managing-application-initiatlization) - [Sandbox environment](#sandbox-environment) - [Database management](#database-management) - [Initial state](#initial-state) From b066fff07c8762a4e46fe4a4b56379d2f37b09c8 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Tue, 28 Nov 2023 12:44:32 -0500 Subject: [PATCH 3/5] ...and the README Signed-off-by: Carlo Costino --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3822c5186..01c8c13a8 100644 --- a/README.md +++ b/README.md @@ -411,6 +411,7 @@ instructions above for more details. - [Deploying](./docs/all.md#deploying) - [Egress Proxy](./docs/all.md#egress-proxy) - [Managing environment variables](./docs/all.md#managing-environment-variables) + - [Managing application initiatlization](./docs/all.md#managing-application-initiatlization) - [Sandbox environment](./docs/all.md#sandbox-environment) - [Database management](./docs/all.md#database-management) - [Initial state](./docs/all.md#initial-state) From 33d1fd45347c60ad061c6b8b7dbef0103251b617 Mon Sep 17 00:00:00 2001 From: stvnrlly Date: Tue, 28 Nov 2023 13:10:37 -0500 Subject: [PATCH 4/5] one fewer t --- README.md | 2 +- docs/all.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 01c8c13a8..fedc1cc7a 100644 --- a/README.md +++ b/README.md @@ -411,7 +411,7 @@ instructions above for more details. - [Deploying](./docs/all.md#deploying) - [Egress Proxy](./docs/all.md#egress-proxy) - [Managing environment variables](./docs/all.md#managing-environment-variables) - - [Managing application initiatlization](./docs/all.md#managing-application-initiatlization) + - [Managing application initialization](./docs/all.md#managing-application-initialization) - [Sandbox environment](./docs/all.md#sandbox-environment) - [Database management](./docs/all.md#database-management) - [Initial state](./docs/all.md#initial-state) diff --git a/docs/all.md b/docs/all.md index 4444f9ff2..fc6bd414e 100644 --- a/docs/all.md +++ b/docs/all.md @@ -14,7 +14,7 @@ - [Deploying](#deploying) - [Egress Proxy](#egress-proxy) - [Managing environment variables](#managing-environment-variables) - - [Managing application initiatlization](#managing-application-initiatlization) + - [Managing application initialization](#managing-application-initialization) - [Sandbox environment](#sandbox-environment) - [Database management](#database-management) - [Initial state](#initial-state) @@ -34,7 +34,7 @@ - [Queues and tasks](#queues-and-tasks) - [Priority queue](#priority-queue) - [Celery scheduled tasks](#celery-scheduled-tasks) -- [Notify.gov](#us-notify) +- [Notify.gov](#notifygov) - [System Description](#system-description) - [Run Book](#run-book) - [ Alerts, Notifications, Monitoring](#-alerts-notifications-monitoring) @@ -361,7 +361,7 @@ Public env vars make up the configuration in `deploy-config`. These are pulled i - [ ] The relevant YAML file in `deploy-config` using the format `var_name: value` - [ ] The manifest using the format `((var_name))` -## Managing application initiatlization +## Managing application initialization In addition to the environment variable management, there may be some [additional application initialization](https://docs.cloudfoundry.org/devguide/deploy-apps/deploy-app.html#profile) that needs to be accounted for. This can include the following: From 24c2bb6f11fc0d92c3d0e4cbdaa15aba5b45ebf9 Mon Sep 17 00:00:00 2001 From: stvnrlly Date: Tue, 28 Nov 2023 13:12:12 -0500 Subject: [PATCH 5/5] apparently another heading --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fedc1cc7a..7ee97d704 100644 --- a/README.md +++ b/README.md @@ -431,7 +431,7 @@ instructions above for more details. - [Queues and tasks](./docs/all.md#queues-and-tasks) - [Priority queue](./docs/all.md#priority-queue) - [Celery scheduled tasks](./docs/all.md#celery-scheduled-tasks) -- [Notify.gov](./docs/all.md#us-notify) +- [Notify.gov](./docs/all.md#notifygov) - [System Description](./docs/all.md#system-description) - [Run Book](./docs/all.md#run-book) - [ Alerts, Notifications, Monitoring](./docs/all.md#-alerts-notifications-monitoring)