-
Notifications
You must be signed in to change notification settings - Fork 5.6k
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: added environment variables documentation #8680
docs: added environment variables documentation #8680
Conversation
24513a0
to
cf78b2d
Compare
Signed-off-by: Hari Sekhon <[email protected]>
Signed-off-by: Hari Sekhon <[email protected]>
cf78b2d
to
aa038fc
Compare
Signed-off-by: Hari Sekhon <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #8680 +/- ##
=======================================
Coverage 45.90% 45.90%
=======================================
Files 222 222
Lines 26461 26461
=======================================
Hits 12146 12146
Misses 12658 12658
Partials 1657 1657
Continue to review full report at Codecov.
|
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.
Thanks for the contribution, and apologies for the slow review! Added one nitpick.
this is ready, no? is there any way to passing the username or password via env? |
@lucasff you got me curious, so I've just grep'd the entire ArgoCD codebase for tokens using a new script I just rustled up: This has led to me finding some new environment variables:
and some other interesting bits:
among other environment variables too many to list here. This is also:
but that looks like something only for tests and not what you want, so @lucasff think you'll have to stick with Since I don't have a thorough experience with all the environment variables, I'd rather limit this PR to the ones I know and merge this so users can actually find it in the current documentation. |
@HariSekhon yeah documenting the env vars is tricky, because where they get used depends a lot on context. Many of these are specific to running the CLI to start an api server or controller or repo server. This is a good start, 'cause it's focused on env vars that generically make sense for all CLI operations. |
Cherry-picked onto 2.4 (I'm trying to be more aggressive about cherry-picking docs-only PRs - they're useful and virtually zero risk.) |
* added environment variables page Signed-off-by: Hari Sekhon <[email protected]> * added Environment Variables page to User Guide Signed-off-by: Hari Sekhon <[email protected]> * reformatted table cells as multiline for clarity Signed-off-by: Hari Sekhon <[email protected]> * fixed typo Co-authored-by: Michael Crenshaw <[email protected]> Signed-off-by: Michael Crenshaw <[email protected]>
@HariSekhon thanks a lot for doing that! I ended up using manually assigned env vars to run |
@lucasff you're welcome. Btw if it's public, please post a link as I'm always interested in seeing how other people solve CI/CD as I do a lot of this work myself too, and have a couple repos you might find interesting for Jenkins and GitHub-Actions as well. |
I'd like an environment variables documentation reference page.
It's the sort of thing I use a lot in other projects documentation so I've created one.
I've added a documentation page on some useful environment variables that I add a lot as I've pieced these together over time from other pages, this is slightly different to the build environment page, but feel free to incorporate or restructure this as you see fit.
Note on DCO:
If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the Details link next to the DCO action for instructions on how to resolve this.
Checklist: