darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-01-26 20:41:53 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add .profile file information to docs

Browse Source 
This changeset adds a bit of documentation to explain with the .profile file is used for with our application.

Signed-off-by: Carlo Costino <carlo.costino@gsa.gov>
This commit is contained in:
Carlo Costino
2023-11-24 16:34:14 -05:00
parent af29016d8e
commit 9794f82f44
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/all.md
View File

@@ -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