Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve archive log docs as to why it's not recommended #12597

Merged
merged 7 commits into from
Feb 21, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved

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?
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved

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.
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
* Use [links](links.md) to connect from the Argo Workflows user interface to your logging facility
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
* 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}`
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved

There is no intention to substantially improve the logging facilities provided by Argo Workflows, this is considered best implemented in a separate product.
agilgur5 marked this conversation as resolved.
Show resolved Hide resolved
Loading