Suggestions 2023-07-18 (UffizziCloud#53)

* README suggestions
* Split k8s resources into their own manifest files.
* Rename a lot of things.
* Reduce.
* Change images in manifests/ to be "fail safe" without kustomize.
* Copy changes in README and comments and workflow summary output
* correct shell syntax error.
* Change hostnames for Ingresses.
* correct mount point for postgres

Author: axisofentropy

.github/workflows/uffizzi.yml

@@ -12,7 +12,7 @@ permissions:
 jobs:
   # Job to build-push vote image
   build-vote:
-    name: Build and Push `vote`
+    name: Build and Push `vote` Image
     runs-on: ubuntu-latest
     if: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}
     outputs:
@@ -40,7 +40,7 @@ jobs:
 
   # Job to build-push worker image
   build-worker:
-    name: Build and Push `worker`
+    name: Build and Push `worker` Image
     runs-on: ubuntu-latest
     if: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}
     outputs:
@@ -68,7 +68,7 @@ jobs:
 
   # Job to build-push result image
   build-result:
-    name: Build and Push `result`
+    name: Build and Push `result` Image
     runs-on: ubuntu-latest
     if: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}
     outputs:
@@ -94,7 +94,8 @@ jobs:
           labels: ${{ steps.meta.outputs.labels }}
           context: ./result
 
-  uffizzi-cluster-setup: 
+  uffizzi-cluster:
+    name: Deploy to Uffizzi Virtual Cluster
     needs:
     - build-vote
     - build-worker
@@ -106,7 +107,7 @@ jobs:
       uses: actions/checkout@v3
 
     # Identify comment to be updated
-    - name: Find comment for deployment URL
+    - name: Find comment for Ephemeral Environment
       uses: peter-evans/find-comment@v2
       id: find-comment
       with:
@@ -132,47 +133,59 @@ jobs:
           Download the Uffizzi CLI to interact with the upcoming virtual cluster
           https://docs.uffizzi.com/install
         edit-mode: replace
-  
-    - if: ${{ github.event.action != 'closed' }}
-      name: Setup ucluster
+
+    - name: Connect to Virtual Cluster
       uses: UffizziCloud/cluster-action@main
       with:
-        action: create
         cluster-name: pr-${{ github.event.pull_request.number }}
-        server: https://app.uffizzi.com
 
-    - name: Kustomize and apply
+    - name: Kustomize and Apply Manifests
       run: |
-        kustomize edit set image vote-image=${{ needs.build-vote.outputs.tags }}
-        kustomize edit set image result-image=${{ needs.build-result.outputs.tags }}
-        kustomize edit set image worker-image=${{ needs.build-worker.outputs.tags }}
-        echo "`pwd`"
-        echo "`ls`"
-        kustomize build . | kubectl apply --kubeconfig ./kubeconfig -f -
+        # Change the image name to those just built and pushed.
+        kustomize edit set image dockersamples/examplevotingapp_vote=${{ needs.build-vote.outputs.tags }}
+        kustomize edit set image dockersamples/examplevotingapp_result=${{ needs.build-result.outputs.tags }}
+        kustomize edit set image dockersamples/examplevotingapp_worker=${{ needs.build-worker.outputs.tags }}
+
+        if [[ ${RUNNER_DEBUG} == 1 ]]; then
+          cat kustomization.yaml
+          echo "`pwd`"
+          echo "`ls`"
+        fi
+
+        # Apply kustomized manifests to virtual cluster.
+        kubectl apply --kustomize . --kubeconfig ./kubeconfig
+
+        # Imperatively create Ingress resources for the two HTTP endpoints.
+        export VOTE_HOST="pr-${{ github.event.number }}-${GITHUB_REPOSITORY_ID}-vote.uclusters.app.qa-gke.uffizzi.com"
+        export RESULT_HOST="pr-${{ github.event.number }}-${GITHUB_REPOSITORY_ID}-result.uclusters.app.qa-gke.uffizzi.com"
 
         if kubectl get ingress vote-${{ github.event.number }} --kubeconfig kubeconfig >/dev/null 2>&1; then
           echo "Ingress vote-${{ github.event.number }} already exists"
-
         else
           kubectl create ingress vote-${{ github.event.number }} \
             --class=nginx \
-            --rule="pr-${{ github.event.number }}-vote.app.qa-gke.uffizzi.com/*=vote:5000" \
+            --rule="${VOTE_HOST}/*=vote:5000" \
             --kubeconfig kubeconfig
         fi
 
         if kubectl get ingress result-${{ github.event.number }} --kubeconfig kubeconfig >/dev/null 2>&1; then
           echo "Ingress result-${{ github.event.number }} already exists"
-
-        else     
+        else
           kubectl create ingress result-${{ github.event.number }} \
             --class=nginx \
-            --rule="pr-${{ github.event.number }}-result.app.qa-gke.uffizzi.com/*=result:5001" \
+            --rule="${RESULT_HOST}/*=result:5001" \
             --kubeconfig kubeconfig
         fi
 
-        echo "Access the vote endpoint at \`pr-${{ github.event.number }}-vote.app.qa-gke.uffizzi.com\`." | tee --append $GITHUB_STEP_SUMMARY
-        echo "Access the result endpoint at \`pr-${{ github.event.number }}-result.app.qa-gke.uffizzi.com\`." | tee --append $GITHUB_STEP_SUMMARY
-      
+        if [[ ${RUNNER_DEBUG} == 1 ]]; then
+          kubectl get all --kubeconfig ./kubeconfig
+        fi
+
+        echo "Access the vote endpoint at https://${VOTE_HOST}"
+        echo "Access the result endpoint at https://${RESULT_HOST}"
+        echo "Access the \`vote\` endpoint at [\`${VOTE_HOST}\`.](https://${VOTE_HOST})" >> $GITHUB_STEP_SUMMARY
+        echo "Access the \`result\` endpoint at [\`${RESULT_HOST}\`](${RESULT_HOST})." >> $GITHUB_STEP_SUMMARY
+
     - name: Create or Update Comment with Deployment URL
       uses: peter-evans/create-or-update-comment@v2
       with:
@@ -186,29 +199,28 @@ jobs:
 
           1. Download and install the Uffizzi CLI from https://docs.uffizzi.com/install
           2. Login to Uffizzi: `uffizzi login`
-          3a. Update your kubeconfig: `uffizzi cluster update-kubeconfig --name pr-${{ github.event.pull_request.number }}`. This command will update your local kubeconfig. 
+          3a. Update your kubeconfig: `uffizzi cluster update-kubeconfig --name pr-${{ github.event.pull_request.number }}`. This command will update your local `~/.kube/config`.
           If you want to provide an alternate location follow 3b (the next step) instead.
           3b. Update your kubeconfig: `uffizzi cluster update-kubeconfig --name pr-${{ github.event.pull_request.number }} --kubeconfig=[KUBECONFIG]`, replacing `[KUBECONFIG]` with the path to your kubeconfig file.
-          After updating your kubeconfig, you can manage your cluster with `kubectl`.
+          After updating your kubeconfig, you can manage your cluster with `kubectl`, `kustomize`, `helm`, and other tools that use kubeconfig files: `kubectl get namespace --kubeconfig [KUBECONFIG]`
 
           Access the vote endpoint at https://pr-${{ github.event.number }}-vote.app.qa-gke.uffizzi.com
           Access the result endpoint at https://pr-${{ github.event.number }}-result.app.qa-gke.uffizzi.com
 
         edit-mode: replace
 
-  uffizzi-cluster-delete: 
+  uffizzi-cluster-delete:
     if: ${{ github.event_name == 'pull_request' && github.event.action == 'closed' }}
     runs-on: ubuntu-latest
     steps:
-    - name: Delete ucluster
+    - name: Delete Virtual Cluster
       uses: UffizziCloud/cluster-action@main
       with:
         action: delete
         cluster-name: pr-${{ github.event.pull_request.number }}
-        server: https://app.uffizzi.com
 
     # Identify comment to be updated
-    - name: Find comment for deployment URL
+    - name: Find comment for Ephemeral Environment
       uses: peter-evans/find-comment@v2
       id: find-comment
       with:
@@ -219,7 +231,6 @@ jobs:
 
     - name: Update Comment with Deletion
       uses: peter-evans/create-or-update-comment@v2
-      if: ${{ github.event.action == 'closed' }}
       with:
         comment-id: ${{ steps.find-comment.outputs.comment-id }}
         issue-number: ${{ github.event.pull_request.number }}

README.md

@@ -1,12 +1,14 @@
 # Uffizzi Quickstart for Kubernetes (~ 1 minute)
 
-Go from pull request to Uffizzi Ephemeral Environment in less than one minute. This quickstart will create a virtual Kubernetes cluster on Uffizzi Cloud and deploy a sample microservices application from this repository. Once created, you can connect to the cluster with the Uffizzi CLI, then manage the cluster via Kubectl. You can clean up the cluster by closing the pull request or manually deleting it via the Uffizzi CLI.
+Go from pull request to Uffizzi Ephemeral Environment in less than one minute. This quickstart will create a virtual Kubernetes cluster on Uffizzi Cloud and deploy a sample microservices application from this repository. Once created, you can connect to the cluster with the Uffizzi CLI, then manage the cluster via `kubectl`, `kustomize`, `helm`, and other tools. You can clean up the cluster by closing the pull request or manually deleting it via the Uffizzi CLI.
 
-### 1. Fork the `quickstart_k8s` repo
+### 1. Fork this `quickstart-k8s` repo
+
+[https://github.com/UffizziCloud/quickstart-k8s/fork](https://github.com/UffizziCloud/quickstart-k8s/fork)
 
 ⚠️ Be sure to <ins>**uncheck**</ins> the option **Copy the `main` branch only**.
 
-This ensures that the `try-uffizzi` branch will be included in your fork.  
+This ensures that the `try-uffizzi` branch will be included in your fork.
 
 ### 2. Enable GitHub Actions workflows for your fork
 
@@ -23,7 +25,7 @@ Once the action is finished running, check the pull request comments section to
 
 <img src="https://github.com/UffizziCloud/quickstart-k8s/blob/readme/images/comment.png" width="800">
 
-### 5. Access the vote and result endpoints
+### 5. Access the `vote` and `result` HTTP services
 
 Additionally, the app endpoints can be found on the action summary page. Under the Actions section of the forked repository, open up the latest completed action. Within the completed action, open up the summary section. Copy and paste the vote and result endpoints within the action summary
 
@@ -38,7 +40,7 @@ The PR will trigger a [GitHub Actions workflow](.github/workflows/uffizzi-cluste
 
 ### Configuration
 
-Ephemeral Environments are configured with [Kubernetes manifests](kustomization.yaml) that describe the application components and a [GitHub Actions workflow](.github/workflows/uffizzi-cluster.yaml) that includes a series of jobs triggered by a `pull_request` event and subsequent `push` events:
+Ephemeral Environments are configured with [Kubernetes manifests](manifests/) that describe the application components and a [GitHub Actions workflow](.github/workflows/uffizzi-cluster.yaml) that includes a series of jobs triggered by a `pull_request` event and subsequent `push` events:
 
 1. [Build and push the voting-app images](https://github.com/UffizziCloud/quickstart-k8s/blob/fc27d539d98fd602039a4259cafe9dd2ccf65dc5/.github/workflows/reusable.yml#L11C1-L90C28)
 2. [Create the Uffizzi cluster using the uffizzi-cli](https://github.com/UffizziCloud/quickstart-k8s/blob/fc27d539d98fd602039a4259cafe9dd2ccf65dc5/.github/workflows/reusable.yml#L92C1-L102C22)
@@ -61,8 +63,8 @@ The application defined by this repo allows users to vote for dogs or cats and s
 
 <img src="https://user-images.githubusercontent.com/7218230/192601868-562b705f-bf39-4eb8-a554-2a0738bd8ecf.png" width="400">
 
-* **voting-app** - A frontend web app in [Python](/vote) that lets you vote between two options
-* **redis** - A [Redis](https://hub.docker.com/_/redis/) queue that collects new votes
-* **worker** - A [.NET Core](/worker/src/Worker) worker that consumes votes and stores them in...
-* **db** - A [PostgreSQL](https://hub.docker.com/_/postgres/) database backed by a Docker volume
-* **result-app** - A [Node.js](/result) web app that shows the results of the voting in real time
+* `voting` - A frontend web app in [Python](/vote) that lets you vote between two options
+* `redis` - A [Redis](https://hub.docker.com/_/redis/) queue that collects new votes
+* `worker` - A [.NET Core](/worker/src/Worker) worker that consumes votes and stores them in...
+* `db` - A [PostgreSQL](https://hub.docker.com/_/postgres/) database backed by a Docker volume
+* `result` - A [Node.js](/result) web app that shows the results of the voting in real time

kustomization.yaml

@@ -1,21 +1,14 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 resources:
-  - manifests/db-deployment.yaml
-  - manifests/db-service.yaml
-  - manifests/redis-deployment.yaml
-  - manifests/redis-service.yaml
-  - manifests/result-deployment.yaml
-  - manifests/result-service.yaml
-  - manifests/vote-deployment.yaml
-  - manifests/vote-service.yaml
-  - manifests/worker-deployment.yaml
-
-
-images:
-- name: result-image
-  newName: dockersamples/examplevotingapp_result
-- name: vote-image
-  newName: dockersamples/examplevotingapp_vote
-- name: worker-image
-  newName: dockersamples/examplevotingapp_worker
+- manifests/db-deployment.yaml
+- manifests/db-persistentvolumeclaim.yaml
+- manifests/db-service.yaml
+- manifests/redis-deployment.yaml
+- manifests/redis-persistentvolumeclaim.yaml
+- manifests/redis-service.yaml
+- manifests/result-deployment.yaml
+- manifests/result-service.yaml
+- manifests/vote-deployment.yaml
+- manifests/vote-service.yaml
+- manifests/worker-deployment.yaml

manifests/db-deployment.yaml

@@ -26,20 +26,9 @@ spec:
         - containerPort: 5432
           name: postgres
         volumeMounts:
-        - mountPath: /var/lib/postgresql/data
+        - mountPath: /var/lib/postgresql
           name: db-data
       volumes:
       - name: db-data
         persistentVolumeClaim:
           claimName: db-pv-claim
----
-apiVersion: v1
-kind: PersistentVolumeClaim
-metadata:
-  name: db-pv-claim
-spec:
-  accessModes:
-    - ReadWriteOnce
-  resources:
-    requests:
-      storage: 1Gi

manifests/db-persistentvolumeclaim.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: db-pv-claim
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 1Gi

manifests/db-service.yaml

@@ -12,4 +12,3 @@ spec:
     targetPort: 5432
   selector:
     app: db
-  

manifests/redis-deployment.yaml

@@ -27,14 +27,3 @@ spec:
       - name: redis-data
         persistentVolumeClaim:
           claimName: redis-pv-claim
----
-apiVersion: v1
-kind: PersistentVolumeClaim
-metadata:
-  name: redis-pv-claim
-spec:
-  accessModes:
-    - ReadWriteOnce
-  resources:
-    requests:
-      storage: 1Gi

manifests/redis-persistentvolumeclaim.yaml

@@ -0,0 +1,10 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: redis-pv-claim
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 1Gi

manifests/redis-service.yaml

@@ -12,4 +12,3 @@ spec:
     targetPort: 6379
   selector:
     app: redis
-  

manifests/result-deployment.yaml

@@ -15,7 +15,7 @@ spec:
         app: result
     spec:
       containers:
-      - image: result-image 
+      - image: dockersamples/examplevotingapp_result
         name: result
         ports:
         - containerPort: 80

manifests/vote-deployment.yaml

@@ -15,7 +15,7 @@ spec:
         app: vote
     spec:
       containers:
-      - image: vote-image 
+      - image: dockersamples/examplevotingapp_vote
         name: vote
         ports:
         - containerPort: 80

manifests/vote-service.yaml

@@ -12,4 +12,3 @@ spec:
     targetPort: 80
   selector:
     app: vote
-  

manifests/worker-deployment.yaml

@@ -15,6 +15,5 @@ spec:
         app: worker
     spec:
       containers:
-      - image: worker-image
+      - image: dockersamples/examplevotingapp_worker
         name: worker
-