Update ghes docs, deployments (#149)

* move runners to enterprise scope by default * update GHES docs * s/ae/es/g * one little typo gets its very own commit
some-natalie · Nov 2, 2022 · f26fc40 · f26fc40
1 parent 777a542
commit f26fc40
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 11 deletions.
diff --git a/.github/workflows/baremetal-deploy.yml b/.github/workflows/baremetal-deploy.yml
@@ -1,4 +1,4 @@
-name: GHAE - deploy runners (bare metal)
+name: GHES - deploy runners (bare metal)
 
 on:
   workflow_dispatch: # deploy on demand

diff --git a/.github/workflows/baremetal-remove.yml b/.github/workflows/baremetal-remove.yml
@@ -1,4 +1,4 @@
-name: GHAE - remove runners (bare metal)
+name: GHES - remove runners (bare metal)
 
 on:
   workflow_dispatch: # deploy on demand

diff --git a/deployments/ghes/README.md b/deployments/ghes/README.md
@@ -1,3 +1,14 @@
 # GHES runners
 
-There's nothing special about these runners.  They deploy to a different Kubernetes cluster (the `bare-metal` environment) and attach to a different organization in GHES.  The [`bootstrap.sh`](bootstrap.sh) script takes a URL and token to set up test environments very quickly.
+There's nothing special about these runners.  They deploy to a different Kubernetes cluster (the `docker-desktop` environment or the `open-shift` environment) and attach to a different organization in GHES for testing/demonstration.  The [`bootstrap.sh`](bootstrap.sh) script takes a URL and token to set up test environments very quickly.
+
+## Local environments
+
+This bootstrap script has been tested and is used routinely on [Docker Desktop's local Kubernetes cluster](https://docs.docker.com/desktop/kubernetes/), [Azure Kubernetes Service](https://azure.microsoft.com/en-us/products/kubernetes-service/#overview), and [RedHat OpenShift Local](https://access.redhat.com/documentation/en-us/red_hat_openshift_local).
+
+For OpenShift, because these are privileged pods, you must allow this explicitly in the namespaces the pods will run in.
+
+    ```shell
+    oc adm policy add-scc-to-user privileged -z default -n runners
+    oc adm policy add-scc-to-user privileged -z default -n test-runners
+    ```
diff --git a/deployments/ghes/podman.yml b/deployments/ghes/podman.yml
@@ -7,8 +7,8 @@ spec:
   replicas: 2
   template:
     spec:
-      # enterprise: github
-      organization: acme
+      enterprise: github
+      # organization: acme
       # repository: acme/testrepo
       ephemeral: true
       image: ghcr.io/some-natalie/kubernoodles/podman:latest # change this to the version you really want!

diff --git a/deployments/ghes/rootless-ubuntu-focal.yml b/deployments/ghes/rootless-ubuntu-focal.yml
@@ -7,8 +7,8 @@ spec:
   replicas: 2
   template:
     spec:
-      # enterprise: github
-      organization: acme
+      enterprise: github
+      # organization: acme
       # repository: acme/testrepo
       ephemeral: true
       image: ghcr.io/some-natalie/kubernoodles/rootless-ubuntu-focal:latest # change this to the version you really want!

diff --git a/deployments/ghes/ubuntu-focal.yml b/deployments/ghes/ubuntu-focal.yml
@@ -7,8 +7,8 @@ spec:
   replicas: 2
   template:
     spec:
-      # enterprise: github
-      organization: acme
+      enterprise: github
+      # organization: acme
       # repository: acme/testrepo
       ephemeral: true
       image: ghcr.io/some-natalie/kubernoodles/ubuntu-focal:latest # change this to the version you really want!

diff --git a/deployments/ghes/ubuntu-jammy.yml b/deployments/ghes/ubuntu-jammy.yml
@@ -7,8 +7,8 @@ spec:
   replicas: 2
   template:
     spec:
-      # enterprise: github
-      organization: acme
+      enterprise: github
+      # organization: acme
       # repository: acme/testrepo
       ephemeral: true
       image: ghcr.io/some-natalie/kubernoodles/ubuntu-jammy:latest # change this to the version you really want!