-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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: Add document for environment variables #5080
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9cfbb4e
docs: Add document for environment variables
terrytangyuan 0bf809a
Add note
terrytangyuan a32153c
Remove CLI section
terrytangyuan c40dbe3
Rephrase
terrytangyuan 0b55b56
Address comments
terrytangyuan e86a837
Remove pod gc env var
terrytangyuan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Environment Variables | ||
|
|
||
| This document outlines the set of environment variables that can be used to customize the behaviours at different levels. | ||
| These environment variables are typically added to test out experimental features and should not be needed by most users. | ||
| Note that these environment variables may be removed at any time. | ||
|
|
||
| ## Controller | ||
|
|
||
| | Name | Type | Description| | ||
| |----------|------|------------| | ||
| | `ALL_POD_CHANGES_SIGNIFICANT` | `bool` | Whether to consider all pod changes as significant during pod reconciliation. | | ||
| | `ALWAYS_OFFLOAD_NODE_STATUS` | `bool` | Whether to always offload the node status. | | ||
| | `ARCHIVED_WORKFLOW_GC_PERIOD` | `time.Duration` | The periodicity for GC of archived workflows. | | ||
| | `ARGO_TRACE` | `bool` | Whether to enable tracing statements in Argo components. | | ||
| | `DEFAULT_REQUEUE_TIME` | `time.Duration` | The requeue time for the rate limiter of the workflow queue. | | ||
| | `LEADER_ELECTION_IDENTITY` | `string` | The ID used for workflow controllers to elect a leader. | | ||
| | `MAX_OPERATION_TIME` | `time.Duration` | The maximum time a workflow operation is allowed to run for before requeuing the workflow onto the work queue. | | ||
| | `OFFLOAD_NODE_STATUS_TTL` | `time.Duration` | The TTL to delete the offloaded node status. Currently only used for testing. | | ||
| | `RECENTLY_STARTED_POD_DURATION` | `time.Duration` | The duration of a pod before the pod is considered to be recently started. | | ||
| | `RETRY_BACKOFF_DURATION` | `time.Duration` | The retry backoff duration when retrying API calls. | | ||
| | `RETRY_BACKOFF_FACTOR` | `float` | The retry backoff factor when retrying API calls. | | ||
| | `RETRY_BACKOFF_STEPS` | `int` | The retry backoff steps when retrying API calls. | | ||
| | `TRANSIENT_ERROR_PATTERN` | `string` | The regular expression that represents additional patterns for transient errors. | | ||
| | `WF_DEL_PROPAGATION_POLICY` | `string` | The deletion propogation policy for workflows. | | ||
| | `WORKFLOW_GC_PERIOD` | `time.Duration` | The periodicity for GC of workflows. | | ||
|
|
||
| ## Executor | ||
|
|
||
| | Name | Type | Description| | ||
| |----------|------|------------| | ||
| | `ARGO_CONTAINER_RUNTIME_EXECUTOR` | `string` | The name of the container runtime executor. | | ||
| | `ARGO_KUBELET_PORT` | `int` | The port to the Kubelet API. | | ||
| | `ARGO_KUBELET_INSECURE` | `bool` | Whether to disable the TLS verification. | | ||
| | `PNS_PRIVILEGED` | `bool` | Whether to always set privileged on for PNS when PNS executor is used. | | ||
| | `REMOVE_LOCAL_ART_PATH` | `bool` | Whether to remove local artifacts. | | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'm wrong about the text for this. I think we should not emphasize they are unsupported, more that they are typically added to test out experimental features and should not be needed by most users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds much better actually. I just pasted the exact sentence you said but feel free to modify further.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would actually explicitly say that these may be removed at any time