more updates

Author: lleadbet

.github/workflows/merge-to-main.yaml

@@ -48,6 +48,8 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            BACKEND_URL=${{ vars.BACKEND_URL }}
 
   build-and-push-subgraph-image:
     runs-on: ubuntu-latest

README.md

@@ -26,11 +26,9 @@ At a minimum, you will need:
 - A Github account.
 - An enterprise Apollo GraphOS account.
   - You can use [a free enterprise trial account](https://studio.apollographql.com/signup?type=enterprise-trial) if you don't have an enterprise contract.
-- Either:
-  - An account for:
-    - Google Cloud Platform (GCP).
-    - Amazon Web Services (AWS).
-  - A local Minikube setup.
+- An account for either:
+  - Google Cloud Platform (GCP).
+  - Amazon Web Services (AWS).
 
 Further requirements are noted within the [setup instructions](./docs/setup.md) as each type of environment (cloud vs. local) requires additional tooling.
 
@@ -41,10 +39,12 @@ Further requirements are noted within the [setup instructions](./docs/setup.md)
 
 ### [Setup](/docs/setup.md)
 
-- Part A: Gather accounts and credentials
-- Part B: Provision resources
-- Part C: Deploy applications
+During setup, you'll be:
+
+- Gathering accounts and credentials
+- Provisioning resources
+- Deploying the applications, including router, subgraphs, client, and observability tools
 
 ### [Cleanup](/docs/cleanup.md)
 
-- Part A: Automated cleanup
+Once finished, you can cleanup your environments following the above document.

docs/setup.md

@@ -9,7 +9,6 @@
       - [Minimum required dependencies](#minimum-required-dependencies)
       - [GCP](#gcp)
       - [AWS](#aws)
-      - [Minikube](#minikube)
     - [Gather accounts](#gather-accounts)
     - [Gather credentials](#gather-credentials)
       - [ GCP](#-gcp)
@@ -18,7 +17,6 @@
     - [Run setup commands](#run-setup-commands)
       - [ GCP](#-gcp-1)
       - [ AWS](#-aws-1)
-      - [Minikube](#minikube-1)
       - [General](#general)
   - [Part B: Provision resources](#part-b-provision-resources)
     - [Create Kubernetes clusters, basic infrastructure, and Github repositories](#create-kubernetes-clusters-basic-infrastructure-and-github-repositories)
@@ -29,9 +27,11 @@
     - [Deploy the router](#deploy-the-router)
       - [ GCP](#-gcp-2)
       - [ AWS](#-aws-2)
-    - [Client](#client)
+    - [Deploy the client](#deploy-the-client)
       - [ GCP](#-gcp-3)
       - [ AWS](#-aws-3)
+      - [ GCP](#-gcp-4)
+      - [ AWS](#-aws-4)
 
 ## Part A: Gather accounts and credentials
 
@@ -65,10 +65,10 @@ git pull
 - Optional: [Helm](https://helm.sh/docs/intro/install/)
 
 
-#### Minikube
+<!-- #### Minikube
 
 - [Minikube](https://minikube.sigs.k8s.io/docs/start/) configured according to the link
-- [Helm](https://helm.sh/docs/intro/install/)
+- [Helm](https://helm.sh/docs/intro/install/) -->
 
 ### Gather accounts
 
@@ -113,19 +113,19 @@ git pull
 
 ### Export all necessary variables
 
-First, change directories in the cloud provider you wish to use (or minikube). All terraform is within the `terraform` root level folder, with each provider having a subfolder within. For the below examples, we'll assume GCP, however the others will use the same commands. 
+First, change directories in the cloud provider you wish to use. All Terraform is within the `terraform` root level folder, with each provider having a subfolder within. For the below examples, we'll assume GCP, however the others will use the same commands. 
 
 Next, make a copy of `.env.sample` called `.env` to keep track of these values. You can run `source .env` to reload all environment variables in a new terminal session.
 
 ```sh
-# in either terraform/aws, terraform/gcp, or terraform/minikube
+# in either terraform/aws or terraform/gcp
 cp .env.sample .env
 ```
 
 Edit the new `.env` file:
 
 ```sh
-export PROJECT_ID="<your google cloud project id>" # if using AWS or minikube, you will not see this line and can omit this
+export PROJECT_ID="<your google cloud project id>" # if using AWS, you will not see this line and can omit this
 export APOLLO_KEY="<your apollo personal api key>"
 export GITHUB_ORG="<your github account name or organization name>"
 export TF_VAR_github_token="<your github personal access token>"
@@ -171,11 +171,11 @@ gh auth login
 ```
 
 
-#### Minikube
+<!-- #### Minikube
 
 ```sh
 gh auth login
-```
+``` -->
 
 #### General
 
@@ -204,7 +204,7 @@ You may need to clean up your Github packages before creating new repos of the s
 
 **Note: If using a cloud provider, the following commands will create resources on your cloud provider account and begin to accrue a cost.** The reference infrastructure defaults to a lower-cost environment (small node count and instance size), however it will not be covered by either of GCP's or AWS's free tiers.
 
-**Note: If you are using Minikube, this will not create a local cluster and instead configure the local environment to be ready to be deployed to.**
+<!-- **Note: If you are using Minikube, this will not create a local cluster and instead configure the local environment to be ready to be deployed to.** -->
 
 ```sh
 # for example, if using GCP
@@ -270,7 +270,7 @@ After this completes, you're ready to deploy your subgraphs!
 ### Deploy subgraphs to dev
 
 ```sh
-gh workflow run "Merge to Main" --repo $GITHUB_ORG/apollo-supergraph-k8s-subgraph-a
+gh workflow run "Merge to Main" --repo $GITHUB_ORG/reference-architecture
 gh workflow run "Merge to Main" --repo $GITHUB_ORG/apollo-supergraph-k8s-subgraph-b
 # this deploys a dependency for prod, see note below
 gh workflow run "Deploy Open Telemetry Collector" --repo $GITHUB_ORG/apollo-supergraph-k8s-infra
@@ -336,8 +336,8 @@ Follow the below instructions for your cloud provider you are using. Please note
 
 ```sh
 kubectx apollo-supergraph-k8s-prod
-ROUTER_IP=$(kubectl get ingress -n router -o jsonpath="{.*.*.status.loadBalancer.ingress.*.ip}")
-open http://$ROUTER_IP
+ROUTER_HOSTNAME=$(kubectl get ingress -n router -o jsonpath="{.*.*.status.loadBalancer.ingress.*.ip}")
+open http://$ROUTER_HOSTNAME
 ```
 
 Upon running the above commands, you'll have the Router page open and you can make requests against your newly deployed supergraph! 
@@ -352,11 +352,33 @@ open http://$ROUTER_HOSTNAME
 
 Upon running the above commands, you'll have the Router page open and you can make requests against your newly deployed supergraph! 
 
-### Client
+### Deploy the client
+
+The last step to getting fully configured is to deploy the client to both environments. To do so, we'll need our router ingress URL to point the client to. This can be pulled from the prior commands, so if you are using the same terminal session, feel free to skip the next set of commands. 
+
+#### <image src="../images/gcp.svg" height="13" style="margin:auto;" /> GCP
+
+```sh
+kubectx apollo-supergraph-k8s-prod
+ROUTER_HOSTNAME=$(kubectl get ingress -n router -o jsonpath="{.*.*.status.loadBalancer.ingress.*.ip}")
+```
 
-The last step to getting fully configured is to deploy the client to both environments. 
+Upon running the above commands, you'll have the Router page open and you can make requests against your newly deployed supergraph! 
 
-To do so:
+#### <image src="../images/aws.svg" height="13" style="margin:auto;" /> AWS
+
+```sh
+kubectx apollo-supergraph-k8s-prod
+ROUTER_HOSTNAME=$(kubectl get ingress -n router -o jsonpath="{.*.*.status.loadBalancer.ingress.*.hostname}")
+```
+
+Once you have the router hostname, you'll need to set it as a secret in the GitHub repository created.
+
+```sh
+  gh variable set BACKEND_URL --body "$ROUTER_HOSTNAME" --repo $GITHUB_ORG/reference-architecture
+```
+
+Lastly, we'll need to deploy the client:
 
 ```sh
 gh workflow run "Deploy Client" --repo $GITHUB_ORG/reference-architecture \
@@ -370,7 +392,7 @@ gh workflow run "Deploy Client" --repo $GITHUB_ORG/reference-architecture \
   -f debug=false
 ```
 
-This will create another ingress specific to the client, so much like the router, you can run the following commands depending on your provider.
+This will create another ingress specific to the client, so much like the router, you can run the following commands depending on your provider. As with the other ingress, this may take a few minutes to become active. 
 
 #### <image src="../images/gcp.svg" height="13" style="margin:auto;" /> GCP
 
@@ -380,7 +402,7 @@ ROUTER_IP=$(kubectl get ingress -n client -o jsonpath="{.*.*.status.loadBalancer
 open http://$ROUTER_IP
 ```
 
-Upon running the above commands, you'll have the Router page open and you can make requests against your newly deployed supergraph! 
+You should now have the full architecture deployed!
 
 #### <image src="../images/aws.svg" height="13" style="margin:auto;" /> AWS