From 9794f82f44e4e5091b82b96486565f02b2cf6820 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 24 Nov 2023 16:34:14 -0500 Subject: [PATCH] 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