From ae82a8dbbac3c2547fe986cebb05c14085a813b7 Mon Sep 17 00:00:00 2001 From: Nate Borrebach Date: Thu, 3 Oct 2024 12:17:56 -0700 Subject: [PATCH 1/5] Update link to Cloud Foundry CLI installation instructions --- docs/deployment-process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment-process.md b/docs/deployment-process.md index f2e9d6ca..e949483b 100644 --- a/docs/deployment-process.md +++ b/docs/deployment-process.md @@ -6,7 +6,7 @@ Download the Cloud Foundry CLI according to the [cloud.gov instructions][]. -[cloud.gov instructions]: https://docs.cloud.gov/getting-started/setup/ +[cloud.gov instructions]: https://cloud.gov/docs/getting-started/setup/#set-up-the-command-line We use the V7 Cloud Foundry CLI. If you're upgrading from V6, checkout [the CLI docs for instructions](https://github.com/cloudfoundry/cli). From 34df542994cba9de606c3e8ea35da5e2ab594630 Mon Sep 17 00:00:00 2001 From: Nate Borrebach Date: Thu, 3 Oct 2024 12:27:44 -0700 Subject: [PATCH 2/5] Replace nonexistent dev space in cf target example --- docs/deployment-process.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/deployment-process.md b/docs/deployment-process.md index e949483b..9c4cde3b 100644 --- a/docs/deployment-process.md +++ b/docs/deployment-process.md @@ -17,10 +17,10 @@ Tock will be deployed to the GovCloud instance of cloud.gov: cf login -a api.fr.cloud.gov --sso ``` -After authenticating, you'll need to target the org and space you want to work with. For example, if you wanted to work with the dev space: +After authenticating, you'll need to target the org and space you want to work with. For example, if you wanted to work with the staging space: ``` -cf target -o gsa-18f-tock -s dev +cf target -o gsa-18f-tock -s staging ``` Manifest files, which contain import deploy configuration settings, are located From 6972677bf8aa66c2fe95aaa462860bfdd6f664a9 Mon Sep 17 00:00:00 2001 From: Nate Borrebach Date: Thu, 3 Oct 2024 12:31:16 -0700 Subject: [PATCH 3/5] Document egress CF spaces and apps --- docs/deployment-process.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/deployment-process.md b/docs/deployment-process.md index 9c4cde3b..2fc17650 100644 --- a/docs/deployment-process.md +++ b/docs/deployment-process.md @@ -35,12 +35,16 @@ and production dependencies. - cloud.gov environment: `GovCloud` - Organization: `gsa-18f-tock` -- Spaces: `staging`, `prod` +- Spaces: `staging`, `staging-egress`, `prod`, `prod-egress` - Apps: - `staging` space: - `tock-staging` + - `staging-egress` space: + - `staging-egress` - `prod` space: - `tock` + - `prod-egress` space: + - `production-egress` - Routes: - tock.app.cloud.gov -> `staging` space, `tock-staging` app - tock.18f.gov -> `prod` space, `tock` app From 838c50a6089b9af34c5b0f672c6d3657f6ab3132 Mon Sep 17 00:00:00 2001 From: Nate Borrebach Date: Thu, 3 Oct 2024 12:33:41 -0700 Subject: [PATCH 4/5] Fix UPS heading link --- docs/deployment-process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deployment-process.md b/docs/deployment-process.md index 2fc17650..334a2e1c 100644 --- a/docs/deployment-process.md +++ b/docs/deployment-process.md @@ -52,7 +52,7 @@ and production dependencies. #### Cloud Foundry environment variables In production, Tock requires a few different environment variables. These are -updated using the [User Provided Service](#user-provided-service) and +updated using the [User Provided Service](#user-provided-service-ups) and configured in the `manifest-*.yaml`. | type | name | description | From b629a0af4f18c37afbfeea6b11976b8e9722c6e4 Mon Sep 17 00:00:00 2001 From: Nate Borrebach Date: Thu, 3 Oct 2024 12:36:06 -0700 Subject: [PATCH 5/5] Edit punctuation and a sentence structure --- docs/deployment-process.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/deployment-process.md b/docs/deployment-process.md index 334a2e1c..d49748d8 100644 --- a/docs/deployment-process.md +++ b/docs/deployment-process.md @@ -67,16 +67,15 @@ configured in the `manifest-*.yaml`. | **public** | `NEW_RELIC_ENV` | The application environment that appears in the New Relic interface. | | **public** | `NEW_RELIC_LOG` | Logging that New Relic should listen to: e.g. `stdout`. | -Variables with the designation **secret** are stored in the `tock-credentials`. -User-Provided Service (UPS). **Public** variables are stored in the -environment's `manifest-*.yml` file. +Variables with the designation **secret** are stored in the `tock-credentials` User-Provided Service (UPS). +**Public** variables are stored in the environment's `manifest-*.yml` file. ### Services #### User-provided service (UPS) -For cloud.gov deployments, this project makes use of a [user-provided service (UPS)][UPS] to get its configuration -variables, instead of using the local environment (except for [New Relic-related environment variables](#new-relic-environment-variables)). +For cloud.gov deployments, this project makes use of a [user-provided service (UPS)][UPS] to get its sensitive configuration +variables. It uses the local environment only for some [New Relic-related environment variables](#new-relic-environment-variables). You will need to create a UPS called `tock-credentials`, provide 'credentials' to it, and link it to the application instance. Please note that you'll need to do this for every Cloud Foundry `space`.