adding registries.yaml example

rancherfederal · Jan 28, 2025 · 1b9f08a · 1b9f08a
1 parent b1ea650
commit 1b9f08a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -16,6 +16,8 @@
       - [Example](#example-1)
     - [Defining an Audit Policy](#defining-an-audit-policy)
       - [Example](#example-2)
+    - [Defining a Registries.yaml Config](#defining-a-registries.yaml-config)
+      - [Example](#example-3)
     - [Adding Additional Cluster Manifests](#adding-additional-cluster-manifests)
       - [Pre-Deploy Example](#pre-deploy-example)
       - [Post-Deploy Example](#post-deploy-example)
@@ -184,6 +186,18 @@ group_rke2_config:
 ```
 
 
+### Defining a registries.yaml Config
+As seen [here](https://docs.rke2.io/install/private_registry), RKE2 allows for manipulation of how containerd pulls containers. In order to define a registries.yaml config, nodes will need to have the `rke2_registry_config_file_path` variable defined. Assuming all nodes are to use the same registry configuration, this variable can be set at the top-level so that it applies to all nodes.
+
+#### Example 
+Below is an example of how this can be defined at the top-level:  
+
+__group_vars/all.yml:__
+```yaml
+rke2_registry_config_file_path: "{{ playbook_dir }}/docs/advanced_sample_inventory/files/registries.yaml"
+```
+
+
 ### Adding Additional Cluster Manifests  
 If you have a cluster that needs extra manifests to be deployed or the cluster needs a critical component to be configured RKE2's "HelmChartConfig" is an available option (among others). The Ansible repository supports the use of these configuration files. Simply place the Helm chart configs in a folder, give Ansible the path to the folder, and Ansible will enumerate the files and place them on the first server node. 
 

diff --git a/docs/sample_files/registries.yaml → ...ed_sample_inventory/files/registries.yaml b/docs/sample_files/registries.yaml → ...ed_sample_inventory/files/registries.yaml