darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2025-12-21 07:51:13 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #625 from GSA/add-cf-profile-to-docs

Browse Source 
Add `.profile` file information to docs
This commit is contained in:
Carlo Costino
2023-11-28 14:37:47 -05:00
committed by GitHub
parent 5ab3d05f9b 24c2bb6f11
commit c7185d0f26
2 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -411,6 +411,7 @@ instructions above for more details.
- [Deploying](./docs/all.md#deploying) - [Deploying](./docs/all.md#deploying)
- [Egress Proxy](./docs/all.md#egress-proxy) - [Egress Proxy](./docs/all.md#egress-proxy)
- [Managing environment variables](./docs/all.md#managing-environment-variables) - [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) - [Sandbox environment](./docs/all.md#sandbox-environment)
- [Database management](./docs/all.md#database-management) - [Database management](./docs/all.md#database-management)
- [Initial state](./docs/all.md#initial-state) - [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) - [Queues and tasks](./docs/all.md#queues-and-tasks)
- [Priority queue](./docs/all.md#priority-queue) - [Priority queue](./docs/all.md#priority-queue)
- [Celery scheduled tasks](./docs/all.md#celery-scheduled-tasks) - [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) - [System Description](./docs/all.md#system-description)
- [Run Book](./docs/all.md#run-book) - [Run Book](./docs/all.md#run-book)
- [ Alerts, Notifications, Monitoring](./docs/all.md#-alerts-notifications-monitoring) - [ Alerts, Notifications, Monitoring](./docs/all.md#-alerts-notifications-monitoring)

12
docs/all.md
View File

@@ -14,6 +14,7 @@
- [Deploying](#deploying) - [Deploying](#deploying)
- [Egress Proxy](#egress-proxy) - [Egress Proxy](#egress-proxy)
- [Managing environment variables](#managing-environment-variables) - [Managing environment variables](#managing-environment-variables)
- [Managing application initialization](#managing-application-initialization)
- [Sandbox environment](#sandbox-environment) - [Sandbox environment](#sandbox-environment)
- [Database management](#database-management) - [Database management](#database-management)
- [Initial state](#initial-state) - [Initial state](#initial-state)
@@ -33,7 +34,7 @@
- [Queues and tasks](#queues-and-tasks) - [Queues and tasks](#queues-and-tasks)
- [Priority queue](#priority-queue) - [Priority queue](#priority-queue)
- [Celery scheduled tasks](#celery-scheduled-tasks) - [Celery scheduled tasks](#celery-scheduled-tasks)
- [Notify.gov](#us-notify) - [Notify.gov](#notifygov)
- [System Description](#system-description) - [System Description](#system-description)
- [Run Book](#run-book) - [Run Book](#run-book)
- [ Alerts, Notifications, Monitoring](#-alerts-notifications-monitoring) - [ 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 relevant YAML file in `deploy-config` using the format `var_name: value`
- [ ] The manifest using the format `((var_name))` - [ ] 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 ## Sandbox environment
There is a sandbox space, complete with terraform and `deploy-config/sandbox.yml` file available There is a sandbox space, complete with terraform and `deploy-config/sandbox.yml` file available