Add k8s README (#2219)

Signed-off-by: Spencer Schrock <sschrock@google.com> Signed-off-by: Spencer Schrock <sschrock@google.com>
ossf · Aug 30, 2022 · 758cc39 · 758cc39
1 parent 5ac9f39
commit 758cc39
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/cron/k8s/README.md b/cron/k8s/README.md
@@ -0,0 +1,17 @@
+# Applying changes to the `openssf` cluster
+
+Currently there is no automation to sync changes to these files to the GKE cluster.
+Changes must be manually applied with `kubectl` by a user with permissions to modify the cluster.
+
+## Installing `kubectl`
+
+Follow instructions
+[here](https://cloud.google.com/kubernetes-engine/docs/how-to/cluster-access-for-kubectl)
+to configure `kubectl` and set the deafult cluster.
+
+The cluster name is `openssf` which is in zone `us-central1-c`.
+
+## Uploading a configuration file
+
+1. Verify you're working on the `openssf` cluster with `kubectl config current-context`
+2. Run `kubectl apply -f FILENAME` to apply a new configuration