kube-state-metrics icon indicating copy to clipboard operation
kube-state-metrics copied to clipboard

Improve UX for Config File syntax

Open mrueg opened this issue 2 years ago • 4 comments

What would you like to be added:

The config file syntax could be improved to provide a better UX.

Why is this needed: Currently resources and namespaces use the types ResourceSet (map[string]struct{}), which works on the CLI like this:

--resources=endpoints,services

in the config file, it needs to be:

resources: 
  endpoints: {}
  services: {}

which is rather not intuitive.

Describe the solution you'd like

Ideally the config would look similar to this:

resources: 
- endpoints
- services

Additional Context

The same UX improvement can be applied to MetricAllowlist, MetricDenylist, MetricOptInList, LabelsAllowList, AnnotationsAllowList.

mrueg avatar Nov 30 '22 00:11 mrueg

/triage accepted /assign @CatherineF-dev

logicalhan avatar Dec 01 '22 17:12 logicalhan

@mrueg @CatherineF-dev How about allowing folks to switch between YAML and JSON? We can add more decoders as well in the future.

Changing the unmarshalling behavior for specific flags will have to be followed-up by some documentation that specifies the format these should be in, diverging from the format that one would assume by looking at the types, which may lead to issues requesting the current behavior, or interchangeability between older and newer formats.

rexagod avatar Dec 01 '22 18:12 rexagod

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

  • Confirm that this issue is still relevant with /triage accepted (org members only)
  • Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

k8s-triage-robot avatar Jan 19 '24 14:01 k8s-triage-robot

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

This bot triages un-triaged issues 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 issue is closed

You can:

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

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

/lifecycle stale

k8s-triage-robot avatar Apr 18 '24 15:04 k8s-triage-robot

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

This bot triages un-triaged issues 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 issue is closed

You can:

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

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

/lifecycle rotten

k8s-triage-robot avatar May 18 '24 15:05 k8s-triage-robot

/remove-lifecycle rotten

mrueg avatar May 18 '24 17:05 mrueg

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

This bot triages issues 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 issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close not-planned

k8s-triage-robot avatar Jun 17 '24 17:06 k8s-triage-robot

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

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

This bot triages issues 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 issue is closed

You can:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot avatar Jun 17 '24 17:06 k8s-ci-robot