From 74d0b40e163ada4fab87bf40cce87bc43a55ea79 Mon Sep 17 00:00:00 2001
From: John Skiles Skinner <john.skinner@gsa.gov>
Date: Wed, 24 Jul 2024 14:11:12 -0700
Subject: [PATCH] Doc updates, including setting Network Policy

---
 docs/all.md | 35 +++++++++++++++++++++++++++++------
 1 file changed, 29 insertions(+), 6 deletions(-)

diff --git a/docs/all.md b/docs/all.md
index 5f9be2a30..9f54146fa 100644
--- a/docs/all.md
+++ b/docs/all.md
@@ -439,22 +439,32 @@ Rules for use:
 If this is the first time you have used Terraform in this repository, you will first have to hook your copy of Terraform up to our remote state. Follow [Retrieving existing bucket credentials](https://github.com/GSA/notifications-api/tree/main/terraform#retrieving-existing-bucket-credentials).
 
 1. Set up services:
-    ```
+    ```bash
     $ cd terraform/sandbox
     $ ../create_service_account.sh -s notify-sandbox -u <your-name>-terraform -m > secrets.auto.tfvars
     $ terraform init
     $ terraform plan
     $ terraform apply
     ```
+    Check [Terraform troubleshooting](https://github.com/GSA/notifications-api/tree/main/terraform#troubleshooting) if you encounter problems.
 1. Change back to the project root directory: `cd ../..`
-1. start a poetry shell as a shortcut to load `.env` file variables: `$ poetry shell`
+1. Start a poetry shell as a shortcut to load `.env` file variables by running `poetry shell`
 1. Output requirements.txt file: `poetry export --without-hashes --format=requirements.txt > requirements.txt`
-1. Deploy the application:
+1. Ensure you are using the correct CloudFoundry target
+  ```bash
+  cf target -o gsa-tts-benefits-studio -s notify-sandbox
   ```
+1. Deploy the application:
+  ```bash
   cf push --vars-file deploy-config/sandbox.yml --var NEW_RELIC_LICENSE_KEY=$NEW_RELIC_LICENSE_KEY
   ```
   The real `push` command has more var arguments than the single one above. Get their values from a Notify team member.
-1. Visit the URL of the app you just deployed
+1. If you are setting up both our API app and our [Admin app](https://github.com/GSA/notifications-admin) in the sandbox, run this to allow the two apps to communicate with each other:
+  ```bash
+  cf add-network-policy notify-admin-sandbox notify-api-sandbox --protocol tcp --port 61443
+  ```
+  Check [API request failed](#api-request-failed) for problems.
+1. Visit the URL(s) of the app you just deployed
   * Admin https://notify-sandbox.app.cloud.gov/
   * API https://notify-api-sandbox.app.cloud.gov/
 
@@ -1392,7 +1402,20 @@ After pushing the Admin app, you might see this in the logs
 {"name": "app", "levelname": "ERROR", "message": "API unknown failed with status 503 message Request failed", "pathname": "/home/vcap/app/app/__init__.py", ...
 ```
 
-This indicates that the Admin and API apps are unable to talk to each other because of either a missing route or a missing network policy. The apps require [container-to-container networking](https://cloud.gov/docs/management/container-to-container/) to communicate. List `cf network-policies` and compare the output to our other deployed envs. If you find a policy is missing, you might have to create a network policy with something like:
+And you would also see this in the Admin web UI
+
 ```
-cf add-network-policy notify-admin-sandbox notify-api-sandbox --protocol tcp --port 61443
+Sorry, we can't deliver what you asked for right now.
 ```
+
+This indicates that the Admin and API apps are unable to talk to each other because of either a missing route or a missing network policy. The apps require [container-to-container networking](https://cloud.gov/docs/management/container-to-container/) to communicate. List `cf network-policies` and compare the output to our other deployed envs. If you find a policy is missing, you may not have created the correct Network Policy. See the command in [Deploying to the sandbox](#deploying-to-the-sandbox).
+
+### Service instance not found
+
+This error encounted after `cf push` indicates you may be using the wrong CloudFoundry target
+
+```
+For application 'notify-api-sandbox': Service instance 'notify-api-rds-sandbox' not found
+```
+
+Run `cf target -o gsa-tts-benefits-studio -s notify-sandbox` before pushing to the Sandbox