update common group_vars files to copy grafana format for where docs are

Author: sjpb

ansible/roles/filebeat/defaults/main.yml

@@ -1,5 +1,4 @@
 ---
 
-# You must define this variable.
-#filebeat_config_path: undefined
-filebeat_podman_user: "{{ ansible_user }}"
+#filebeat_config_path: undefined # REQUIRED. Path to filebeat.yml configuration file template
+filebeat_podman_user: "{{ ansible_user }}" # User that runs the filebeat container

environments/common/inventory/group_vars/all/basic_users.yml

@@ -1,2 +1,7 @@
+---
+
+# See: ansible/roles/basic_users/README.md 
+# for variable definitions.
+
 basic_users_homedir: /home
 basic_users_users: []

environments/common/inventory/group_vars/all/filebeat.yml

@@ -1,4 +1,5 @@
 ---
+
 # Path to filebeat.yml configuration file template
 filebeat_config_path: "{{ appliances_repository_root }}/environments/common/files/filebeat/filebeat.yml"
 

environments/common/inventory/group_vars/all/hpctests.yml

@@ -1 +1,5 @@
+---
+# See: ansible/roles/hpctests/README.md
+# for variable definitions.
+
 hpctests_rootdir: "/home/hpctests" # Can't use centos's $HOME as that's not on /home and may not have another user

environments/common/inventory/group_vars/all/opendistro.yml

@@ -1,6 +1,7 @@
 ---
-# Path to template that specifies opendistro users.
 # See: https://opendistro.github.io/for-elasticsearch-docs/docs/security/configuration/yaml/
+
+# Path to template that specifies opendistro users
 opendistro_internal_users_path: "{{ appliances_repository_root }}/environments/common/files/opendistro/internal_users.yml"
 
 # The user what runs the opendistro container

environments/common/inventory/group_vars/all/openhpc.yml

@@ -1,4 +1,5 @@
 ---
+
 # See: https://github.com/stackhpc/ansible-role-openhpc
 # for variable definitions
 

environments/common/inventory/group_vars/all/openhpc_tests.yml

@@ -1,3 +1,8 @@
+---
+
+# See: https://github.com/stackhpc/ansible_collection_slurm_openstack_tools/tree/main/roles/test
+# for variable definitions.
+
 openhpc_tests_rootdir: /home/ohcp-tests
 openhpc_tests_hpl_NB: 192
 openhpc_slurm_login: "{{ groups['login'][0] }}"

environments/common/inventory/group_vars/all/openondemand.yml

@@ -1,6 +1,9 @@
 ---
-## TODO: maybe we should arrange it following the osc.github.io docs
-## NB: Variables prefixed ood_ are all from https://github.com/OSC/ood-ansible
+
+# See: ansible/roles/openondemand/README.md 
+# for variable definitions.
+
+# NB: Variables prefixed ood_ are all from https://github.com/OSC/ood-ansible
 
 openondemand_servername: '' # Must be changed when using openondemand, but allows templating when openondemand group is empty
 

environments/common/inventory/group_vars/all/podman.yml

@@ -1,2 +1,2 @@
-podman_users: "{{ appliances_local_users_podman }}"
-podman_cidr: 10.0.2.0/24 # see slirp4netns:cidr= at https://docs.podman.io/en/latest/markdown/podman-run.1.html
+podman_users: "{{ appliances_local_users_podman }}" # user to use for podman
+podman_cidr: 10.0.2.0/24 # IP range to use for podman - see slirp4netns:cidr= at https://docs.podman.io/en/latest/markdown/podman-run.1.html

environments/common/inventory/group_vars/all/prometheus.yml

@@ -1,4 +1,5 @@
 ---
+
 # See: https://github.com/cloudalchemy/ansible-prometheus
 # for variable definitions
 

environments/common/inventory/group_vars/all/selinux.yml

@@ -1,3 +1,4 @@
 ---
+
 selinux_state: permissive
 selinux_policy: targeted

environments/common/inventory/group_vars/all/update.yml

@@ -1,3 +1,5 @@
+---
+
 update_enable: false
 # These variables define the packages updates and are passed to ansible's yum module parameters with the same names: https://docs.ansible.com/ansible/latest/collections/ansible/builtin/yum_module.html
 update_name: '*'