Skip to content

doc: Add a page to include all flag information in one place #3358

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

Open
JaydipGabani opened this issue Apr 18, 2024 · 8 comments · May be fixed by #3782
Open

doc: Add a page to include all flag information in one place #3358

JaydipGabani opened this issue Apr 18, 2024 · 8 comments · May be fixed by #3782
Assignees
Labels
good first issue Good for newcomers

Comments

@JaydipGabani
Copy link
Contributor

It may be helpful for users to get all the information about available flags, their catagory of use (audit, webhook, mutation) into one consolidated page.

Copy link

stale bot commented Jun 18, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jun 18, 2024
@stale stale bot closed this as completed Jul 2, 2024
@ritazh ritazh reopened this Jul 2, 2024
@JaydipGabani JaydipGabani self-assigned this Jul 2, 2024
@stale stale bot removed the stale label Jul 2, 2024
Copy link

stale bot commented Aug 31, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Aug 31, 2024
@JaydipGabani JaydipGabani removed the stale label Sep 4, 2024
Copy link

stale bot commented Nov 4, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Nov 4, 2024
@ritazh ritazh removed the stale label Nov 4, 2024
Copy link

stale bot commented Jan 3, 2025

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 3, 2025
@JaydipGabani JaydipGabani removed the stale label Jan 6, 2025
@ianstanton
Copy link
Contributor

@JaydipGabani Could you share more about the scope / audience of this doc? For example, is it for users or developers (or both)? I ask because I found a handful of flags that aren't exposed as chart values and are not applied to the underlying deployments:

--log-level-key
--log-level-encoder
--metrics-addr
--host
--cert-dir
--enable-pprof
--pprof-port
--cert-service-name
--api-cache-dir
--debug-use-fake-pod
--otlp-endpoint
--otlp-metric-interval
--stackdriver-only-when-available
--stackdriver-metric-interval
--readiness-retries
--disable-enforcementaction-validation
--client-ca-name
--client-cn-name

@JaydipGabani JaydipGabani added the good first issue Good for newcomers label Jan 15, 2025
@JaydipGabani
Copy link
Contributor Author

@ianstanton I think this is for both. I recall someone not being able to find information about a flag and incompatible behavior because it was hidden in documentation as warning for two imcompatible flags. As oppose to that, if all the flags are in one place then it might be useful to get the information on what the flag does easily. And then if users want to know more, they can read through respective feature documentation.

@ianstanton
Copy link
Contributor

ianstanton commented Jan 16, 2025

@JaydipGabani Cool, thanks for clarifying! So any flag could be passed when running the binary, but I think we should also add those missing flags I mentioned in #3358 (comment) to the chart as part of this unless there's a reason they're not exposed.

My thought is users should be able to set any available flag via the helm chart as well, and it doesn't look like they can at the moment. We could add the missing flags as individual helm values, or add a extraArgs section where they could be passed in and applied to their respective deployments. WDYT?

I can keep this simple for now and add a docs page with a table for each flag.

Copy link

stale bot commented Mar 18, 2025

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants