core: add ansible-runner comments

we rely on this exact behavior of ansible-runner, let's document it
oVirt · Jul 22, 2022 · 0655a85 · 0655a85
1 parent c91eb65
commit 0655a85
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/...les/bll/src/main/java/org/ovirt/engine/core/common/utils/ansible/AnsibleRunnerClient.java b/...les/bll/src/main/java/org/ovirt/engine/core/common/utils/ansible/AnsibleRunnerClient.java
@@ -260,12 +260,17 @@ public PlaybookStatus getPlaybookStatus(String playUuid) {
         String privateRunDir = String.format("%1$s/%2$s/", AnsibleConstants.ANSIBLE_RUNNER_PATH, playUuid);
         String playData = String.format("%1$s/%2$s/artifacts/%2$s/", AnsibleConstants.ANSIBLE_RUNNER_PATH, playUuid);
         try {
+            // regardless if we run sync or async playbook we launch ansible-runner the same way,
+            // "status" is created only once the playbook finishes
             if (Files.exists(Paths.get(String.format("%1$s/status", playData)))) {
                 status = Files.readString(Paths.get(String.format("%1$s/status", playData)));
                 rc = Files.readString(Paths.get(String.format("%1$s/rc", playData)));
+            // we call ansible-runner synchronously and "damon.log" is crated by the main process before
+            // going to background. So we can rely on its existence if ansible managed to start
             } else if (Files.exists(Paths.get(String.format("%1$s/daemon.log", privateRunDir)))) {
                 // artifacts are not yet present, try to fetch them in the next polling round
                 return new PlaybookStatus("", "running");
+            // ansible-runner didn't manage to start the background process so we know it failed right away
             } else {
                 log.warn(String.format("The playbook failed with unknow error at: %1$s", playData));
                 return new PlaybookStatus("", "failed");