Merge pull request #887 from jpodivin/docs/runnervars

Documenting ansibleEE runner vars

api/v1beta1/openstackdataplanenodeset_types.go

@@ -49,6 +49,7 @@ type OpenStackDataPlaneNodeSetSpec struct {
 	Nodes map[string]NodeSection `json:"nodes"`
 
 	// Env is a list containing the environment variables to pass to the pod
+	// Variables modifying behavior of AnsibleEE can be specified here.
 	// +kubebuilder:validation:Optional
 	Env []corev1.EnvVar `json:"env,omitempty"`
 

docs/assemblies/ansible.adoc

@@ -1,3 +1,13 @@
+= AnsibleEE runner variables
+
+Number of variables can be used to modify behavior of the AnsibleEE runner
+executing given job, such as timeouts and caching.
+These are expanded in the `env/settings` link:https://github.com/openstack-k8s-operators/edpm-ansible/blob/main/openstack_ansibleee/settings[file].
+And further documented in Ansible Runner link:https://ansible.readthedocs.io/projects/runner/en/stable/intro/#env-settings-settings-for-runner-itself[docs].
+
+All of these variables are left set to sensible defaults, nevertheless, some changes may be necessary,
+depending on particulars of individual deployments.
+
 = Ansible variables
 
 The list of ansible variables that can be set under `ansibleVars` is extensive.

docs/assemblies/custom_resources.adoc

@@ -480,7 +480,7 @@ OpenStackDataPlaneNodeSetSpec defines the desired state of OpenStackDataPlaneNod
 | true
 
 | env
-| Env is a list containing the environment variables to pass to the pod
+| Env is a list containing the environment variables to pass to the pod Variables modifying behavior of AnsibleEE can be specified here.
 | []corev1.EnvVar
 | false