Updating the readme to be less RKO focused

Author: BobJWalker

.github/workflows/build.yml

@@ -53,4 +53,4 @@ jobs:
             - name: build and push website container
               working-directory: src
               run: | 
-                  docker buildx build --push --platform linux/amd64,linux/arm64,linux/arm/v7 -f "./RandomQuotes.Web/Dockerfile" --tag octopussamples/randomquotes-k8s:${{ steps.determine_version.outputs.semVer }} --tag octopussamples/randomquotes-k8s:latest .                 
+                  docker buildx build --push --platform linux/amd64,linux/arm64,linux/arm/v7 -f "./RandomQuotes.Web/Dockerfile" --tag ${{ secrets.DOCKERHUB_REPO }}:${{ env.GitVersion_SemVer }} --tag ${{ secrets.DOCKERHUB_REPO }}:latest .                 

Readme.md

@@ -1,15 +1,50 @@
-This is a sample application deploy to Kubernetes.  It's a good first application as it has no other components, but has an environment variable you can use to practice secrets on.
+This is a sample application deploy to Kubernetes.  It's a good first application as it has no other components, but it is simple and can be easily modified.
 
-The docker image is built using a GitHub action and it is pushed to Docker Hub.  You can find the docker repository here: https://hub.docker.com/r/octopussamples/randomquotes-k8s/tags
+Configuring Kubernetes to host this particular container will teach you the following:
+
+- [Pods](https://kubernetes.io/docs/concepts/workloads/pods/)
+- [ReplicaSets](https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/)
+- [Kubernetes Deployment Object](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/)
+- [Environment Variables](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/)
+- [Secrets](https://kubernetes.io/docs/concepts/configuration/secret/)
+- [Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
+- [Ingress Controllers](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/)
+- [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/)
+
+# GitHub Action and Docker Repository
+
+The Docker Container is built using a GitHub action and it is pushed to Docker Hub.  Both a Linux/x86 and Linux/arm64 image are built.  
+
+You can find the docker repository here: https://hub.docker.com/r/octopussamples/randomquotes-k8s/tags
+
+# Forking this repo
+
+Feel free to fork the repo for your own K8s testing and learning.  A few quick notes:
+
+- The primary build is found in `.github/workflows/build.yml`
+- The DockerFile is found in `.src/RandomQuotes.Web` - it injects the version from the build into the container itself.
+- All the Kubernetes items are found in the `k8s` folder.
+   - Base - contains all the basic configuration.
+   - Overlays - Kustomize overlays, one for each environment.
+   - Charts - The Helm chart.
+   - Provision - The core manifest files used to provision a new cluster.  
+
+If you fork this repo you will need to set the following repo secrets:
+
+- `DOCKERHUB_PAT_USERNAME` - your username
+- `DOCKERHUB_PAT` - the PAT of your user
+- `DOCKERHUB_REPO` - the docker hub repo to store the container - this really isn't a secret, but I made it one so you wouldn't have to modify the build
 
 # Prep Work
 
+If you are using this repository to learn about kubernetes, you can follow the steps and activities below.
+
 The docker image, manifest files, and variables will be provided to you.  You need to provide a k8s cluster, octopus instance, and worker.
 
-**You MUST finish all the prep work prior to RKO.  We will not wait for you to install K8s, configure a worker, or update your hosts file.**
+## 1. Install / Create K8s Cluster
+Setup a K8s cluster in Azure, GCP, or AWS.  Be forewarned, AWS IAM policies often make it the most difficult K8s implementation to use.
 
-## 1. Install K8s
-Install ONE of the following on a VM or locally!
+Optionally, You can install ONE of the following on a VM or locally for free!
 
 - [docker desktop](https://docs.docker.com/desktop/) - easiest and preferred
   - 🍎 If you are working on a Mac with an Apple chip—Docker Desktop is the easiest option:
@@ -23,39 +58,21 @@ Install ONE of the following on a VM or locally!
 Open up a command prompt or terminal.  Change the current directory in the terminal to the `k8s/provision` folder in this repo.
 - Run the following commands:
     - Create all the namespaces: `kubectl apply -f namespaces.yaml`
-    - Create the service account for deployments: `kubectl apply -f service-account-and-token.yaml`
-    - To get the token value run: `kubectl describe secret octopus-svc-account-token`.  Copy the token to a file for future usage.
     - Install the NGINX Ingress Controller: `kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.9.5/deploy/static/provider/cloud/deploy.yaml`
-    - If you are running rancher desktop or minikube
-        - Run `kubectl describe service kubernetes`.  Copy the endpoint, for example `172.18.135.254:6443` for later.
 
 ## 3. Pre-Configure Octopus
-Using your cloud instance of choice do the following:
+Using your Octopus Deploy cloud instance of choice do the following:
 
 - Create a worker pool name "Local K8s Worker Pool".
 - Ensure you have the following environments: "Development", "Test", "Staging", "Production"
-- Install a tentacle to connect to Octopus Deploy
-    - Option A: Install a polling tentacle directly on your machine (preferred and easiest).
-    - Option B: Run the tentacle as a docker container.  A custom image with kubectl has been pre-created.  Run `docker run --env ServerApiKey=YOUR_API_KEY --env ServerUrl=YOUR_SERVER_URL --env Space=Default --env TargetWorkerPool="Local K8s Worker Pool" --env ACCEPT_EULA=Y --env DISABLE_DIND=N --env ServerPort=10943 --env TargetName="Docker Worker" --platform linux/amd64 mcasperson/tentacle` 
-    - Option C: Run the tentacle from Kubernetes.  
-        - In a file explorer, go to `octopus-tentacle.yaml` file and replace `YOUR_API_KEY` and `YOUR_SERVER_URL` with your API key and server URL.
-        - Run `kubectl apply -f octopus-tentacle.yaml`
-    - WAIT until the worker shows up as healthy in your Local K8s Worker Pool.
+- Install the kubernetes agent on your K8s cluster.
 - Go to Library -> Feeds
     - Add a docker hub feed
     - Provide your username and PAT or a service account username and PAT otherwise you won't be able to create releases.
-- Go to Infrastructure -> Accounts. Add the token from the earlier step.
-- Go to Infrastructure -> Targets.  Add the kubernetes cluster.  
-    - If you are using docker desktop it should be: `https://kubernetes.docker.internal:6443/`
-    - If you are running rancher desktop or minikube:
-        - Use the endpoint IP address from earlier. For example `https://172.18.135.254:6443`
-    - Ensure the checkbox `Skip TLS Verification` is checked to make things easier.
-    - Use the token account you created from earlier.
+- Go to Infrastructure -> Targets.  Add the kubernetes cluster using the agent.  
     - Use the Local K8s Worker Pool from earlier.
     - Assign it to all four environments from earlier.
     - Use the role `local-k8s`.
-    - **If you are running the tentacle in a container**
-        - Update the health check to use an execution container.  For the image use `octopuslabs/k8s-workertools:1.29.0`
 - Go to Library -> Git Credentials.
     - Add a new GitHub PAT token for your user.  
         - The PAT will need explict access to OctopusSamples.  
@@ -65,7 +82,7 @@ Using your cloud instance of choice do the following:
     - Username will be your username.
 
 ## 4. Configure your hosts file.
-Go to your hosts file (if on Windows) and add the following entries.  The nginx ingress controller uses host headers for all routing.  Doing this will allow you to easily access the application running on your k8s cluster.
+Go to your hosts file (if running the K8s cluster on Windows locally) and add the following entries.  The nginx ingress controller uses host headers for all routing.  Doing this will allow you to easily access the application running on your k8s cluster.
 
 ```
 127.0.0.1       randomquotes.local
@@ -75,25 +92,9 @@ Go to your hosts file (if on Windows) and add the following entries.  The nginx
 127.0.0.1       randomquotesprod.local
 ```
 
-## 5. Install Argo
+# Activities
 
-This will install ArgoCD on your cluster.  Perfect for poking around!
-
-- Install ArgoCD
-    - Run `kubectl create namespace argocd`
-    - Run `kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml`
-- To access ArgoCD UI
-    - Run `kubectl port-forward svc/argocd-server -n argocd 8080:443`
-    - **Important** The port forwarding will only work while that window is open.
-    - If you want to, you can mess with ingress rules, but this is the quick and dirty approach to getting going.
-    - To login
-        - Username is admin
-        - Run `kubectl get secret argocd-initial-admin-secret -o jsonpath='{.data.password}' --namespace argocd` to get the password.  
-        - Please note it is base64, which you will need to decode.  You can do that via an online editor, or PowerShell `[System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String("blahblahblah"))`
-
-# 200 Session at RKO
-
-All the activities below will be done at RKO.
+All the activities below will be done to help teach K8s deployments.
 
 ## 1. First Activity - Basic Deployment 
 
@@ -109,7 +110,7 @@ These instructions will deploy the following to the default namespace.
 - Ingress Rule
 
 To perform the deployment do the following:
-- Go to https://hub.docker.com/r/octopussamples/randomquotes-k8s/tags and find the latest version tag (0.1.3 for example).  Update the `image` entry in the randomquotes-deployment.yaml file.
+- Go to https://hub.docker.com/r/octopussamples (or your repo)/randomquotes-k8s/tags and find the latest version tag (0.1.3 for example).  Update the `image` entry in the randomquotes-deployment.yaml file.
 - Open up a command prompt or terminal.  Change the current directory in the terminal to the `k8s/base` folder in this repo. 
 - Run `kubectl apply -f randomquotes-secrets.yaml`
 - Run `kubectl apply -f randomquotes-deployment.yaml`
@@ -162,42 +163,52 @@ In this example, we will put the kustomize overlays aside and instead use Octopu
 - Go to the deployment process
     - Add a DEPLOY RAW KUBERNETES YAML
         - Name: Create Random Quotes Secret
-        - Worker Pool: Use the Local K8s Worker Pool
-        - **If you are running the tentacle in a container**
-            - Update the health check to use an execution container.  For the image use `octopuslabs/k8s-workertools:1.29.0`
+        - Worker Pool: Since you are running the agent, this shouldn't matter
         - Role: Use the role from your k8s cluster
         - YAML Source: Git Repository
         - Git Credentials: Use the git credentials from the library
-        - Repository URL: https://github.com/OctopusSamples/RandomQuotes-K8s.git 
+        - Repository URL: https://github.com/[YOUR USER OR ORG]/RandomQuotes-K8s.git 
         - Branch Settings: main
         - Paths: k8s/base/randomquotes-secrets.yaml
         - Structured Configuration Values: Check the `Enable Structured Configuration Variables` checkbox
         - Namespace: #{Octopus.Environment.Name | ToLower}
     - Add a DEPLOY RAW KUBERNETES YAML
         - Name: Deploy Random Quotes
-        - Worker Pool: Use the Local K8s Worker Pool
-        - **If you are running the tentacle in a container**
-            - Update the health check to use an execution container.  For the image use `octopuslabs/k8s-workertools:1.29.0`
+        - Worker Pool: Since you are running the agent, this shouldn't matter
         - Role: Use the role from your k8s cluster
         - YAML Source: Git Repository
         - Git Credentials: Use the git credentials from the library
-        - Repository URL: https://github.com/OctopusSamples/RandomQuotes-K8s.git 
+        - Repository URL: https://github.com/[YOUR USER OR ORG]/RandomQuotes-K8s.git 
         - Branch Settings: main
         - Paths: k8s/base/randomquotes-deployment.yaml
         - Structured Configuration Valures: Check the `Enable Structured Configuration Variables` checkbox
         - Referenced Packages: 
             - Package Feed: DockerHub
-            - PackageId: octopussamples/randomquotes-k8s
+            - PackageId: [octopussamples | REPLACE octopussamples with your user]/randomquotes-k8s
             - Name: randomquotes-k8s
         - Namespace: #{Octopus.Environment.Name | ToLower}
     - Save the deployment process
 - Create a release and deploy it to dev.
 - Test by going to randomquotesdev.local.
 - Promote the release through each environment.  Test along the way.
 
-## 4. Fourth Activity - ArgoCD
+## 4. Fourth Activity - ArgoCD - Optional!
 
-This activity will happen only if we have enough time.  We will install and configure ArgoCD so we can compare and contrast the two.
+If you wish to learn ArgoCD, you can perform these steps.
+
+First install ArgoCD on the cluster.
+
+- Install ArgoCD
+    - Run `kubectl create namespace argocd`
+    - Run `kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml`
+- To access ArgoCD UI
+    - Run `kubectl port-forward svc/argocd-server -n argocd 8080:443`
+    - **Important** The port forwarding will only work while that window is open.
+    - If you want to, you can mess with ingress rules, but this is the quick and dirty approach to getting going.
+    - To login
+        - Username is admin
+        - Run `kubectl get secret argocd-initial-admin-secret -o jsonpath='{.data.password}' --namespace argocd` to get the password.  
+        - Please note it is base64, which you will need to decode.  You can do that via an online editor, or PowerShell `[System.Text.Encoding]::UTF8.GetString([System.Convert]::FromBase64String("blahblahblah"))`
 
 - Configure first application 
     - Click the `New App` button