diff --git a/README.md b/README.md index 3822c5186..7ee97d704 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 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) @@ -430,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) diff --git a/docs/all.md b/docs/all.md index 8ce47aa09..fc6bd414e 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 initialization](#managing-application-initialization) - [Sandbox environment](#sandbox-environment) - [Database management](#database-management) - [Initial state](#initial-state) @@ -33,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) @@ -360,6 +361,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 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: + +- 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