Skip to content

Commit

Permalink
Merge pull request kubernetes#1784 from ikarlashov/fix_customresource…
Browse files Browse the repository at this point in the history
…state_doc

Fix custom resource metrics documentation
  • Loading branch information
k8s-ci-robot authored Jul 12, 2022
2 parents 3fc5dd3 + 9197bb2 commit fad76e4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/customresourcestate-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Two flags can be used:

If both flags are provided, the inline configuration will take precedence.

In addition to specifying one of `--custom-resource-state-config*` flags, you should also add the custom resource *Kind*s in plural form to the list of exposed resources in the `--resources` flag. If you don't specify `--resources`, then all known custom resources configured in `--custom-resource-state-config-*` and all available default kubernetes objects will be taken into account by kube-state-metrics.

```yaml
apiVersion: apps/v1
kind: Deployment
Expand All @@ -40,6 +42,7 @@ spec:
- name: active_count
help: "Count of active Foo"
...
- --resources=certificatesigningrequests,configmaps,cronjobs,daemonsets,deployments,endpoints,foos,horizontalpodautoscalers,ingresses,jobs,limitranges,mutatingwebhookconfigurations,namespaces,networkpolicies,nodes,persistentvolumeclaims,persistentvolumes,poddisruptionbudgets,pods,replicasets,replicationcontrollers,resourcequotas,secrets,services,statefulsets,storageclasses,validatingwebhookconfigurations,volumeattachments,verticalpodautoscalers
```
### Examples
Expand Down

0 comments on commit fad76e4

Please sign in to comment.