Skip to content

Commit

Permalink
docs: Improve archive log docs as to why it's not recommended
Browse files Browse the repository at this point in the history
And document how to make life easier with links.

Signed-off-by: Alan Clucas <alan@clucas.org>
  • Loading branch information
Joibel committed Jan 31, 2024
1 parent 4226269 commit d893fa6
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/configure-archive-logs.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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.

0 comments on commit d893fa6

Please sign in to comment.