docs: document plugin prefixed env vars #9548
Merged
Conversation
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
Signed-off-by: Michael Crenshaw <michael@crenshaw.dev>
crenshaw-dev
added
the
cherry-pick/2.4
Signed-off-by: Michael Crenshaw <michael@crenshaw.dev>
crenshaw-dev
commented
May 31, 2022
Comment on lines
-70
to
-71
| allowConcurrency: true | ||
| lockRepo: false |
There was a problem hiding this comment.
These are not actually applicable to sidecar plugins.
…v/argo-cd into plugin-env-vars-docs Signed-off-by: Michael Crenshaw <michael@crenshaw.dev>
Signed-off-by: Michael Crenshaw <michael@crenshaw.dev>
Codecov Report
@@ Coverage Diff @@
## master #9548 +/- ##
=======================================
Coverage 45.77% 45.77%
=======================================
Files 222 222
Lines 26372 26372
=======================================
Hits 12072 12072
Misses 12651 12651
Partials 1649 1649 Continue to review full report at Codecov.
|
leoluz
reviewed
Jun 2, 2022
| Starting in 2.4, sidecar plugins will not receive environment variables from the main repo-server container. Make sure | ||
| that any environment variables necessary for the sidecar plugin to function are set on the sidecar plugin. | ||
|
|
||
| argocd-cm plugins will continue to receiver environment variables from the main repo-server container. |
leoluz
reviewed
Jun 2, 2022
| user-supplied environment variables (#3 above) with `ARGOCD_ENV_`. This prevents users from directly setting | ||
| potentially-sensitive environment variables. | ||
|
|
||
| If your plugin was written before 2.3 and depends on user-supplied environment variables, then you will need to update |
There was a problem hiding this comment.
just confirming.. before 2.3 or 2.4?
crenshaw-dev
added a commit
that referenced
this pull request
Jun 2, 2022
* docs: document plugin prefixed env vars Signed-off-by: Michael Crenshaw <michael@crenshaw.dev> * restructure, clarify env vars from main container behavior Signed-off-by: Michael Crenshaw <michael@crenshaw.dev> * grammer Signed-off-by: Michael Crenshaw <michael@crenshaw.dev> * grammer Signed-off-by: Michael Crenshaw <michael@crenshaw.dev> * no link - the cert is bad Signed-off-by: Michael Crenshaw <michael@crenshaw.dev> * fixes Signed-off-by: Michael Crenshaw <michael@crenshaw.dev>
|
Cherry-picked onto 2.4. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Given the positive response to this post and the consensus of the Argo CD maintainers, we should go forward with environment variable prefixing in 2.4.