Updated documentation to remove deprecated playbook structures #115

PyratLabs · May 15, 2021 · 4d5d5b2 · 4d5d5b2
1 parent 7bb9f6d
commit 4d5d5b2
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,14 @@
 ---
 -->
 
+## 2021-05-13, v2.9.1
+
+<!-- Today was a better day... <3 -->
+
+### Notable changes
+
+ - Documentation, remove references to deprecated configuration techniques #115
+
 ## 2021-05-13, v2.9.0
 
 <!-- a shit day... -->

diff --git a/README.md b/README.md
@@ -305,8 +305,10 @@ Example playbook, single control node running `testing` channel k3s:
 
 ```yaml
 - hosts: k3s_nodes
+  vars:
+    k3s_release_version: testing
   roles:
-     - { role: xanmanning.k3s, k3s_release_version: testing }
+     - role: xanmanning.k3s
 ```
 
 Example playbook, Highly Available with PostgreSQL database running the latest

diff --git a/documentation/configuration/2-node-ha-ext-datastore.md b/documentation/configuration/2-node-ha-ext-datastore.md
@@ -12,9 +12,9 @@ Main guide: https://rancher.com/docs/k3s/latest/en/installation/ha/
 ## Architecture
 
 ```text
-                     +---------------+
-                     | Load Balancer |
-                     +-------+-------+
+                   +-------------------+
+                   | Load Balancer/VIP |
+                   +---------+---------+
                              |
                              |
                              |
@@ -50,8 +50,8 @@ Main guide: https://rancher.com/docs/k3s/latest/en/installation/ha/
 ## Configuration
 
 For your control nodes, you will need to instruct the control plane of the
-PostgreSQL datastore endpoint and set `k3s_control_node_address` to be the
-hostname or IP of your load balancer.
+PostgreSQL datastore endpoint and set `k3s_registration_address` to be the
+hostname or IP of your load balancer or VIP.
 
 Below is the example for PostgreSQL, it is possible to use MySQL or an Etcd
 cluster as well. Consult the below guide for using alternative datastore
@@ -69,11 +69,11 @@ k3s_server:
 ```
 
 Your worker nodes need to know how to connect to the control plane, this is
-defined by setting `k3s_control_node_address` to the hostname or IP address of
+defined by setting `k3s_registration_address` to the hostname or IP address of
 the load balancer.
 
 ```yaml
 ---
 
-k3s_control_node_address: control.examplek3s.com
+k3s_registration_address: control.examplek3s.com
 ```
diff --git a/documentation/operations/updating-k3s.md b/documentation/operations/updating-k3s.md
@@ -23,10 +23,10 @@ to go to. For example, from your `v1.19.3+k3s1` playbook:
 
 - name: Provision k3s cluster
   hosts: k3s_cluster
+  vars:
+    k3s_release_version: v1.19.3+k3s1
   roles:
     - name: xanmanning.k3s
-      vars:
-        k3s_release_version: v1.19.3+k3s1
 ```
 
 Updating to `v1.20.2+k3s1`:
@@ -37,10 +37,10 @@ Updating to `v1.20.2+k3s1`:
 
 - name: Provision k3s cluster
   hosts: k3s_cluster
+  vars:
+    k3s_release_version: v1.20.2+k3s1
   roles:
     - name: xanmanning.k3s
-      vars:
-        k3s_release_version: v1.20.2+k3s1
 ```
 
 ### Automatic updates