Skip to content

Commit e986538

Browse files
update
1 parent 3390cf3 commit e986538

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/developer/cli-arguments.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ kube-state-metrics can be configured through command line arguments.
44

55
Those arguments can be passed during startup when running locally:
66

7-
`kube-state-metrics --telemetry-port=8081 --kubeconfig=<KUBE-CONFIG> --apiserver=<APISERVER> ...`
7+
`kube-state-metrics --telemetry-port=8081 --kubeconfig=<KUBE-CONFIG> --apiserver=<APISERVER> ...`
88

99
Or configured in the `args` section of your deployment configuration in a Kubernetes / Openshift context:
1010

@@ -24,6 +24,7 @@ spec:
2424
<!-- markdownlint-disable blanks-around-fences -->
2525
<!-- markdownlint-disable link-image-reference-definitions -->
2626
[embedmd]:# (../../help.txt)
27+
2728
```txt
2829
$ kube-state-metrics -h
2930
kube-state-metrics is a simple service that listens to the Kubernetes API server and generates metrics about the state of the objects.
@@ -45,8 +46,10 @@ Flags:
4546
--auto-gomemlimit Automatically set GOMEMLIMIT to match container or system memory limit. (experimental)
4647
--auto-gomemlimit-ratio float The ratio of reserved GOMEMLIMIT memory to the detected maximum container or system memory. (experimental) (default 0.9)
4748
--config string Path to the kube-state-metrics options config file
49+
--continue-without-config If true, kube-state-metrics continues to run even if the config file specified by --config is not present. This is useful for scenarios where config file is not provided at startup but is provided later, for e.g., via configmap. Kube-state-metrics will not exit with an error if the config file is not found, instead watches and reloads when it is created.
4850
--custom-resource-state-config string Inline Custom Resource State Metrics config YAML (experimental)
4951
--custom-resource-state-config-file string Path to a Custom Resource State Metrics config file (experimental)
52+
--continue-without-custom-resource-state-config-file If true, Kube-state-metrics continues to run even if the config file specified by --custom-resource-state-config-file is not present. This is useful for scenarios where config file is not provided at startup but is provided later, for e.g., via configmap. Kube-state-metrics will not exit with an error if the custom-resource-state-config file is not found, instead watches and reloads when it is created.
5053
--custom-resource-state-only Only provide Custom Resource State metrics (experimental)
5154
--enable-gzip-encoding Gzip responses when requested by clients via 'Accept-Encoding: gzip' header.
5255
-h, --help Print Help text
@@ -90,5 +93,6 @@ Flags:
9093

9194
Use "kube-state-metrics [command] --help" for more information about a command.
9295
```
96+
9397
<!-- markdownlint-enable link-image-reference-definitions -->
9498
<!-- markdownlint-enable blanks-around-fences -->

0 commit comments

Comments
 (0)