From d893fa6f41823c8b71b8ba579ae0e2d62a74e679 Mon Sep 17 00:00:00 2001 From: Alan Clucas Date: Wed, 31 Jan 2024 13:10:35 +0000 Subject: [PATCH] docs: Improve archive log docs as to why it's not recommended And document how to make life easier with links. Signed-off-by: Alan Clucas --- docs/configure-archive-logs.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/configure-archive-logs.md b/docs/configure-archive-logs.md index 023f66366c4b..6dee4384681a 100644 --- a/docs/configure-archive-logs.md +++ b/docs/configure-archive-logs.md @@ -1,6 +1,7 @@ # Configuring Archive Logs -⚠️ We do not recommend you rely on Argo Workflows to archive logs. Instead, use a conventional Kubernetes logging facility. +!!! Warning "Not recommended" + We [do not recommend](#why-doesnt-argo-workflows-recommend-using-this-feature) you rely on Argo Workflows to archive logs. Instead, use a dedicated Kubernetes capable logging facility. To enable automatic pipeline logging, you need to configure `archiveLogs` at workflow-controller config-map, workflow spec, or template level. You also need to configure [Artifact Repository](configure-artifact-repository.md) to define where this logging artifact is stored. @@ -59,3 +60,14 @@ spec: archiveLocation: archiveLogs: true ``` + +## Why doesn't Argo Workflows recommend using this feature? + +Argo Workflows log storage facilities are quite basic. It is recommended that you use a combination of: + +* A fully featured Kubernetes capable logging facility which will provide you with facilities for indexing, searching and managing of log storage. +* Use [links](links.md) to connect from the Argo Workflows user interface to your logging facility + * Use the `scope: workflow` link to get all the logs for a workflow, using the workflow name in the link `${metadata.name}` and the namespace `${metadata.namespace}` + * Use `scope: pod-logs` for those from a specific pod of name `${metadata.name}` + +There is no intention to substantially improve the logging facilities provided by Argo Workflows, this is considered best implemented in a separate product.