merge pull request #89 from zackbradys/main

standardized example references
rancherfederal · Mar 29, 2024 · 91303c4 · 91303c4
2 parents 705e65d + efc4067
commit 91303c4
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 22 deletions.
diff --git a/docs/airgapped-docs/getting-started.md b/docs/airgapped-docs/getting-started.md
@@ -57,8 +57,8 @@ If you're working with a cluster that was imported or is to be imported into the
 # /etc/rancher/k3s/registries.yaml
 # /etc/rancher/rke2/registries.yaml
 configs:
-  "YOUR_REGISTRY_HOSTNAME":
+  "<registry-url>":
     auth:
-      username: YOUR_REGISTRY_USERNAME
-      password: YOUR_REGISTRY_PASSWORD
+      username: <redacted>
+      password: <redacted>
 ```
diff --git a/docs/registry-docs/kubernetes-config.md b/docs/registry-docs/kubernetes-config.md
@@ -11,7 +11,7 @@ The full configuration using your authenticated registry is below:
 ```yaml
 # /etc/rancher/k3s/registries.yaml
 configs:
-  "YOUR_REGISTRY_DOMAIN_HERE":
+  "<registry-url>":
     auth:
       username: <redacted>
       password: <redacted>
@@ -20,7 +20,7 @@ configs:
 You will also need to utilize the `system-default-registry` flag when installing K3s to ensure it uses the registry. For instance:
 
 ```bash
-curl -sfL https://get.k3s.io | sh -s - --system-default-registry=<YOUR_REGISTRY_DOMAIN_HERE>
+curl -sfL https://get.k3s.io | sh -s - --system-default-registry=<registry-url>
 ```
 
 ### Usage with `rke2`
@@ -32,7 +32,7 @@ The full configuration using the shared alpha account is below:
 ```yaml
 # /etc/rancher/rke2/registries.yaml
 configs:
-  "YOUR_REGISTRY_DOMAIN_HERE":
+  "<registry-url>":
     auth:
       username: <redacted>
       password: <redacted>
@@ -44,6 +44,6 @@ You will also need to utilize the `system-default-registry` flag when installing
 # /etc/rancher/rke2/config.yaml
 node-name: controlplane1
 write-kubeconfig-mode: 0640
-system-default-registry: YOUR_REGISTRY_DOMAIN_HERE
+system-default-registry: <registry-url>
 ...
 ```
diff --git a/docs/registry-docs/rancher-config.md b/docs/registry-docs/rancher-config.md
@@ -31,23 +31,28 @@ After adding the Cert Manager repo and installing the CRDs, use the following to
 ```
 cat <<EOT > /tmp/cert-manager-values.yaml
 image:
-  registry: YOUR_REGISTRY_DOMAIN_HERE
+  registry: <registry-url>
   repository: jetstack/cert-manager-controller
 
 webhook:
   image:
-    registry: YOUR_REGISTRY_DOMAIN_HERE
+    registry: <registry-url>
     repository: jetstack/cert-manager-webhook
 
 cainjector:
   image:
-    registry: YOUR_REGISTRY_DOMAIN_HERE
+    registry: <registry-url>
     repository: jetstack/cert-manager-cainjector
 
 startupapicheck:
   image:
-    registry: YOUR_REGISTRY_DOMAIN_HERE
-    repository: jetstack/cert-manager-ctl
+    registry: <registry-url>
+    repository: jetstack/cert-manager-startupapicheck
+
+acmesolver:
+  image:
+    registry: <registry-url>
+    repository: jetstack/cert-manager-acmesolver
 EOT
 ```
 
@@ -99,10 +104,10 @@ The full configuration using the shared alpha account is below:
 mirrors:
   docker.io:
     endpoint:
-      - 'https://YOUR_REGISTRY_DOMAIN'
+      - "https://<registry-url>"
 
 configs:
-  'YOUR_REGISTRY_DOMAIN':
+  "<registry-url>":
     auth:
       username: <redacted>
       password: <redacted>
@@ -131,8 +136,8 @@ helm install rancher carbide-charts/rancher \
   --namespace cattle-system \
   --set hostname=rancher.my.org \
   --set replicas=3 \
-  --set rancherImage=YOUR_REGISTRY_DOMAIN/rancher/rancher
-  --set systemDefaultRegistry=YOUR_REGISTRY_DOMAIN
+  --set rancherImage=<registry-url>/rancher/rancher
+  --set systemDefaultRegistry=<registry-url>
 ```
 
 **NOTE:** This requires configuring your above K3s/RKE2 `registries.yaml` to work.
@@ -150,10 +155,10 @@ write_files:
       mirrors:
         docker.io:
             endpoint:
-            - "https://YOUR_REGISTRY_DOMAIN"
+            - "https://<registry-url>"
 
         configs:
-        "YOUR_REGISTRY_DOMAIN":
+        "<registry-url>":
             auth:
             username: <redacted>
             password: <redacted>

diff --git a/docs/registry-docs/uninstall-kubernetes.md b/docs/registry-docs/uninstall-kubernetes.md
@@ -19,7 +19,7 @@ You will also need to unset the `system-default-registry` configuration when ins
 For instance, if you originally ran the following when using Carbide images:
 
 ```bash
-curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="server --flannel-backend none" K3S_TOKEN=12345 sh - --system-default-registry YOUR_REGISTRY_DOMAIN_HERE
+curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="server --flannel-backend none" K3S_TOKEN=12345 sh - --system-default-registry <registry-url>
 ```
 
 You'd need to run:

diff --git a/docs/stigatron-docs/getting-started.md b/docs/stigatron-docs/getting-started.md
@@ -58,8 +58,8 @@ If you're working with a cluster that was imported or is to be imported into the
 # /etc/rancher/k3s/registries.yaml
 # /etc/rancher/rke2/registries.yaml
 configs:
-  "YOUR_REGISTRY_HOSTNAME":
+  "<registry-url>":
     auth:
-      username: YOUR_REGISTRY_USERNAME
-      password: YOUR_REGISTRY_PASSWORD
+      username: <redacted>
+      password: <redacted>
 ```