Merge pull request #636 from jpodivin/pod-issues-docs

Documentation pod status reporting

controllers/openstackdataplanenodeset_controller.go

@@ -466,7 +466,7 @@ func (r *OpenStackDataPlaneNodeSetReconciler) SetupWithManager(ctx context.Conte
 			for _, pod := range podsList.Items {
 				Log.Info(
 					fmt.Sprintf(
-						"openstack dataplane pod %s failed due to %s message: %s",
+						"openstackansibleee job %s failed due to %s with message: %s",
 						pod.Name, pod.Status.Reason, pod.Status.Message))
 			}
 		}

docs/assemblies/proc_troubleshooting-data-plane-creation-and-deployment.adoc

@@ -70,3 +70,13 @@ AnsibleEE jobs have an associated condition message that indicates the current s
 * `AnsibleExecutionJob error occured <error_message>`: The job stopped executed unexpectedly. The `<error_message>` is replaced with a specific error message.
 
 To further investigate a service displaying a particular job condition message, use the command `oc logs job/<service>` to display the logs associated with that service. For example, to display the logs for the `repo-setup-openstack-edpm` service, use the command `oc logs job/repo-setup-openstack-edpm`. 
+
+
+.Check service pod status reports
+
+During reconciliation of OpenStackDataPlaneDeployment resources, Kubernetes Pods associated with OpenStackAnsibleEE jobs are marked with label `osdpd=<OpenStackDataPlaneDeployment.Name>`.
+This allows selection and monitoring of these pods using CLI commands.
+
+When encountering failures within OpenStackAnsibleEE jobs, the resulting Kubernetes Pod reports will be formatted with an error message in the following manner: `openstackansibleee job <POD_NAME> failed due to <ERROR> with message: <ERROR_MSG>`.
+
+These reports can provide valuable insights into the cause of the failure and aid in resolving related issues.