Document log persistence

Signed-off-by: Fabricio Aguiar <[email protected]>
rebtoor · May 11, 2023 · a3f50d7 · a3f50d7
1 parent 0b0906a
commit a3f50d7
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/docs/logs.md b/docs/logs.md
@@ -0,0 +1,28 @@
+# Persistent logs
+
+For enabling persistent logging, you need to mount `/runner/artifacts` into a [persistent Volume](https://kubernetes.io/docs/concepts/storage/volumes/) through `extraMounts` field.
+
+#### Example:
+```yaml
+apiVersion: ansibleee.openstack.org/v1alpha1
+kind: OpenStackAnsibleEE
+metadata:
+  name: ansibleee-logs
+  namespace: openstack
+spec:
+  playbook: "test.yaml"
+  image: quay.io/openstack-k8s-operators/openstack-ansibleee-runner:latest
+  inventory: |
+          all:
+            hosts:
+              localhost
+  extraMounts:
+    - extraVolType: Logs
+      volumes:
+      - name: ansible-logs
+        persistentVolumeClaim:
+          claimName: openstack-ansible-logs
+      mounts:
+      - name: ansible-logs
+        mountPath: "/runner/artifacts"
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -28,6 +28,8 @@ nav:
   - Home: index.md
   - Custom Resources:
       - OpenStackAnsibleEE: openstack_ansibleee.md
+  - Config:
+    - Logs: logs.md
   - Contributing: contributing.md
 markdown_extensions:
   - toc: