Skip to content

Commit 792fc22

Browse files
committed
change underscores to dashes to match the command line argument
1 parent d04fce0 commit 792fc22

22 files changed

+60
-60
lines changed

cluster/addons/dns/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ of this yourself. First, each kubelet needs to run with the following flags
8989
set:
9090

9191
```
92-
--cluster_dns=<DNS service ip>
93-
--cluster_domain=<default local domain>
92+
--cluster-dns=<DNS service ip>
93+
--cluster-domain=<default local domain>
9494
```
9595

9696
Second, you need to start the DNS server ReplicationController and Service. See

cmd/kubelet/app/server.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -201,20 +201,20 @@ func (s *KubeletServer) AddFlags(fs *pflag.FlagSet) {
201201
fs.UintVar(&s.ReadOnlyPort, "read-only-port", s.ReadOnlyPort, "The read-only port for the Kubelet to serve on (set to 0 to disable)")
202202
fs.StringVar(&s.TLSCertFile, "tls-cert-file", s.TLSCertFile, ""+
203203
"File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). "+
204-
"If --tls_cert_file and --tls_private_key_file are not provided, a self-signed certificate and key "+
205-
"are generated for the public address and saved to the directory passed to --cert_dir.")
206-
fs.StringVar(&s.TLSPrivateKeyFile, "tls-private-key-file", s.TLSPrivateKeyFile, "File containing x509 private key matching --tls_cert_file.")
204+
"If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key "+
205+
"are generated for the public address and saved to the directory passed to --cert-dir.")
206+
fs.StringVar(&s.TLSPrivateKeyFile, "tls-private-key-file", s.TLSPrivateKeyFile, "File containing x509 private key matching --tls-cert-file.")
207207
fs.StringVar(&s.CertDirectory, "cert-dir", s.CertDirectory, "The directory where the TLS certs are located (by default /var/run/kubernetes). "+
208-
"If --tls_cert_file and --tls_private_key_file are provided, this flag will be ignored.")
208+
"If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.")
209209
fs.StringVar(&s.HostnameOverride, "hostname-override", s.HostnameOverride, "If non-empty, will use this string as identification instead of the actual hostname.")
210210
fs.StringVar(&s.PodInfraContainerImage, "pod-infra-container-image", s.PodInfraContainerImage, "The image whose network/ipc namespaces containers in each pod will use.")
211211
fs.StringVar(&s.DockerEndpoint, "docker-endpoint", s.DockerEndpoint, "If non-empty, use this for the docker endpoint to communicate with")
212212
fs.StringVar(&s.RootDirectory, "root-dir", s.RootDirectory, "Directory path for managing kubelet files (volume mounts,etc).")
213213
fs.BoolVar(&s.AllowPrivileged, "allow-privileged", s.AllowPrivileged, "If true, allow containers to request privileged mode. [default=false]")
214214
fs.StringVar(&s.HostNetworkSources, "host-network-sources", s.HostNetworkSources, "Comma-separated list of sources from which the Kubelet allows pods to use of host network. For all sources use \"*\" [default=\"file\"]")
215215
fs.Float64Var(&s.RegistryPullQPS, "registry-qps", s.RegistryPullQPS, "If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=0.0]")
216-
fs.IntVar(&s.RegistryBurst, "registry-burst", s.RegistryBurst, "Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_qps. Only used if --registry_qps > 0")
217-
fs.BoolVar(&s.RunOnce, "runonce", s.RunOnce, "If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api_servers, and --enable-server")
216+
fs.IntVar(&s.RegistryBurst, "registry-burst", s.RegistryBurst, "Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_qps. Only used if --registry-qps > 0")
217+
fs.BoolVar(&s.RunOnce, "runonce", s.RunOnce, "If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api-servers, and --enable-server")
218218
fs.BoolVar(&s.EnableDebuggingHandlers, "enable-debugging-handlers", s.EnableDebuggingHandlers, "Enables server endpoints for log collection and local running of containers and commands")
219219
fs.DurationVar(&s.MinimumGCAge, "minimum-container-ttl-duration", s.MinimumGCAge, "Minimum age for a finished container before it is garbage collected. Examples: '300ms', '10s' or '2h45m'")
220220
fs.IntVar(&s.MaxPerPodContainerCount, "maximum-dead-containers-per-container", s.MaxPerPodContainerCount, "Maximum number of old instances of a container to retain per container. Each container takes up some disk space. Default: 2.")

contrib/init/systemd/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Notes
2929
-----
3030
It may seem reasonable to use --option=${OPTION} in the .service file instead of only putting the command line option in the environment file. However this results in the possibility of daemons being called with --option= if the environment file does not define a value. Whereas including the --option string inside the environment file means that nothing will be passed to the daemon. So the daemon default will be used for things unset by the environment files.
3131

32-
While some command line options to the daemons use the default when passed an empty option some cause the daemon to fail to launch. --allow_privileged= (without a value of true/false) will cause the kube-apiserver and kubelet to refuse to launch.
32+
While some command line options to the daemons use the default when passed an empty option some cause the daemon to fail to launch. --allow-privileged= (without a value of true/false) will cause the kube-apiserver and kubelet to refuse to launch.
3333

3434
It also may seem reasonable to just use $DAEMON_ARGS and string all of these into one line in the environment file. While that makes the .service file simple it makes the admin job more difficult to locate and make appropriate changes to the config. This is a tradeoff between having to update the .service file to add new options or having the config files easy for an admin to work with. I choose: "easy for admin most of the time".
3535

contrib/mesos/docs/ha.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Within the scheduler, compatibility is largely determined by comparing executor
5252
a hash is calculated from a subset of the executor-related command line parameters provided to the scheduler process.
5353
The command line parameters that affect the hash calculation are listed below.
5454

55-
- `--allow_privileged`
56-
- `--api_servers`
55+
- `--allow-privileged`
56+
- `--api-servers`
5757
- `--auth_path`
5858
- `--cluster_*`
5959
- `--executor_*`

contrib/recipes/docs/apiserver_hipache_registration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ First, create your kube-apiserver.service file (change necessary variables)
2626
ExecStart=/opt/bin/kube-apiserver \
2727
--address=0.0.0.0 \
2828
--port=8080 \
29-
--etcd_servers=http://10.1.10.10:4001
29+
--etcd-servers=http://10.1.10.10:4001
3030
ExecStartPost=/usr/bin/etcdctl -C 10.1.10.10:4001 set /frontend:172.20.1.20 '[ "kubernetes", "http://${DEFAULT_IPV4}:8080" ]'
3131
Restart=always
3232
RestartSec=10

docs/admin/admission-controllers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Yes.
159159
For Kubernetes 1.0, we strongly recommend running the following set of admission control plug-ins (order matters):
160160

161161
```
162-
--admission_control=NamespaceLifecycle,NamespaceExists,LimitRanger,SecurityContextDeny,ServiceAccount,ResourceQuota
162+
--admission-control=NamespaceLifecycle,NamespaceExists,LimitRanger,SecurityContextDeny,ServiceAccount,ResourceQuota
163163
```
164164

165165

docs/admin/authentication.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ Documentation for other releases can be found at
3535

3636
Kubernetes uses client certificates, tokens, or http basic auth to authenticate users for API calls.
3737

38-
**Client certificate authentication** is enabled by passing the `--client_ca_file=SOMEFILE`
38+
**Client certificate authentication** is enabled by passing the `--client-ca-file=SOMEFILE`
3939
option to apiserver. The referenced file must contain one or more certificates authorities
4040
to use to validate client certificates presented to the apiserver. If a client certificate
4141
is presented and verified, the common name of the subject is used as the user name for the
4242
request.
4343

44-
**Token authentication** is enabled by passing the `--token_auth_file=SOMEFILE` option
44+
**Token authentication** is enabled by passing the `--token-auth-file=SOMEFILE` option
4545
to apiserver. Currently, tokens last indefinitely, and the token list cannot
4646
be changed without restarting apiserver. We plan in the future for tokens to
4747
be short-lived, and to be generated as needed rather than stored in a file.
@@ -52,7 +52,7 @@ and is a csv file with 3 columns: token, user name, user uid.
5252
When using token authentication from an http client the apiserver expects an `Authorization`
5353
header with a value of `Bearer SOMETOKEN`.
5454

55-
**Basic authentication** is enabled by passing the `--basic_auth_file=SOMEFILE`
55+
**Basic authentication** is enabled by passing the `--basic-auth-file=SOMEFILE`
5656
option to apiserver. Currently, the basic auth credentials last indefinitely,
5757
and the password cannot be changed without restarting apiserver. Note that basic
5858
authentication is currently supported for convenience while we finish making the

docs/admin/authorization.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ the request, (such as user, resource, and namespace) with access
4545
policies. An API call must be allowed by some policy in order to proceed.
4646

4747
The following implementations are available, and are selected by flag:
48-
- `--authorization_mode=AlwaysDeny`
49-
- `--authorization_mode=AlwaysAllow`
50-
- `--authorization_mode=ABAC`
48+
- `--authorization-mode=AlwaysDeny`
49+
- `--authorization-mode=AlwaysAllow`
50+
- `--authorization-mode=ABAC`
5151

5252
`AlwaysDeny` blocks all requests (used in tests).
5353
`AlwaysAllow` allows all requests; use if you don't need authorization.
@@ -72,13 +72,13 @@ to assist in policy management.
7272

7373
### Policy File Format
7474

75-
For mode `ABAC`, also specify `--authorization_policy_file=SOME_FILENAME`.
75+
For mode `ABAC`, also specify `--authorization-policy-file=SOME_FILENAME`.
7676

7777
The file format is [one JSON object per line](http://jsonlines.org/). There should be no enclosing list or map, just
7878
one map per line.
7979

8080
Each line is a "policy object". A policy object is a map with the following properties:
81-
- `user`, type string; the user-string from `--token_auth_file`
81+
- `user`, type string; the user-string from `--token-auth-file`
8282
- `readonly`, type boolean, when true, means that the policy only applies to GET
8383
operations.
8484
- `resource`, type string; a resource from an URL, such as `pods`.

docs/admin/kube-apiserver.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,12 @@ cluster's shared state through which all other components interact.
7373
-h, --help=false: help for kube-apiserver
7474
--insecure-bind-address=<nil>: The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost.
7575
--insecure-port=0: The port on which to serve unsecured, unauthenticated access. Default 8080. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup.
76-
--kubelet_certificate_authority="": Path to a cert. file for the certificate authority.
77-
--kubelet_client_certificate="": Path to a client key file for TLS.
78-
--kubelet_client_key="": Path to a client key file for TLS.
79-
--kubelet_https=false: Use https for kubelet connections
80-
--kubelet_port=0: Kubelet port
81-
--kubelet_timeout=0: Timeout for kubelet operations
76+
--kubelet-certificate-authority="": Path to a cert. file for the certificate authority.
77+
--kubelet-client-certificate="": Path to a client key file for TLS.
78+
--kubelet-client-key="": Path to a client key file for TLS.
79+
--kubelet-https=false: Use https for kubelet connections
80+
--kubelet-port=0: Kubelet port
81+
--kubelet-timeout=0: Timeout for kubelet operations
8282
--long-running-request-regexp="(/|^)((watch|proxy)(/|$)|(logs|portforward|exec)/?$)": A regular expression matching long running requests which should be excluded from maximum inflight request handling.
8383
--master-service-namespace="": The namespace from which the Kubernetes master services should be injected into pods
8484
--max-requests-inflight=400: The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit.

docs/admin/kube-controller-manager.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ controller, and serviceaccounts controller.
5858
--cluster-cidr=<nil>: CIDR Range for Pods in cluster.
5959
--cluster-name="": The instance prefix for the cluster
6060
--concurrent-endpoint-syncs=0: The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load
61-
--concurrent_rc_syncs=0: The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load
61+
--concurrent-rc-syncs=0: The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load
6262
--deleting-pods-burst=10: Number of nodes on which pods are bursty deleted in case of node failure. For more details look into RateLimiter.
6363
--deleting-pods-qps=0.1: Number of nodes per second on which pods are deleted in case of node failure.
6464
-h, --help=false: help for kube-controller-manager

docs/admin/kubelet.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,16 @@ HTTP server: The kubelet can also listen for HTTP and respond to a simple API
6464
--allow-privileged=false: If true, allow containers to request privileged mode. [default=false]
6565
--api-servers=[]: List of Kubernetes API servers for publishing events, and reading pods and services. (ip:port), comma separated.
6666
--cadvisor-port=0: The port of the localhost cAdvisor endpoint
67-
--cert-dir="": The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls_cert_file and --tls_private_key_file are provided, this flag will be ignored.
68-
--cgroup_root="": Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
67+
--cert-dir="": The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored.
68+
--cgroup-root="": Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default.
6969
--chaos-chance=0: If > 0.0, introduce random client errors and latency. Intended for testing. [default=0.0]
7070
--cloud-config="": The path to the cloud provider configuration file. Empty string for no configuration file.
7171
--cloud-provider="": The provider for cloud services. Empty string for no provider.
7272
--cluster-dns=<nil>: IP address for a cluster DNS server. If set, kubelet will configure all containers to use this for DNS resolution in addition to the host's DNS servers
7373
--cluster-domain="": Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains
7474
--config="": Path to the config file or directory of files
7575
--configure-cbr0=false: If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR.
76-
--container_runtime="": The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'.
76+
--container-runtime="": The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'.
7777
--containerized=false: Experimental support for running kubelet in a container. Intended for testing. [default=false]
7878
--docker-endpoint="": If non-empty, use this for the docker endpoint to communicate with
7979
--docker-exec-handler="": Handler to use when executing a command in a container. Valid values are 'native' and 'nsenter'. Defaults to 'native'.
@@ -105,16 +105,16 @@ HTTP server: The kubelet can also listen for HTTP and respond to a simple API
105105
--read-only-port=0: The read-only port for the Kubelet to serve on (set to 0 to disable)
106106
--really-crash-for-testing=false: If true, when panics occur crash. Intended for testing.
107107
--register-node=false: Register the node with the apiserver (defaults to true if --api-server is set)
108-
--registry-burst=0: Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_qps. Only used if --registry_qps > 0
108+
--registry-burst=0: Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_qps. Only used if --registry-qps > 0
109109
--registry-qps=0: If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=0.0]
110110
--resource-container="": Absolute name of the resource-only container to create and run the Kubelet in (Default: /kubelet).
111111
--root-dir="": Directory path for managing kubelet files (volume mounts,etc).
112-
--runonce=false: If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api_servers, and --enable-server
112+
--runonce=false: If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api-servers, and --enable-server
113113
--streaming-connection-idle-timeout=0: Maximum time a streaming connection can be idle before the connection is automatically closed. Example: '5m'
114114
--sync-frequency=0: Max period between synchronizing running containers and config
115115
--system-container="": Optional resource-only container in which to place all non-kernel processes that are not already in a container. Empty for no container. Rolling back the flag requires a reboot. (Default: "").
116-
--tls-cert-file="": File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If --tls_cert_file and --tls_private_key_file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert_dir.
117-
--tls-private-key-file="": File containing x509 private key matching --tls_cert_file.
116+
--tls-cert-file="": File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir.
117+
--tls-private-key-file="": File containing x509 private key matching --tls-cert-file.
118118
```
119119

120120
###### Auto generated by spf13/cobra at 2015-07-06 18:03:36.451093085 +0000 UTC

docs/admin/resource-quota.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Neither contention nor changes to quota will affect already-running pods.
6464
## Enabling Resource Quota
6565

6666
Resource Quota support is enabled by default for many Kubernetes distributions. It is
67-
enabled when the apiserver `--admission_control=` flag has `ResourceQuota` as
67+
enabled when the apiserver `--admission-control=` flag has `ResourceQuota` as
6868
one of its arguments.
6969

7070
Resource Quota is enforced in a particular namespace when there is a

docs/getting-started-guides/centos/centos_manual_config.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ echo "192.168.121.9 centos-master
104104

105105
```sh
106106
# Comma separated list of nodes in the etcd cluster
107-
KUBE_ETCD_SERVERS="--etcd_servers=http://centos-master:4001"
107+
KUBE_ETCD_SERVERS="--etcd-servers=http://centos-master:4001"
108108

109109
# logging to stderr means we get it in the systemd journal
110110
KUBE_LOGTOSTDERR="--logtostderr=true"
@@ -113,7 +113,7 @@ KUBE_LOGTOSTDERR="--logtostderr=true"
113113
KUBE_LOG_LEVEL="--v=0"
114114

115115
# Should this cluster be allowed to run privileged docker containers
116-
KUBE_ALLOW_PRIV="--allow_privileged=false"
116+
KUBE_ALLOW_PRIV="--allow-privileged=false"
117117
```
118118

119119
* Disable the firewall on both the master and node, as docker does not play well with other firewall rule managers
@@ -138,7 +138,7 @@ KUBE_API_PORT="--port=8080"
138138
KUBE_MASTER="--master=http://centos-master:8080"
139139

140140
# Port kubelets listen on
141-
KUBELET_PORT="--kubelet_port=10250"
141+
KUBELET_PORT="--kubelet-port=10250"
142142

143143
# Address range to use for services
144144
KUBE_SERVICE_ADDRESSES="--service-cluster-ip-range=10.254.0.0/16"
@@ -171,7 +171,7 @@ KUBELET_ADDRESS="--address=0.0.0.0"
171171
KUBELET_PORT="--port=10250"
172172

173173
# You may leave this blank to use the actual hostname
174-
KUBELET_HOSTNAME="--hostname_override=centos-minion"
174+
KUBELET_HOSTNAME="--hostname-override=centos-minion"
175175

176176
# Add your own!
177177
KUBELET_ARGS=""

0 commit comments

Comments
 (0)