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.

Sign up for GitHub

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

Jump to bottom

docs: describe the config file format in the CLI docs #2473

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: describe the config file format in the CLI docs #2473

wants to merge 1 commit into from

Conversation

ringerc
Copy link

@ringerc ringerc commented Aug 14, 2024

What this PR does / why we need it:

Update the CLI documentation to provide some information on how to use the config file for more complex kube-state-metrics, instead of complex and very long command lines.

How does this change affect the cardinality of KSM:

No change. Documentation only.

@ringerc
docs: describe the config file format in the CLI docs
45fe400 
Provide some information on how to use the config file for more complex kube-state-metrics, instead of complex and very long command lines.
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Aug 14, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: ringerc / name: Craig Ringer (45fe400)

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 14, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @ringerc!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 14, 2024
@logicalhan
Copy link
Member

/assign @rexagod
/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 22, 2024
@ringerc
Copy link
Author

ringerc commented Sep 5, 2024

Yes I know I need to sign the CLA. My org is being painfully slow about assigning a CLA manager.

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 4, 2024
@ringerc
Copy link
Author

ringerc commented Dec 16, 2024 •
edited
Loading

I've been able to complete the CLA now @rexagod . It's unclear why it hasn't updated the status to accepted, as the CLA bot shows the CLA as accepted in its own UI now.

@ringerc
Copy link
Author

ringerc commented Dec 16, 2024

/easycla

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 16, 2024
rexagod
rexagod requested changes Dec 16, 2024
View reviewed changes
Copy link
Member

@rexagod rexagod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the changes!

docs/developer/cli-arguments.md

The above CLI options may also be set via a YAML-format config-file whose path is supplied as the `--config` argument on the CLI.

The option names are defined in [`type Options` in `pkg/options/options.go`](https://github.com/kubernetes/kube-state-metrics/blob/main/pkg/options/options.go#L42).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The option names are defined in [`type Options` in `pkg/options/options.go`](https://github.com/kubernetes/kube-state-metrics/blob/main/pkg/options/options.go#L42).
The option names are defined in [`options.go`](https://github.com/kubernetes/kube-state-metrics/blob/main/pkg/options/options.go#L42).

docs/developer/cli-arguments.md
- eks.amazonaws.com/nodegroup-image
```

### Using a config file with Kubernetes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't specific to KSM, but general knowledge to mount any configmap. Can we drop this?

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ringerc
Once this PR has been reviewed and has the lgtm label, please ask for approval from rexagod. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rexagod rexagod rexagod requested changes

@logicalhan logicalhan Awaiting requested review from logicalhan

@mrueg mrueg Awaiting requested review from mrueg

Assignees

@rexagod rexagod

Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ringerc @k8s-ci-robot @logicalhan @k8s-triage-robot @rexagod