Merge pull request backstage#7 from thefrontside/mk/notes

Add document to lay out overview of the deployment steps

README.md

@@ -12,7 +12,6 @@ To start Backstage in your local cluster using minikube, run:
 
 ```
 TAG=whatever
-PG=whatever
 
 yarn install
 yarn tsc
@@ -23,18 +22,20 @@ minikube start
 eval $(minikube docker-env)
 minikube image load backstage:$TAG
 
-# TODO - need to modify the charts so that the following steps are automated for local development but for now please do the following manually:
+# TODO - need to modify the charts so that the following steps are automated but for now please do the following:
 * 💥 comment out ./backstate/templates/certificate.yaml
-* 💥 comment out ./backstage/templates/secrets.yaml
+* 💥 move ./backstage/templates/secrets.yaml to another directory
 * 💥 comment out `volumeMounts` and `volumes`
 * 💥 modify container command to exclude `app-config.production.yaml`
 
+PG=whatever
+
 helm upgrade --install min-postgres-chart ./charts/postgres \
   -f ./charts/postgres/Values.yaml \
   --set postgresUsername=$PG \
   --set postgresPassword=$PG
 
-helm upgrade --install min-backstage-chart ./charts/backstage \
+POSTGRES_SERVICE_PORT=5432 POSTGRES_USER=$PG POSTGRES_PASSWORD=$PG helm upgrade --install min-backstage-chart ./charts/backstage \
   -f ./charts/backstage/Values.yaml \
   --set backstageImage=backstage:$TAG \
   --set baseUrl=http://localhost:7007

notes/DEPLOYMENT.md

@@ -0,0 +1,25 @@
+# Backstage Deployment Workflow Overview
+
+The file for this workflow is located [here](https://github.com/thefrontside/backstage/blob/main/.github/workflows/release.yaml).
+
+Runs on commits to the main branch (pull request merge commits):
+
+1. Authenticate workflow runner to GCP
+
+2. Install Cloud SDK
+    - This is so we can run `gcloud` commands to submit a build to `Cloud Build`
+
+3. Run yarn install, tsc, and build
+
+4. Build Backstage image using `Cloud Build` and push to `Artifacts Registry`
+    - Uses the git commit SHA as image tag
+
+5. Authenticate to GKE cluster to upgrade deployments
+
+6. Upgrade [postgres chart](https://github.com/thefrontside/backstage/tree/main/charts/postgres)
+
+7. Upgrade [backstage chart](https://github.com/thefrontside/backstage/tree/main/charts/backstage)
+    - The deployment chart will use the new Backstage image that was just pushed to the Artifacts Registry
+
+8. Confirm the new deployment of Backstage is successful
+    - If unsuccessful the deployment will rollback to the previous revision