Comment + doc changes from review

Co-authored-by: Steve Brasier <[email protected]>

Author: wtripp180901

ansible/roles/cluster_infra/templates/resources.tf.j2

@@ -15,7 +15,7 @@ resource "terraform_data" "k3s_token" {
     input = "{{ k3s_token }}"
     lifecycle {
         ignore_changes = [
-            input,
+            input, # makes it a write-once value (set via Ansible)
         ]
     }   
 }

ansible/roles/k3s/tasks/main.yml

@@ -6,6 +6,7 @@
   register: stat_result
 
 - name: Download and air-gapped installation of k3s
+  # Using air-gapped install so containers are pre-installed to avoid rate-limiting from registries on cluster startup
   when: not stat_result.stat.exists
   block:
 

docs/k3s.README.md

@@ -1,6 +1,6 @@
 # Overview
 A K3s cluster is deployed with the Slurm cluster. Both an agent and server instance of K3s is installed during image build and the correct service (determined by OpenStack metadata) will be 
-enabled during boot. Nodes with the `k3s_server` metadata field defined will be configured as K3s agents (this field gives them the address of the server). The Slurm control node is currently configured as a server while all other nodes configured as agents. It should be noted that running multiple K3s servers isn't supported. Currently only the root user on the control node has 
+enabled during boot. Nodes with the `k3s_server` metadata field defined will be configured as K3s agents (this field gives them the address of the server). The Slurm control node is currently configured as a server while all other nodes are configured as agents. Using multiple K3s servers isn't supported. Currently only the root user on the control node has 
 access to the Kubernetes API. The `k3s` role installs Helm for package management. K9s is also installed in the image and can be used by the root user.
 
 # Idempotency

environments/.caas/hooks/pre.yml

@@ -2,6 +2,7 @@
 
 # Generate k3s token
 - name: Generate k3s token
+  # NB: Although this generates a new token on each run, the actual token set in metadata is retrieved from a set-once tofu resource, hence only the first value ever generated is relevant.
   hosts: openstack
   tasks:
     - ansible.builtin.set_fact:

environments/common/layouts/everything

@@ -87,5 +87,6 @@ cluster
 openhpc
 
 [k9s:children]
+# Hosts to install k9s on
 control