diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md index b8999a39c76..c1cbc58b9a6 100644 --- a/docs/admin/federation-apiserver.md +++ b/docs/admin/federation-apiserver.md @@ -27,83 +27,9 @@ Documentation for other releases can be found at -## federation-apiserver - - - -### Synopsis - - -The Kubernetes federation API server validates and configures data -for the api objects which include pods, services, replicationcontrollers, and -others. The API Server services REST operations and provides the frontend to the -cluster's shared state through which all other components interact. - -``` -federation-apiserver -``` - -### Options - -``` - --admission-control="AlwaysAdmit": Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny - --admission-control-config-file="": File with admission control configuration. - --advertise-address=: The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used. - --apiserver-count=1: The number of apiservers running in the cluster - --authorization-mode="AlwaysAllow": Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC - --authorization-policy-file="": File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port. - --authorization-rbac-super-user="": If specified, a username which avoids RBAC authorization checks and role binding privilege escalation checks, to be used with --authorization-mode=RBAC. - --authorization-webhook-cache-authorized-ttl=5m0s: The duration to cache 'authorized' responses from the webhook authorizer. Default is 5m. - --authorization-webhook-cache-unauthorized-ttl=30s: The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. - --authorization-webhook-config-file="": File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port. - --basic-auth-file="": If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication. - --bind-address=0.0.0.0: The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). - --cert-dir="/var/run/kubernetes": 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. - --client-ca-file="": If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate. - --cloud-config="": The path to the cloud provider configuration file. Empty string for no configuration file. - --cloud-provider="": The provider for cloud services. Empty string for no provider. - --cors-allowed-origins=[]: List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. - --delete-collection-workers=1: Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. - --deserialization-cache-size=50000: Number of deserialized json objects to cache in memory. - --enable-swagger-ui[=false]: Enables swagger ui on the apiserver at /swagger-ui - --etcd-cafile="": SSL Certificate Authority file used to secure etcd communication - --etcd-certfile="": SSL certification file used to secure etcd communication - --etcd-keyfile="": SSL key file used to secure etcd communication - --etcd-prefix="/registry": The prefix for all resource paths in etcd. - --etcd-quorum-read[=false]: If true, enable quorum read - --etcd-servers=[]: List of etcd servers to connect with (http://ip:port), comma separated. - --etcd-servers-overrides=[]: Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. - --experimental-keystone-url="": If passed, activates the keystone authentication plugin - --external-hostname="": The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs.) - --insecure-bind-address=127.0.0.1: The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. - --insecure-port=8080: 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. - --kubernetes-service-node-port=0: If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP. - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --long-running-request-regexp="(/|^)((watch|proxy)(/|$)|(logs?|portforward|exec|attach)/?$)": A regular expression matching long running requests which should be excluded from maximum inflight request handling. - --master-service-namespace="default": The namespace from which the kubernetes master services should be injected into pods - --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. - --min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load. - --oidc-ca-file="": If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used - --oidc-client-id="": The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set - --oidc-groups-claim="": If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be an array of strings. This flag is experimental, please see the authentication documentation for further details. - --oidc-issuer-url="": The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT) - --oidc-username-claim="sub": The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. - --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ - --runtime-config=: A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively. - --secure-port=6443: The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. - --service-cluster-ip-range=: A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods. - --service-node-port-range=: A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. - --storage-backend="": The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. - --storage-media-type="application/json": The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. - --storage-versions="apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1alpha1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1": The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. - --tls-cert-file="": File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --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 /var/run/kubernetes. - --tls-private-key-file="": File containing x509 private key matching --tls-cert-file. - --token-auth-file="": If set, the file that will be used to secure the secure port of the API server via token authentication. - --watch-cache[=true]: Enable watch caching in the apiserver - --watch-cache-sizes=[]: List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. -``` - -###### Auto generated by spf13/cobra on 1-Jun-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md index 21e57342509..589df073ba2 100644 --- a/docs/admin/federation-controller-manager.md +++ b/docs/admin/federation-controller-manager.md @@ -27,46 +27,9 @@ Documentation for other releases can be found at -## federation-controller-manager - - - -### Synopsis - - -The federation controller manager is a daemon that embeds -the core control loops shipped with federation. In applications of robotics and -automation, a control loop is a non-terminating loop that regulates the state of -the system. In federation, a controller is a control loop that watches the shared -state of the federation cluster through the apiserver and makes changes attempting -to move the current state towards the desired state. Examples of controllers that -ship with federation today is the cluster controller. - -``` -federation-controller-manager -``` - -### Options - -``` - --address=0.0.0.0: The IP address to serve on (set to 0.0.0.0 for all interfaces) - --cluster-monitor-period=40s: The period for syncing ClusterStatus in ClusterController. - --concurrent-service-syncs=10: The number of service syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load - --federated-api-burst=30: Burst to use while talking with federation apiserver - --federated-api-qps=20: QPS to use while talking with federation apiserver - --kube-api-content-type="": ContentType of requests sent to apiserver. Passing application/vnd.kubernetes.protobuf is an experimental feature now. - --kubeconfig="": Path to kubeconfig file with authorization and master location information. - --leader-elect[=false]: Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. - --leader-elect-lease-duration=15s: The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. - --leader-elect-renew-deadline=10s: The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. - --leader-elect-retry-period=2s: The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --master="": The address of the federation API server (overrides any value in kubeconfig) - --port=10253: The port that the controller-manager's http service runs on - --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ -``` - -###### Auto generated by spf13/cobra on 29-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md index 91a5aa29424..8bc0ee4e75f 100644 --- a/docs/admin/kube-apiserver.md +++ b/docs/admin/kube-apiserver.md @@ -32,100 +32,9 @@ Documentation for other releases can be found at -## kube-apiserver - - - -### Synopsis - - -The Kubernetes API server validates and configures data -for the api objects which include pods, services, replicationcontrollers, and -others. The API Server services REST operations and provides the frontend to the -cluster's shared state through which all other components interact. - -``` -kube-apiserver -``` - -### Options - -``` - --admission-control="AlwaysAdmit": Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DenyEscalatingExec, DenyExecOnPrivileged, InitialResources, LimitPodHardAntiAffinityTopology, LimitRanger, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, PersistentVolumeLabel, PodSecurityPolicy, ResourceQuota, SecurityContextDeny, ServiceAccount - --admission-control-config-file="": File with admission control configuration. - --advertise-address=: The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used. - --allow-privileged[=false]: If true, allow privileged containers. - --apiserver-count=1: The number of apiservers running in the cluster - --authentication-token-webhook-cache-ttl=2m0s: The duration to cache responses from the webhook token authenticator. Default is 2m - --authentication-token-webhook-config-file="": File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens. - --authorization-mode="AlwaysAllow": Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC - --authorization-policy-file="": File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port. - --authorization-rbac-super-user="": If specified, a username which avoids RBAC authorization checks and role binding privilege escalation checks, to be used with --authorization-mode=RBAC. - --authorization-webhook-cache-authorized-ttl=5m0s: The duration to cache 'authorized' responses from the webhook authorizer. Default is 5m. - --authorization-webhook-cache-unauthorized-ttl=30s: The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. - --authorization-webhook-config-file="": File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port. - --basic-auth-file="": If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication. - --bind-address=0.0.0.0: The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). - --cert-dir="/var/run/kubernetes": 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. - --client-ca-file="": If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate. - --cloud-config="": The path to the cloud provider configuration file. Empty string for no configuration file. - --cloud-provider="": The provider for cloud services. Empty string for no provider. - --cors-allowed-origins=[]: List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. - --delete-collection-workers=1: Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. - --deserialization-cache-size=50000: Number of deserialized json objects to cache in memory. - --enable-garbage-collector[=false]: Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. - --enable-swagger-ui[=false]: Enables swagger ui on the apiserver at /swagger-ui - --etcd-cafile="": SSL Certificate Authority file used to secure etcd communication - --etcd-certfile="": SSL certification file used to secure etcd communication - --etcd-keyfile="": SSL key file used to secure etcd communication - --etcd-prefix="/registry": The prefix for all resource paths in etcd. - --etcd-quorum-read[=false]: If true, enable quorum read - --etcd-servers=[]: List of etcd servers to connect with (http://ip:port), comma separated. - --etcd-servers-overrides=[]: Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. - --event-ttl=1h0m0s: Amount of time to retain events. Default 1 hour. - --experimental-keystone-url="": If passed, activates the keystone authentication plugin - --external-hostname="": The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs.) - --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. - --insecure-bind-address=127.0.0.1: The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. - --insecure-port=8080: 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. - --kubelet-certificate-authority="": Path to a cert. file for the certificate authority. - --kubelet-client-certificate="": Path to a client cert file for TLS. - --kubelet-client-key="": Path to a client key file for TLS. - --kubelet-https[=true]: Use https for kubelet connections - --kubelet-timeout=5s: Timeout for kubelet operations - --kubernetes-service-node-port=0: If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP. - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --long-running-request-regexp="(/|^)((watch|proxy)(/|$)|(logs?|portforward|exec|attach)/?$)": A regular expression matching long running requests which should be excluded from maximum inflight request handling. - --master-service-namespace="default": The namespace from which the kubernetes master services should be injected into pods - --max-connection-bytes-per-sec=0: If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests - --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. - --min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load. - --oidc-ca-file="": If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used - --oidc-client-id="": The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set - --oidc-groups-claim="": If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be an array of strings. This flag is experimental, please see the authentication documentation for further details. - --oidc-issuer-url="": The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT) - --oidc-username-claim="sub": The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. - --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ - --repair-malformed-updates[=true]: If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates. - --runtime-config=: A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively. - --secure-port=6443: The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. - --service-account-key-file="": File containing PEM-encoded x509 RSA private or public key, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used. - --service-account-lookup[=false]: If true, validate ServiceAccount tokens exist in etcd as part of authentication. - --service-cluster-ip-range=: A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods. - --service-node-port-range=: A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. - --ssh-keyfile="": If non-empty, use secure SSH proxy to the nodes, using this user keyfile - --ssh-user="": If non-empty, use secure SSH proxy to the nodes, using this user name - --storage-backend="": The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. - --storage-media-type="application/json": The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. - --storage-versions="apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,componentconfig/v1alpha1,extensions/v1beta1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1": The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. - --tls-cert-file="": File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --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 /var/run/kubernetes. - --tls-private-key-file="": File containing x509 private key matching --tls-cert-file. - --token-auth-file="": If set, the file that will be used to secure the secure port of the API server via token authentication. - --watch-cache[=true]: Enable watch caching in the apiserver - --watch-cache-sizes=[]: List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. -``` - -###### Auto generated by spf13/cobra on 31-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md index 91e85a87740..9d41ae3a87e 100644 --- a/docs/admin/kube-controller-manager.md +++ b/docs/admin/kube-controller-manager.md @@ -32,90 +32,9 @@ Documentation for other releases can be found at -## kube-controller-manager - - - -### Synopsis - - -The Kubernetes controller manager is a daemon that embeds -the core control loops shipped with Kubernetes. In applications of robotics and -automation, a control loop is a non-terminating loop that regulates the state of -the system. In Kubernetes, a controller is a control loop that watches the shared -state of the cluster through the apiserver and makes changes attempting to move the -current state towards the desired state. Examples of controllers that ship with -Kubernetes today are the replication controller, endpoints controller, namespace -controller, and serviceaccounts controller. - -``` -kube-controller-manager -``` - -### Options - -``` - --address=0.0.0.0: The IP address to serve on (set to 0.0.0.0 for all interfaces) - --allocate-node-cidrs[=false]: Should CIDRs for Pods be allocated and set on the cloud provider. - --cloud-config="": The path to the cloud provider configuration file. Empty string for no configuration file. - --cloud-provider="": The provider for cloud services. Empty string for no provider. - --cluster-cidr="": CIDR Range for Pods in cluster. - --cluster-name="kubernetes": The instance prefix for the cluster - --concurrent-deployment-syncs=5: The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load - --concurrent-endpoint-syncs=5: The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load - --concurrent-namespace-syncs=2: The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load - --concurrent-replicaset-syncs=5: The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load - --concurrent-resource-quota-syncs=5: The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load - --concurrent_rc_syncs=5: The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load - --configure-cloud-routes[=true]: Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. - --controller-start-interval=0: Interval between starting controller managers. - --daemonset-lookup-cache-size=1024: The the size of lookup cache for daemonsets. Larger number = more responsive daemonsets, but more MEM load. - --deleting-pods-burst=10: Number of nodes on which pods are bursty deleted in case of node failure. For more details look into RateLimiter. - --deleting-pods-qps=0.1: Number of nodes per second on which pods are deleted in case of node failure. - --deployment-controller-sync-period=30s: Period for syncing the deployments. - --enable-garbage-collector[=false]: Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver. WARNING: the generic garbage collector is an alpha feature. - --enable-hostpath-provisioner[=false]: Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development. - --flex-volume-plugin-dir="/usr/libexec/kubernetes/kubelet-plugins/volume/exec/": Full path of the directory in which the flex volume plugin should search for additional third party volume plugins. - --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. - --horizontal-pod-autoscaler-sync-period=30s: The period for syncing the number of pods in horizontal pod autoscaler. - --kube-api-burst=30: Burst to use while talking with kubernetes apiserver - --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. - --kube-api-qps=20: QPS to use while talking with kubernetes apiserver - --kubeconfig="": Path to kubeconfig file with authorization and master location information. - --leader-elect[=false]: Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. - --leader-elect-lease-duration=15s: The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. - --leader-elect-renew-deadline=10s: The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. - --leader-elect-retry-period=2s: The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --master="": The address of the Kubernetes API server (overrides any value in kubeconfig) - --min-resync-period=12h0m0s: The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod - --namespace-sync-period=5m0s: The period for syncing namespace life-cycle updates - --node-cidr-mask-size=24: Mask size for node cidr in cluster. - --node-monitor-grace-period=40s: Amount of time which we allow running Node to be unresponsive before marking it unhealty. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status. - --node-monitor-period=5s: The period for syncing NodeStatus in NodeController. - --node-startup-grace-period=1m0s: Amount of time which we allow starting Node to be unresponsive before marking it unhealty. - --node-sync-period=10s: The period for syncing nodes from cloudprovider. Longer periods will result in fewer calls to cloud provider, but may delay addition of new nodes to cluster. - --pod-eviction-timeout=5m0s: The grace period for deleting pods on failed nodes. - --port=10252: The port that the controller-manager's http service runs on - --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ - --pv-recycler-increment-timeout-nfs=30: the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod - --pv-recycler-minimum-timeout-hostpath=60: The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster. - --pv-recycler-minimum-timeout-nfs=300: The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod - --pv-recycler-pod-template-filepath-hostpath="": The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster. - --pv-recycler-pod-template-filepath-nfs="": The file path to a pod definition used as a template for NFS persistent volume recycling - --pv-recycler-timeout-increment-hostpath=30: the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster. - --pvclaimbinder-sync-period=15s: The period for syncing persistent volumes and persistent volume claims - --replicaset-lookup-cache-size=4096: The the size of lookup cache for replicatsets. Larger number = more responsive replica management, but more MEM load. - --replication-controller-lookup-cache-size=4096: The the size of lookup cache for replication controllers. Larger number = more responsive replica management, but more MEM load. - --resource-quota-sync-period=5m0s: The period for syncing quota usage status in the system - --root-ca-file="": If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle. - --service-account-private-key-file="": Filename containing a PEM-encoded private RSA key used to sign service account tokens. - --service-cluster-ip-range="": CIDR Range for Services in cluster. - --service-sync-period=5m0s: The period for syncing services with their external load balancers - --terminated-pod-gc-threshold=12500: Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled. -``` - -###### Auto generated by spf13/cobra on 27-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md index 833cefc86f3..c524fa73549 100644 --- a/docs/admin/kube-proxy.md +++ b/docs/admin/kube-proxy.md @@ -32,54 +32,9 @@ Documentation for other releases can be found at -## kube-proxy - - - -### Synopsis - - -The Kubernetes network proxy runs on each node. This -reflects services as defined in the Kubernetes API on each node and can do simple -TCP,UDP stream forwarding or round robin TCP,UDP forwarding across a set of backends. -Service cluster ips and ports are currently found through Docker-links-compatible -environment variables specifying ports opened by the service proxy. There is an optional -addon that provides cluster DNS for these cluster IPs. The user must create a service -with the apiserver API to configure the proxy. - -``` -kube-proxy -``` - -### Options - -``` - --bind-address=0.0.0.0: The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces) - --cleanup-iptables[=false]: If true cleanup iptables rules and exit. - --cluster-cidr="": The CIDR range of pods in the cluster. It is used to bridge traffic coming from outside of the cluster. If not provided, no off-cluster bridging will be performed. - --config-sync-period=15m0s: How often configuration from the apiserver is refreshed. Must be greater than 0. - --conntrack-max=262144: Maximum number of NAT connections to track (0 to leave as-is) - --conntrack-tcp-timeout-established=24h0m0s: Idle timeout for established TCP connections (0 to leave as-is) - --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. - --healthz-bind-address=127.0.0.1: The IP address for the health check server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) - --healthz-port=10249: The port to bind the health check server. Use 0 to disable. - --hostname-override="": If non-empty, will use this string as identification instead of the actual hostname. - --iptables-masquerade-bit=14: If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31]. - --iptables-sync-period=30s: How often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. - --kube-api-burst=10: Burst to use while talking with kubernetes apiserver - --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. - --kube-api-qps=5: QPS to use while talking with kubernetes apiserver - --kubeconfig="": Path to kubeconfig file with authorization information (the master location is set by the master flag). - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --masquerade-all[=false]: If using the pure iptables proxy, SNAT everything - --master="": The address of the Kubernetes API server (overrides any value in kubeconfig) - --oom-score-adj=-999: The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000] - --proxy-mode=: Which proxy mode to use: 'userspace' (older) or 'iptables' (faster). If blank, look at the Node object on the Kubernetes API and respect the 'net.experimental.kubernetes.io/proxy-mode' annotation if provided. Otherwise use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy. - --proxy-port-range=: Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen. - --udp-timeout=250ms: How long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspace -``` - -###### Auto generated by spf13/cobra on 20-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md index ccfa085d450..26e50ba80b6 100644 --- a/docs/admin/kube-scheduler.md +++ b/docs/admin/kube-scheduler.md @@ -32,50 +32,9 @@ Documentation for other releases can be found at -## kube-scheduler - - - -### Synopsis - - -The Kubernetes scheduler is a policy-rich, topology-aware, -workload-specific function that significantly impacts availability, performance, -and capacity. The scheduler needs to take into account individual and collective -resource requirements, quality of service requirements, hardware/software/policy -constraints, affinity and anti-affinity specifications, data locality, inter-workload -interference, deadlines, and so on. Workload-specific requirements will be exposed -through the API as necessary. - -``` -kube-scheduler -``` - -### Options - -``` - --address="0.0.0.0": The IP address to serve on (set to 0.0.0.0 for all interfaces) - --algorithm-provider="DefaultProvider": The scheduling algorithm provider to use, one of: DefaultProvider - --failure-domains="kubernetes.io/hostname,failure-domain.beta.kubernetes.io/zone,failure-domain.beta.kubernetes.io/region": Indicate the "all topologies" set for an empty topologyKey when it's used for PreferredDuringScheduling pod anti-affinity. - --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. - --hard-pod-affinity-symmetric-weight=1: RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule. --hard-pod-affinity-symmetric-weight represents the weight of implicit PreferredDuringScheduling affinity rule. - --kube-api-burst=100: Burst to use while talking with kubernetes apiserver - --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. - --kube-api-qps=50: QPS to use while talking with kubernetes apiserver - --kubeconfig="": Path to kubeconfig file with authorization and master location information. - --leader-elect[=false]: Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. - --leader-elect-lease-duration=15s: The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. - --leader-elect-renew-deadline=10s: The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. - --leader-elect-retry-period=2s: The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --master="": The address of the Kubernetes API server (overrides any value in kubeconfig) - --policy-config-file="": File with scheduler policy configuration - --port=10251: The port that the scheduler's http service runs on - --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ - --scheduler-name="default-scheduler": Name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's annotation with key 'scheduler.alpha.kubernetes.io/name' -``` - -###### Auto generated by spf13/cobra on 20-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index 521d721402c..8caf644ebdf 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -32,138 +32,9 @@ Documentation for other releases can be found at -## kubelet - - - -### Synopsis - - -The kubelet is the primary "node agent" that runs on each -node. The kubelet works in terms of a PodSpec. A PodSpec is a YAML or JSON object -that describes a pod. The kubelet takes a set of PodSpecs that are provided through -various mechanisms (primarily through the apiserver) and ensures that the containers -described in those PodSpecs are running and healthy. - -Other than from an PodSpec from the apiserver, there are three ways that a container -manifest can be provided to the Kubelet. - -File: Path passed as a flag on the command line. This file is rechecked every 20 -seconds (configurable with a flag). - -HTTP endpoint: HTTP endpoint passed as a parameter on the command line. This endpoint -is checked every 20 seconds (also configurable with a flag). - -HTTP server: The kubelet can also listen for HTTP and respond to a simple API -(underspec'd currently) to submit a new manifest. - -``` -kubelet -``` - -### Options - -``` - --address=0.0.0.0: The IP address for the Kubelet to serve on (set to 0.0.0.0 for all interfaces) - --allow-privileged[=false]: If true, allow containers to request privileged mode. [default=false] - --api-servers=[]: List of Kubernetes API servers for publishing events, and reading pods and services. (ip:port), comma separated. - --cadvisor-port=4194: The port of the localhost cAdvisor endpoint - --cert-dir="/var/run/kubernetes": 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. - --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. - --chaos-chance=0: If > 0.0, introduce random client errors and latency. Intended for testing. [default=0.0] - --cloud-config="": The path to the cloud provider configuration file. Empty string for no configuration file. - --cloud-provider="": The provider for cloud services. Empty string for no provider. - --cluster-dns="": IP address for a cluster DNS server. This value is used for containers' DNS server in case of Pods with "dnsPolicy=ClusterFirst" - --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 - --config="": Path to the config file or directory of files - --configure-cbr0[=false]: If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR. - --container-runtime="docker": The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'. - --containerized[=false]: Experimental support for running kubelet in a container. Intended for testing. [default=false] - --cpu-cfs-quota[=true]: Enable CPU CFS quota enforcement for containers that specify CPU limits - --docker-endpoint="": If non-empty, use this for the docker endpoint to communicate with - --docker-exec-handler="native": Handler to use when executing a command in a container. Valid values are 'native' and 'nsenter'. Defaults to 'native'. - --enable-controller-attach-detach[=true]: Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations - --enable-custom-metrics[=false]: Support for gathering custom metrics. - --enable-debugging-handlers[=true]: Enables server endpoints for log collection and local running of containers and commands - --enable-server[=true]: Enable the Kubelet's server - --event-burst=10: Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0 - --event-qps=5: If > 0, limit event creations per second to this value. If 0, unlimited. - --eviction-hard="": A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. - --eviction-max-pod-grace-period=0: Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value. - --eviction-pressure-transition-period=5m0s: Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. - --eviction-soft="": A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction. - --eviction-soft-grace-period="": A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction. - --exit-on-lock-contention[=false]: Whether kubelet should exit upon lock-file contention. - --experimental-flannel-overlay[=false]: Experimental support for starting the kubelet with the default overlay network (flannel). Assumes flanneld is already running in client mode. [default=false] - --experimental-nvidia-gpus=0: Number of NVIDIA GPU devices on this node. Only 0 (default) and 1 are currently supported. - --file-check-frequency=20s: Duration between checking config files for new data - --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. - --hairpin-mode="promiscuous-bridge": How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none". - --healthz-bind-address=127.0.0.1: The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) - --healthz-port=10248: The port of the localhost healthz endpoint - --host-ipc-sources="*": Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace. [default="*"] - --host-network-sources="*": Comma-separated list of sources from which the Kubelet allows pods to use of host network. [default="*"] - --host-pid-sources="*": Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace. [default="*"] - --hostname-override="": If non-empty, will use this string as identification instead of the actual hostname. - --http-check-frequency=20s: Duration between checking http for new data - --image-gc-high-threshold=90: The percent of disk usage after which image garbage collection is always run. Default: 90% - --image-gc-low-threshold=80: The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80% - --kube-api-burst=10: Burst to use while talking with kubernetes apiserver - --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. - --kube-api-qps=5: QPS to use while talking with kubernetes apiserver - --kube-reserved=: A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently only cpu and memory are supported. See http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md for more detail. [default=none] - --kubeconfig="/var/lib/kubelet/kubeconfig": Path to a kubeconfig file, specifying how to authenticate to API server (the master location is set by the api-servers flag). - --kubelet-cgroups="": Optional absolute name of cgroups to create and run the Kubelet in. - --lock-file="": The path to file for kubelet to use as a lock file. - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --low-diskspace-threshold-mb=256: The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256 - --manifest-url="": URL for accessing the container manifest - --manifest-url-header="": HTTP header to use when accessing the manifest URL, with the key separated from the value with a ':', as in 'key:value' - --master-service-namespace="default": The namespace from which the kubernetes master services should be injected into pods - --max-open-files=1000000: Number of files that can be opened by Kubelet process. [default=1000000] - --max-pods=110: Number of Pods that can run on this Kubelet. - --maximum-dead-containers=240: Maximum number of old instances of containers to retain globally. Each container takes up some disk space. Default: 100. - --maximum-dead-containers-per-container=2: Maximum number of old instances to retain per container. Each container takes up some disk space. Default: 2. - --minimum-container-ttl-duration=1m0s: Minimum age for a finished container before it is garbage collected. Examples: '300ms', '10s' or '2h45m' - --minimum-image-ttl-duration=2m0s: Minimum age for a unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'. Default: '2m' - --network-plugin="": The name of the network plugin to be invoked for various events in kubelet/pod lifecycle - --network-plugin-dir="/usr/libexec/kubernetes/kubelet-plugins/net/exec/": The full path of the directory in which to search for network plugins - --node-ip="": IP address of the node. If set, kubelet will use this IP address for the node - --node-labels=: Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','. - --node-status-update-frequency=10s: Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s - --non-masquerade-cidr="10.0.0.0/8": Traffic to IPs outside this range will use IP masquerade. - --oom-score-adj=-999: The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000] - --outofdisk-transition-frequency=5m0s: Duration for which the kubelet has to wait before transitioning out of out-of-disk node condition status. Default: 5m0s - --pod-cidr="": The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master. - --pod-infra-container-image="gcr.io/google_containers/pause-amd64:3.0": The image whose network/ipc namespaces containers in each pod will use. - --pods-per-core=0: Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this caulcation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit. - --port=10250: The port for the Kubelet to serve on. - --read-only-port=10255: The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable) - --really-crash-for-testing[=false]: If true, when panics occur crash. Intended for testing. - --reconcile-cidr[=true]: Reconcile node CIDR with the CIDR specified by the API server. No-op if register-node or configure-cbr0 is false. [default=true] - --register-node[=true]: Register the node with the apiserver (defaults to true if --api-servers is set) - --register-schedulable[=true]: Register the node as schedulable. No-op if register-node is false. [default=true] - --registry-burst=10: 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 - --registry-qps=5: If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=5.0] - --resolv-conf="/etc/resolv.conf": Resolver configuration file used as the basis for the container DNS resolution configuration. - --rkt-api-endpoint="localhost:15441": The endpoint of the rkt API service to communicate with. Only used if --container-runtime='rkt'. - --rkt-path="": Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt'. - --root-dir="/var/lib/kubelet": Directory path for managing kubelet files (volume mounts,etc). - --runonce[=false]: If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api-servers, and --enable-server - --runtime-cgroups="": Optional absolute name of cgroups to create and run the runtime in. - --seccomp-profile-root="/var/lib/kubelet/seccomp": Directory path for seccomp profiles. - --serialize-image-pulls[=true]: Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details. [default=true] - --streaming-connection-idle-timeout=4h0m0s: Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m' - --sync-frequency=1m0s: Max period between synchronizing running containers and config - --system-cgroups="": Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under `/`. Empty for no container. Rolling back the flag requires a reboot. (Default: ""). - --system-reserved=: A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md for more detail. [default=none] - --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. - --tls-private-key-file="": File containing x509 private key matching --tls-cert-file. - --volume-plugin-dir="/usr/libexec/kubernetes/kubelet-plugins/volume/exec/": The full path of the directory in which to search for additional third party volume plugins - --volume-stats-agg-period=1m0s: Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0. Default: '1m' -``` - -###### Auto generated by spf13/cobra on 24-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-annotate.1 b/docs/man/man1/kubectl-annotate.1 index 1ca0389e829..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-annotate.1 +++ b/docs/man/man1/kubectl-annotate.1 @@ -1,231 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl annotate \- Update the annotations on a resource - - -.SH SYNOPSIS -.PP -\fBkubectl annotate\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Update the annotations on one or more resources. - -.PP -An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human\-readable, data. -It is intended to store non\-identifying auxiliary data, especially data manipulated by tools and system extensions. -If \-\-overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. -If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used. - -.PP -Possible resources include (case insensitive): - pod (po), service (svc), replicationcontroller (rc), - node (no), event (ev), componentstatuse (cs), - limitrange (limits), persistentvolume (pv), persistentvolumeclaim (pvc), - horizontalpodautoscaler (hpa), resourcequota (quota), secret - - -.SH OPTIONS -.PP -\fB\-\-all\fP=false - select all resources in the namespace of the specified resource types - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to update the annotation - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-overwrite\fP=false - If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-resource\-version\fP="" - If non\-empty, the annotation update will only succeed if this is the current resource\-version for the object. Only valid when specifying a single resource. - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Update pod 'foo' with the annotation 'description' and the value 'my frontend'. -# If the same annotation is set multiple times, only the last value will be applied -kubectl annotate pods foo description='my frontend' - -# Update a pod identified by type and name in "pod.json" -kubectl annotate \-f pod.json description='my frontend' - -# Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value. -kubectl annotate \-\-overwrite pods foo description='my frontend running nginx' - -# Update all pods in the namespace -kubectl annotate pods \-\-all description='my frontend running nginx' - -# Update pod 'foo' only if the resource is unchanged from version 1. -kubectl annotate pods foo description='my frontend running nginx' \-\-resource\-version=1 - -# Update pod 'foo' by removing an annotation named 'description' if it exists. -# Does not require the \-\-overwrite flag. -kubectl annotate pods foo description\- - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-api-versions.1 b/docs/man/man1/kubectl-api-versions.1 index 3e1b16336a5..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-api-versions.1 +++ b/docs/man/man1/kubectl-api-versions.1 @@ -1,124 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl api\-versions \- Print the supported API versions on the server, in the form of "group/version". - - -.SH SYNOPSIS -.PP -\fBkubectl api\-versions\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Print the supported API versions on the server, in the form of "group/version". - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-apply.1 b/docs/man/man1/kubectl-apply.1 index 4f868e62357..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-apply.1 +++ b/docs/man/man1/kubectl-apply.1 @@ -1,174 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl apply \- Apply a configuration to a resource by filename or stdin - - -.SH SYNOPSIS -.PP -\fBkubectl apply\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Apply a configuration to a resource by filename or stdin. -The resource will be created if it doesn't exist yet. -To use 'apply', always create the resource initially with either 'apply' or 'create \-\-save\-config'. - -.PP -JSON and YAML formats are accepted. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to file that contains the configuration to apply - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output mode. Use "\-o name" for shorter output (resource/name). - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Apply the configuration in pod.json to a pod. -kubectl apply \-f ./pod.json - -# Apply the JSON passed into stdin to a pod. -cat pod.json | kubectl apply \-f \- - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-attach.1 b/docs/man/man1/kubectl-attach.1 index 5d76ef54992..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-attach.1 +++ b/docs/man/man1/kubectl-attach.1 @@ -1,157 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl attach \- Attach to a running container. - - -.SH SYNOPSIS -.PP -\fBkubectl attach\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Attach to a process that is already running inside an existing container. - - -.SH OPTIONS -.PP -\fB\-c\fP, \fB\-\-container\fP="" - Container name. If omitted, the first container in the pod will be chosen - -.PP -\fB\-i\fP, \fB\-\-stdin\fP=false - Pass stdin to the container - -.PP -\fB\-t\fP, \fB\-\-tty\fP=false - Stdin is a TTY - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Get output from running pod 123456\-7890, using the first container by default -kubectl attach 123456\-7890 - -# Get output from ruby\-container from pod 123456\-7890 -kubectl attach 123456\-7890 \-c ruby\-container - -# Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-7890 -# and sends stdout/stderr from 'bash' back to the client -kubectl attach 123456\-7890 \-c ruby\-container \-i \-t - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-autoscale.1 b/docs/man/man1/kubectl-autoscale.1 index 4789f636e03..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-autoscale.1 +++ b/docs/man/man1/kubectl-autoscale.1 @@ -1,220 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl autoscale \- Auto\-scale a Deployment, ReplicaSet, or ReplicationController - - -.SH SYNOPSIS -.PP -\fBkubectl autoscale\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. - -.PP -Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. -An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. - - -.SH OPTIONS -.PP -\fB\-\-cpu\-percent\fP=\-1 - The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, the server will apply a default value. - -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to autoscale. - -.PP -\fB\-\-generator\fP="horizontalpodautoscaler/v1beta1" - The name of the API generator to use. Currently there is only 1 generator. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-max\fP=\-1 - The upper limit for the number of pods that can be set by the autoscaler. Required. - -.PP -\fB\-\-min\fP=\-1 - The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. - -.PP -\fB\-\-name\fP="" - The name for the newly created object. If not specified, the name of the input resource will be used. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Auto scale a deployment "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: -kubectl autoscale deployment foo \-\-min=2 \-\-max=10 - -# Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80%: -kubectl autoscale rc foo \-\-max=5 \-\-cpu\-percent=80 - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-cluster-info-dump.1 b/docs/man/man1/kubectl-cluster-info-dump.1 index 9d4111da139..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-cluster-info-dump.1 +++ b/docs/man/man1/kubectl-cluster-info-dump.1 @@ -1,166 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl cluster\-info dump \- Dump lots of relevant info for debugging and diagnosis. - - -.SH SYNOPSIS -.PP -\fBkubectl cluster\-info dump\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to -stdout. You can optionally specify a directory with \-\-output\-directory. If you specify a directory, kubernetes will -build a set of files in that directory. By default only dumps things in the 'kube\-system' namespace, but you can -switch to a different namespace with the \-\-namespaces flag, or specify \-\-all\-namespaces to dump all namespaces. - -.PP -The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories -based on namespace and pod name. - - -.SH OPTIONS -.PP -\fB\-\-all\-namespaces\fP=false - If true, dump all namespaces. If true, \-\-namespaces is ignored. - -.PP -\fB\-\-namespaces\fP=[] - A comma separated list of namespaces to dump. - -.PP -\fB\-\-output\-directory\fP="" - Where to output the files. If empty or '\-' uses stdout, otherwise creates a directory hierarchy in that directory - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Dump current cluster state to stdout -kubectl cluster\-info dump - -# Dump current cluster state to /path/to/cluster\-state -kubectl cluster\-info dump \-\-output\-directory=/path/to/cluster\-state - -# Dump all namespaces to stdout -kubectl cluster\-info dump \-\-all\-namespaces - -# Dump a set of namespaces to /path/to/cluster\-state -kubectl cluster\-info dump \-\-namespaces default,kube\-system \-\-output\-directory=/path/to/cluster\-state - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-cluster\-info(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-cluster-info.1 b/docs/man/man1/kubectl-cluster-info.1 index a67f5209b01..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-cluster-info.1 +++ b/docs/man/man1/kubectl-cluster-info.1 @@ -1,131 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl cluster\-info \- Display cluster info - - -.SH SYNOPSIS -.PP -\fBkubectl cluster\-info\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Display addresses of the master and services with label kubernetes.io/cluster\-service=true -To further debug and diagnose cluster problems, use 'kubectl cluster\-info dump'. - - -.SH OPTIONS -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, \fBkubectl\-cluster\-info\-dump(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-completion.1 b/docs/man/man1/kubectl-completion.1 index b047135cac6..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-completion.1 +++ b/docs/man/man1/kubectl-completion.1 @@ -1,152 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl completion \- Output shell completion code for the given shell (bash or zsh) - - -.SH SYNOPSIS -.PP -\fBkubectl completion\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Output shell completion code for the given shell (bash or zsh). - -.PP -This command prints shell code which must be evaluation to provide interactive -completion of kubectl commands. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - -$ source <(kubectl completion bash) - -will load the kubectl completion code for bash. Note that this depends on the bash\-completion -framework. It must be sourced before sourcing the kubectl completion, i.e. on the Mac: - -$ brew install bash\-completion -$ source $(brew \-\-prefix)/etc/bash\_completion -$ source <(kubectl completion bash) - -If you use zsh, the following will load kubectl zsh completion: - -$ source <(kubectl completion zsh) - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-current-context.1 b/docs/man/man1/kubectl-config-current-context.1 index 77ae5c5136b..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-current-context.1 +++ b/docs/man/man1/kubectl-config-current-context.1 @@ -1,136 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config current\-context \- Displays the current\-context - - -.SH SYNOPSIS -.PP -\fBkubectl config current\-context\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Displays the current\-context - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Display the current\-context -kubectl config current\-context - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-set-cluster.1 b/docs/man/man1/kubectl-config-set-cluster.1 index 3fb57189cb3..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-set-cluster.1 +++ b/docs/man/man1/kubectl-config-set-cluster.1 @@ -1,149 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config set\-cluster \- Sets a cluster entry in kubeconfig - - -.SH SYNOPSIS -.PP -\fBkubectl config set\-cluster\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. - - -.SH OPTIONS -.PP -\fB\-\-api\-version\fP="" - api\-version for the cluster entry in kubeconfig - -.PP -\fB\-\-certificate\-authority\fP="" - path to certificate\-authority file for the cluster entry in kubeconfig - -.PP -\fB\-\-embed\-certs\fP=false - embed\-certs for the cluster entry in kubeconfig - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - insecure\-skip\-tls\-verify for the cluster entry in kubeconfig - -.PP -\fB\-\-server\fP="" - server for the cluster entry in kubeconfig - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Set only the server field on the e2e cluster entry without touching other values. -kubectl config set\-cluster e2e \-\-server=https://1.2.3.4 - -# Embed certificate authority data for the e2e cluster entry -kubectl config set\-cluster e2e \-\-certificate\-authority=\~/.kube/e2e/kubernetes.ca.crt - -# Disable cert checking for the dev cluster entry -kubectl config set\-cluster e2e \-\-insecure\-skip\-tls\-verify=true - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-set-context.1 b/docs/man/man1/kubectl-config-set-context.1 index 6e5e6402df7..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-set-context.1 +++ b/docs/man/man1/kubectl-config-set-context.1 @@ -1,139 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config set\-context \- Sets a context entry in kubeconfig - - -.SH SYNOPSIS -.PP -\fBkubectl config set\-context\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. - - -.SH OPTIONS -.PP -\fB\-\-cluster\fP="" - cluster for the context entry in kubeconfig - -.PP -\fB\-\-namespace\fP="" - namespace for the context entry in kubeconfig - -.PP -\fB\-\-user\fP="" - user for the context entry in kubeconfig - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Set the user field on the gce context entry without touching other values -kubectl config set\-context gce \-\-user=cluster\-admin - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-set-credentials.1 b/docs/man/man1/kubectl-config-set-credentials.1 index 698da03700f..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-set-credentials.1 +++ b/docs/man/man1/kubectl-config-set-credentials.1 @@ -1,165 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config set\-credentials \- Sets a user entry in kubeconfig - - -.SH SYNOPSIS -.PP -\fBkubectl config set\-credentials\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. - -.PP -Client\-certificate flags: - \-\-client\-certificate=certfile \-\-client\-key=keyfile - -.PP -Bearer token flags: - \-\-token=bearer\_token - -.PP -Basic auth flags: - \-\-username=basic\_user \-\-password=basic\_password - -.PP -Bearer token and basic auth are mutually exclusive. - - -.SH OPTIONS -.PP -\fB\-\-client\-certificate\fP="" - path to client\-certificate file for the user entry in kubeconfig - -.PP -\fB\-\-client\-key\fP="" - path to client\-key file for the user entry in kubeconfig - -.PP -\fB\-\-embed\-certs\fP=false - embed client cert/key for the user entry in kubeconfig - -.PP -\fB\-\-password\fP="" - password for the user entry in kubeconfig - -.PP -\fB\-\-token\fP="" - token for the user entry in kubeconfig - -.PP -\fB\-\-username\fP="" - username for the user entry in kubeconfig - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Set only the "client\-key" field on the "cluster\-admin" -# entry, without touching other values: -kubectl config set\-credentials cluster\-admin \-\-client\-key=\~/.kube/admin.key - -# Set basic auth for the "cluster\-admin" entry -kubectl config set\-credentials cluster\-admin \-\-username=admin \-\-password=uXFGweU9l35qcif - -# Embed client certificate data in the "cluster\-admin" entry -kubectl config set\-credentials cluster\-admin \-\-client\-certificate=\~/.kube/admin.crt \-\-embed\-certs=true - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-set.1 b/docs/man/man1/kubectl-config-set.1 index 42d0e138dcc..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-set.1 +++ b/docs/man/man1/kubectl-config-set.1 @@ -1,132 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config set \- Sets an individual value in a kubeconfig file - - -.SH SYNOPSIS -.PP -\fBkubectl config set\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Sets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. -PROPERTY\_VALUE is the new value you wish to set. Binary fields such as 'certificate\-authority\-data' expect a base64 encoded string unless the \-\-set\-raw\-bytes flag is used. - - -.SH OPTIONS -.PP -\fB\-\-set\-raw\-bytes\fP=false - When writing a []byte PROPERTY\_VALUE, write the given string directly without base64 decoding. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-unset.1 b/docs/man/man1/kubectl-config-unset.1 index 2a73d2c496d..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-unset.1 +++ b/docs/man/man1/kubectl-config-unset.1 @@ -1,125 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config unset \- Unsets an individual value in a kubeconfig file - - -.SH SYNOPSIS -.PP -\fBkubectl config unset\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Unsets an individual value in a kubeconfig file -PROPERTY\_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-use-context.1 b/docs/man/man1/kubectl-config-use-context.1 index 3a23cdebe99..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-use-context.1 +++ b/docs/man/man1/kubectl-config-use-context.1 @@ -1,124 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config use\-context \- Sets the current\-context in a kubeconfig file - - -.SH SYNOPSIS -.PP -\fBkubectl config use\-context\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Sets the current\-context in a kubeconfig file - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config-view.1 b/docs/man/man1/kubectl-config-view.1 index 851cc9b3af0..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config-view.1 +++ b/docs/man/man1/kubectl-config-view.1 @@ -1,191 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config view \- Displays merged kubeconfig settings or a specified kubeconfig file. - - -.SH SYNOPSIS -.PP -\fBkubectl config view\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Displays merged kubeconfig settings or a specified kubeconfig file. - -.PP -You can use \-\-output jsonpath={...} to extract specific values using a jsonpath expression. - - -.SH OPTIONS -.PP -\fB\-\-flatten\fP=false - flatten the resulting kubeconfig file into self contained output (useful for creating portable kubeconfig files) - -.PP -\fB\-\-merge\fP=true - merge together the full hierarchy of kubeconfig files - -.PP -\fB\-\-minify\fP=false - remove all information not used by current\-context from the output - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-raw\fP=false - display raw byte data - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Show Merged kubeconfig settings. -kubectl config view - -# Get the password for the e2e user -kubectl config view \-o jsonpath='{.users[?(@.name == "e2e")].user.password}' - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-config(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-config.1 b/docs/man/man1/kubectl-config.1 index e15c9dc0c47..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-config.1 +++ b/docs/man/man1/kubectl-config.1 @@ -1,132 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl config \- config modifies kubeconfig files - - -.SH SYNOPSIS -.PP -\fBkubectl config\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -config modifies kubeconfig files using subcommands like "kubectl config set current\-context my\-context" - -.PP -The loading order follows these rules: -1. If the \-\-kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. -2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged together. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. -3. Otherwise, ${HOME}/.kube/config is used and no merging takes place. - - -.SH OPTIONS -.PP -\fB\-\-kubeconfig\fP="" - use a particular kubeconfig file - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, \fBkubectl\-config\-view(1)\fP, \fBkubectl\-config\-set\-cluster(1)\fP, \fBkubectl\-config\-set\-credentials(1)\fP, \fBkubectl\-config\-set\-context(1)\fP, \fBkubectl\-config\-set(1)\fP, \fBkubectl\-config\-unset(1)\fP, \fBkubectl\-config\-current\-context(1)\fP, \fBkubectl\-config\-use\-context(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-convert.1 b/docs/man/man1/kubectl-convert.1 index ed6a00de223..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-convert.1 +++ b/docs/man/man1/kubectl-convert.1 @@ -1,211 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl convert \- Convert config files between different API versions - - -.SH SYNOPSIS -.PP -\fBkubectl convert\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Convert config files between different API versions. Both YAML -and JSON formats are accepted. - -.PP -The command takes filename, directory, or URL as input, and convert it into format -of version specified by \-\-output\-version flag. If target version is not specified or -not supported, convert to latest version. - -.PP -The default output will be printed to stdout in YAML format. One can use \-o option -to change to output destination. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to file to need to get converted. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-local\fP=true - If true, convert will NOT try to contact api\-server but run locally. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Convert 'pod.yaml' to latest version and print to stdout. -kubectl convert \-f pod.yaml - -# Convert the live state of the resource specified by 'pod.yaml' to the latest version -# and print to stdout in json format. -kubectl convert \-f pod.yaml \-\-local \-o json - -# Convert all files under current directory to latest version and create them all. -kubectl convert \-f . | kubectl create \-f \- - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-cordon.1 b/docs/man/man1/kubectl-cordon.1 index f07b52515e3..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-cordon.1 +++ b/docs/man/man1/kubectl-cordon.1 @@ -1,137 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl cordon \- Mark node as unschedulable - - -.SH SYNOPSIS -.PP -\fBkubectl cordon\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Mark node as unschedulable. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Mark node "foo" as unschedulable. -kubectl cordon foo - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create-configmap.1 b/docs/man/man1/kubectl-create-configmap.1 index 361e67d66df..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create-configmap.1 +++ b/docs/man/man1/kubectl-create-configmap.1 @@ -1,215 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create configmap \- Create a configMap from a local file, directory or literal value. - - -.SH SYNOPSIS -.PP -\fBkubectl create configmap\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a configmap based on a file, directory, or specified literal value. - -.PP -A single configmap may package one or more key/value pairs. - -.PP -When creating a configmap based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. - -.PP -When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be -packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). - - -.SH OPTIONS -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-from\-file\fP=[] - Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key. - -.PP -\fB\-\-from\-literal\fP=[] - Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) - -.PP -\fB\-\-generator\fP="configmap/v1" - The name of the API generator to use. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - # Create a new configmap named my\-config with keys for each file in folder bar - kubectl create configmap my\-config \-\-from\-file=path/to/bar - - # Create a new configmap named my\-config with specified keys instead of names on disk - kubectl create configmap my\-config \-\-from\-file=key1=/path/to/bar/file1.txt \-\-from\-file=key2=/path/to/bar/file2.txt - - # Create a new configMap named my\-config with key1=config1 and key2=config2 - kubectl create configmap my\-config \-\-from\-literal=key1=config1 \-\-from\-literal=key2=config2 - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-create(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create-namespace.1 b/docs/man/man1/kubectl-create-namespace.1 index 8049b808354..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create-namespace.1 +++ b/docs/man/man1/kubectl-create-namespace.1 @@ -1,189 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create namespace \- Create a namespace with the specified name. - - -.SH SYNOPSIS -.PP -\fBkubectl create namespace\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a namespace with the specified name. - - -.SH OPTIONS -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-generator\fP="namespace/v1" - The name of the API generator to use. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - # Create a new namespace named my\-namespace - kubectl create namespace my\-namespace - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-create(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create-secret-docker-registry.1 b/docs/man/man1/kubectl-create-secret-docker-registry.1 index 643fc7f00f6..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create-secret-docker-registry.1 +++ b/docs/man/man1/kubectl-create-secret-docker-registry.1 @@ -1,224 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create secret docker\-registry \- Create a secret for use with a Docker registry. - - -.SH SYNOPSIS -.PP -\fBkubectl create secret docker\-registry\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a new secret for use with Docker registries. - -.PP -Dockercfg secrets are used to authenticate against Docker registries. - -.PP -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER\_REGISTRY\_SERVER \-\-username=DOCKER\_USER \-\-password=DOCKER\_PASSWORD \-\-email=DOCKER\_EMAIL'. -That produces a \~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. - -.PP -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. - - -.SH OPTIONS -.PP -\fB\-\-docker\-email\fP="" - Email for Docker registry - -.PP -\fB\-\-docker\-password\fP="" - Password for Docker registry authentication - -.PP -\fB\-\-docker\-server\fP=" -\[la]https://index.docker.io/v1/"\[ra] - Server location for Docker registry - -.PP -\fB\-\-docker\-username\fP="" - Username for Docker registry authentication - -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-generator\fP="secret\-for\-docker\-registry/v1" - The name of the API generator to use. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: - kubectl create secret docker\-registry my\-secret \-\-docker\-server=DOCKER\_REGISTRY\_SERVER \-\-docker\-username=DOCKER\_USER \-\-docker\-password=DOCKER\_PASSWORD \-\-docker\-email=DOCKER\_EMAIL - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-create\-secret(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create-secret-generic.1 b/docs/man/man1/kubectl-create-secret-generic.1 index ef69be387b9..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create-secret-generic.1 +++ b/docs/man/man1/kubectl-create-secret-generic.1 @@ -1,219 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create secret generic \- Create a secret from a local file, directory or literal value. - - -.SH SYNOPSIS -.PP -\fBkubectl create secret generic\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a secret based on a file, directory, or specified literal value. - -.PP -A single secret may package one or more key/value pairs. - -.PP -When creating a secret based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. - -.PP -When creating a secret based on a directory, each file whose basename is a valid key in the directory will be -packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). - - -.SH OPTIONS -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-from\-file\fP=[] - Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. - -.PP -\fB\-\-from\-literal\fP=[] - Specify a key and literal value to insert in secret (i.e. mykey=somevalue) - -.PP -\fB\-\-generator\fP="secret/v1" - The name of the API generator to use. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-type\fP="" - The type of secret to create - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - # Create a new secret named my\-secret with keys for each file in folder bar - kubectl create secret generic my\-secret \-\-from\-file=path/to/bar - - # Create a new secret named my\-secret with specified keys instead of names on disk - kubectl create secret generic my\-secret \-\-from\-file=ssh\-privatekey=\~/.ssh/id\_rsa \-\-from\-file=ssh\-publickey=\~/.ssh/id\_rsa.pub - - # Create a new secret named my\-secret with key1=supersecret and key2=topsecret - kubectl create secret generic my\-secret \-\-from\-literal=key1=supersecret \-\-from\-literal=key2=topsecret - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-create\-secret(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create-secret-tls.1 b/docs/man/man1/kubectl-create-secret-tls.1 index 75a136e2a0c..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create-secret-tls.1 +++ b/docs/man/man1/kubectl-create-secret-tls.1 @@ -1,200 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create secret tls \- Create a TLS secret. - - -.SH SYNOPSIS -.PP -\fBkubectl create secret tls\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a TLS secret from the given public/private key pair. - -.PP -The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key. - - -.SH OPTIONS -.PP -\fB\-\-cert\fP="" - Path to PEM encoded public key certificate. - -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-generator\fP="secret\-for\-tls/v1" - The name of the API generator to use. - -.PP -\fB\-\-key\fP="" - Path to private key associated with given certificate. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - # Create a new TLS secret named tls\-secret with the given key pair: - kubectl create secret tls tls\-secret \-\-cert=path/to/tls.cert \-\-key=path/to/tls.key - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-create\-secret(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create-secret.1 b/docs/man/man1/kubectl-create-secret.1 index e17da7f14a8..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create-secret.1 +++ b/docs/man/man1/kubectl-create-secret.1 @@ -1,124 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create secret \- Create a secret using specified subcommand. - - -.SH SYNOPSIS -.PP -\fBkubectl create secret\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a secret using specified subcommand. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl\-create(1)\fP, \fBkubectl\-create\-secret\-docker\-registry(1)\fP, \fBkubectl\-create\-secret\-tls(1)\fP, \fBkubectl\-create\-secret\-generic(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create-serviceaccount.1 b/docs/man/man1/kubectl-create-serviceaccount.1 index c3473fc9cfa..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create-serviceaccount.1 +++ b/docs/man/man1/kubectl-create-serviceaccount.1 @@ -1,193 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create serviceaccount \- Create a service account with the specified name. - - -.SH SYNOPSIS -.PP -\fBkubectl create serviceaccount\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a service account with the specified name. - - -.SH OPTIONS -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-generator\fP="serviceaccount/v1" - The name of the API generator to use. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - # Create a new service account named my\-service\-account - $ kubectl create serviceaccount my\-service\-account - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-create(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-create.1 b/docs/man/man1/kubectl-create.1 index 622df09c03e..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-create.1 +++ b/docs/man/man1/kubectl-create.1 @@ -1,176 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl create \- Create a resource by filename or stdin - - -.SH SYNOPSIS -.PP -\fBkubectl create\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create a resource by filename or stdin. - -.PP -JSON and YAML formats are accepted. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to file to use to create the resource - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output mode. Use "\-o name" for shorter output (resource/name). - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Create a pod using the data in pod.json. -kubectl create \-f ./pod.json - -# Create a pod based on the JSON passed into stdin. -cat pod.json | kubectl create \-f \- - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, \fBkubectl\-create\-namespace(1)\fP, \fBkubectl\-create\-secret(1)\fP, \fBkubectl\-create\-configmap(1)\fP, \fBkubectl\-create\-serviceaccount(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-delete.1 b/docs/man/man1/kubectl-delete.1 index 18d8f6503fc..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-delete.1 +++ b/docs/man/man1/kubectl-delete.1 @@ -1,211 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl delete \- Delete resources by filenames, stdin, resources and names, or by resources and label selector. - - -.SH SYNOPSIS -.PP -\fBkubectl delete\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Delete resources by filenames, stdin, resources and names, or by resources and label selector. - -.PP -JSON and YAML formats are accepted. - -.PP -Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector - -.PP -Note that the delete command does NOT do resource version checks, so if someone -submits an update to a resource right when you submit a delete, their update -will be lost along with the rest of the resource. - - -.SH OPTIONS -.PP -\fB\-\-all\fP=false - [\-all] to select all the specified resources. - -.PP -\fB\-\-cascade\fP=true - If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file containing the resource to delete. - -.PP -\fB\-\-grace\-period\fP=\-1 - Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. - -.PP -\fB\-\-ignore\-not\-found\fP=false - Treat "resource not found" as a successful delete. Defaults to "true" when \-\-all is specified. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-now\fP=false - If true, resources are force terminated without graceful deletion (same as \-\-grace\-period=0). - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output mode. Use "\-o name" for shorter output (resource/name). - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on. - -.PP -\fB\-\-timeout\fP=0 - The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Delete a pod using the type and name specified in pod.json. -kubectl delete \-f ./pod.json - -# Delete a pod based on the type and name in the JSON passed into stdin. -cat pod.json | kubectl delete \-f \- - -# Delete pods and services with same names "baz" and "foo" -kubectl delete pod,service baz foo - -# Delete pods and services with label name=myLabel. -kubectl delete pods,services \-l name=myLabel - -# Delete a pod immediately (no graceful shutdown) -kubectl delete pod foo \-\-now - -# Delete a pod with UID 1234\-56\-7890\-234234\-456456. -kubectl delete pod 1234\-56\-7890\-234234\-456456 - -# Delete all pods -kubectl delete pods \-\-all - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-describe.1 b/docs/man/man1/kubectl-describe.1 index 4a6506b74cf..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-describe.1 +++ b/docs/man/man1/kubectl-describe.1 @@ -1,192 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl describe \- Show details of a specific resource or group of resources - - -.SH SYNOPSIS -.PP -\fBkubectl describe\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Show details of a specific resource or group of resources. - -.PP -This command joins many API calls together to form a detailed description of a -given resource or group of resources. - -.PP -$ kubectl describe TYPE NAME\_PREFIX - -.PP -will first check for an exact match on TYPE and NAME\_PREFIX. If no such resource -exists, it will output details for every resource that has a name prefixed with NAME\_PREFIX - -.PP -Possible resource types include (case insensitive): pods (po), services (svc), deployments, -replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), -persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), -serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, -componentstatuses (cs), endpoints (ep), and secrets. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file containing the resource to describe - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on - -.PP -\fB\-\-show\-events\fP=true - If true, display events related to the described object. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Describe a node -kubectl describe nodes kubernetes\-minion\-emt8.c.myproject.internal - -# Describe a pod -kubectl describe pods/nginx - -# Describe a pod identified by type and name in "pod.json" -kubectl describe \-f pod.json - -# Describe all pods -kubectl describe pods - -# Describe pods by label name=myLabel -kubectl describe po \-l name=myLabel - -# Describe all pods managed by the 'frontend' replication controller (rc\-created pods -# get the name of the rc as a prefix in the pod the name). -kubectl describe pods frontend - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-drain.1 b/docs/man/man1/kubectl-drain.1 index 833998de53d..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-drain.1 +++ b/docs/man/man1/kubectl-drain.1 @@ -1,173 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl drain \- Drain node in preparation for maintenance - - -.SH SYNOPSIS -.PP -\fBkubectl drain\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Drain node in preparation for maintenance. - -.PP -The given node will be marked unschedulable to prevent new pods from arriving. -Then drain deletes all pods except mirror pods (which cannot be deleted through -the API server). If there are DaemonSet\-managed pods, drain will not proceed -without \-\-ignore\-daemonsets, and regardless it will not delete any -DaemonSet\-managed pods, because those pods would be immediately replaced by the -DaemonSet controller, which ignores unschedulable markings. If there are any -pods that are neither mirror pods nor managed\-\-by ReplicationController, -ReplicaSet, DaemonSet or Job\-\-, then drain will not delete any pods unless you -use \-\-force. - -.PP -When you are ready to put the node back into service, use kubectl uncordon, which -will make the node schedulable again. - - -.SH OPTIONS -.PP -\fB\-\-delete\-local\-data\fP=false - Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). - -.PP -\fB\-\-force\fP=false - Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet. - -.PP -\fB\-\-grace\-period\fP=\-1 - Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. - -.PP -\fB\-\-ignore\-daemonsets\fP=false - Ignore DaemonSet\-managed pods. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ kubectl drain foo \-\-force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ kubectl drain foo \-\-grace\-period=900 - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-edit.1 b/docs/man/man1/kubectl-edit.1 index c6b49c6c7ea..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-edit.1 +++ b/docs/man/man1/kubectl-edit.1 @@ -1,197 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl edit \- Edit a resource on the server - - -.SH SYNOPSIS -.PP -\fBkubectl edit\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Edit a resource from the default editor. - -.PP -The edit command allows you to directly edit any API resource you can retrieve via the -command line tools. It will open the editor defined by your KUBE\_EDITOR, or EDITOR -environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. -You can edit multiple objects, although changes are applied one at a time. The command -accepts filenames as well as command line arguments, although the files you point to must -be previously saved versions of resources. - -.PP -The files to edit will be output in the default API version, or a version specified -by \-\-output\-version. The default format is YAML \- if you would like to edit in JSON -pass \-o json. The flag \-\-windows\-line\-endings can be used to force Windows line endings, -otherwise the default for your operating system will be used. - -.PP -In the event an error occurs while updating, a temporary file will be created on disk -that contains your unapplied changes. The most common error when updating a resource -is another editor changing the resource on the server. When this occurs, you will have -to apply your changes to the newer version of the resource, or update your temporary -saved copy to include the latest resource version. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to file to use to edit the resource - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-o\fP, \fB\-\-output\fP="yaml" - Output format. One of: yaml|json. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-windows\-line\-endings\fP=false - Use Windows line\-endings (default Unix line\-endings) - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - # Edit the service named 'docker\-registry': - kubectl edit svc/docker\-registry - - # Use an alternative editor - KUBE\_EDITOR="nano" kubectl edit svc/docker\-registry - - # Edit the service 'docker\-registry' in JSON using the v1 API format: - kubectl edit svc/docker\-registry \-\-output\-version=v1 \-o json - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-exec.1 b/docs/man/man1/kubectl-exec.1 index 6504b097737..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-exec.1 +++ b/docs/man/man1/kubectl-exec.1 @@ -1,161 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl exec \- Execute a command in a container. - - -.SH SYNOPSIS -.PP -\fBkubectl exec\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Execute a command in a container. - - -.SH OPTIONS -.PP -\fB\-c\fP, \fB\-\-container\fP="" - Container name. If omitted, the first container in the pod will be chosen - -.PP -\fB\-p\fP, \fB\-\-pod\fP="" - Pod name - -.PP -\fB\-i\fP, \fB\-\-stdin\fP=false - Pass stdin to the container - -.PP -\fB\-t\fP, \fB\-\-tty\fP=false - Stdin is a TTY - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Get output from running 'date' from pod 123456\-7890, using the first container by default -kubectl exec 123456\-7890 date - -# Get output from running 'date' in ruby\-container from pod 123456\-7890 -kubectl exec 123456\-7890 \-c ruby\-container date - -# Switch to raw terminal mode, sends stdin to 'bash' in ruby\-container from pod 123456\-7890 -# and sends stdout/stderr from 'bash' back to the client -kubectl exec 123456\-7890 \-c ruby\-container \-i \-t \-\- bash \-il - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-explain.1 b/docs/man/man1/kubectl-explain.1 index b35f681acbd..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-explain.1 +++ b/docs/man/man1/kubectl-explain.1 @@ -1,156 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl explain \- Documentation of resources. - - -.SH SYNOPSIS -.PP -\fBkubectl explain\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Documentation of resources. - -.PP -Possible resource types include (case insensitive): pods (po), services (svc), deployments, -replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), -persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), -serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, -componentstatuses (cs), endpoints (ep), and secrets. - - -.SH OPTIONS -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-recursive\fP=false - Print the fields of fields (Currently only 1 level deep) - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Get the documentation of the resource and its fields -kubectl explain pods - -# Get the documentation of a specific field of a resource -kubectl explain pods.spec.containers - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-expose.1 b/docs/man/man1/kubectl-expose.1 index d4e509beb72..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-expose.1 +++ b/docs/man/man1/kubectl-expose.1 @@ -1,276 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl expose \- Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service - - -.SH SYNOPSIS -.PP -\fBkubectl expose\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Expose a resource as a new Kubernetes service. - -.PP -Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector -for that resource as the selector for a new service on the specified port. A deployment or replica set -will be exposed as a service only if its selector is convertible to a selector that service supports, -i.e. when the selector contains only the matchLabels component. Note that if no port is specified via -\-\-port and the exposed resource has multiple ports, all will be re\-used by the new service. Also if no -labels are specified, the new service will re\-use the labels from the resource it exposes. - -.PP -Possible resources include (case insensitive): - pod (po), service (svc), replicationcontroller (rc), - deployment, replicaset (rs) - - -.SH OPTIONS -.PP -\fB\-\-container\-port\fP="" - Synonym for \-\-target\-port - -.PP -\fB\-\-create\-external\-load\-balancer\fP=false - If true, create an external load balancer for this service (trumped by \-\-type). Implementation is cloud provider dependent. Default is 'false'. - -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-external\-ip\fP="" - Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to expose a service - -.PP -\fB\-\-generator\fP="service/v2" - The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. - -.PP -\fB\-l\fP, \fB\-\-labels\fP="" - Labels to apply to the service created by this call. - -.PP -\fB\-\-load\-balancer\-ip\fP="" - IP to assign to to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud\-provider specific). - -.PP -\fB\-\-name\fP="" - The name for the newly created object. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-overrides\fP="" - An inline JSON override for the generated object. If this is non\-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. - -.PP -\fB\-\-port\fP="" - The port that the service should serve on. Copied from the resource being exposed, if unspecified - -.PP -\fB\-\-protocol\fP="" - The network protocol for the service to be created. Default is 'TCP'. - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-selector\fP="" - A label selector to use for this service. Only equality\-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set. - -.PP -\fB\-\-session\-affinity\fP="" - If non\-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-target\-port\fP="" - Name or number for the port on the container that the service should direct traffic to. Optional. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-type\fP="" - Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. -kubectl expose rc nginx \-\-port=80 \-\-target\-port=8000 - -# Create a service for a replication controller identified by type and name specified in "nginx\-controller.yaml", which serves on port 80 and connects to the containers on port 8000. -kubectl expose \-f nginx\-controller.yaml \-\-port=80 \-\-target\-port=8000 - -# Create a service for a pod valid\-pod, which serves on port 444 with the name "frontend" -kubectl expose pod valid\-pod \-\-port=444 \-\-name=frontend - -# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx\-https" -kubectl expose service nginx \-\-port=443 \-\-target\-port=8443 \-\-name=nginx\-https - -# Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video\-stream'. -kubectl expose rc streamer \-\-port=4100 \-\-protocol=udp \-\-name=video\-stream - -# Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000. -kubectl expose rs nginx \-\-port=80 \-\-target\-port=8000 - -# Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000. -kubectl expose deployment nginx \-\-port=80 \-\-target\-port=8000 - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-get.1 b/docs/man/man1/kubectl-get.1 index 5a6f860c6e2..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-get.1 +++ b/docs/man/man1/kubectl-get.1 @@ -1,237 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl get \- Display one or many resources - - -.SH SYNOPSIS -.PP -\fBkubectl get\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Display one or many resources. - -.PP -Possible resource types include (case insensitive): pods (po), services (svc), deployments, -replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), -persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), -serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, -componentstatuses (cs), endpoints (ep), and secrets. - -.PP -By specifying the output as 'template' and providing a Go template as the value -of the \-\-template flag, you can filter the attributes of the fetched resource(s). - - -.SH OPTIONS -.PP -\fB\-\-all\-namespaces\fP=false - If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with \-\-namespace. - -.PP -\fB\-\-export\fP=false - If true, use 'export' for the resources. Exported resources are stripped of cluster\-specific information. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to get from a server. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-L\fP, \fB\-\-label\-columns\fP=[] - Accepts a comma separated list of labels that are going to be presented as columns. Names are case\-sensitive. You can also use multiple flag statements like \-L label1 \-L label2... - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-w\fP, \fB\-\-watch\fP=false - After listing/getting the requested object, watch for changes. - -.PP -\fB\-\-watch\-only\fP=false - Watch for changes to the requested object(s), without listing/getting first. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# List all pods in ps output format. -kubectl get pods - -# List all pods in ps output format with more information (such as node name). -kubectl get pods \-o wide - -# List a single replication controller with specified NAME in ps output format. -kubectl get replicationcontroller web - -# List a single pod in JSON output format. -kubectl get \-o json pod web\-pod\-13je7 - -# List a pod identified by type and name specified in "pod.yaml" in JSON output format. -kubectl get \-f pod.yaml \-o json - -# Return only the phase value of the specified pod. -kubectl get \-o template pod/web\-pod\-13je7 \-\-template={{.status.phase}} - -# List all replication controllers and services together in ps output format. -kubectl get rc,services - -# List one or more resources by their type and names. -kubectl get rc/web service/frontend pods/web\-pod\-13je7 - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-label.1 b/docs/man/man1/kubectl-label.1 index 2548e4835da..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-label.1 +++ b/docs/man/man1/kubectl-label.1 @@ -1,226 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl label \- Update the labels on a resource - - -.SH SYNOPSIS -.PP -\fBkubectl label\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Update the labels on a resource. - -.PP -A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. -If \-\-overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. -If \-\-resource\-version is specified, then updates will use this resource version, otherwise the existing resource\-version will be used. - - -.SH OPTIONS -.PP -\fB\-\-all\fP=false - select all resources in the namespace of the specified resource types - -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to update the labels - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-overwrite\fP=false - If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-resource\-version\fP="" - If non\-empty, the labels update will only succeed if this is the current resource\-version for the object. Only valid when specifying a single resource. - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Update pod 'foo' with the label 'unhealthy' and the value 'true'. -kubectl label pods foo unhealthy=true - -# Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value. -kubectl label \-\-overwrite pods foo status=unhealthy - -# Update all pods in the namespace -kubectl label pods \-\-all status=unhealthy - -# Update a pod identified by the type and name in "pod.json" -kubectl label \-f pod.json status=unhealthy - -# Update pod 'foo' only if the resource is unchanged from version 1. -kubectl label pods foo status=unhealthy \-\-resource\-version=1 - -# Update pod 'foo' by removing a label named 'bar' if it exists. -# Does not require the \-\-overwrite flag. -kubectl label pods foo bar\- - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-logs.1 b/docs/man/man1/kubectl-logs.1 index 66092f70f16..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-logs.1 +++ b/docs/man/man1/kubectl-logs.1 @@ -1,190 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl logs \- Print the logs for a container in a pod. - - -.SH SYNOPSIS -.PP -\fBkubectl logs\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Print the logs for a container in a pod. If the pod has only one container, the container name is optional. - - -.SH OPTIONS -.PP -\fB\-c\fP, \fB\-\-container\fP="" - Print the logs of this container - -.PP -\fB\-f\fP, \fB\-\-follow\fP=false - Specify if the logs should be streamed. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-interactive\fP=false - If true, prompt the user for input when required. - -.PP -\fB\-\-limit\-bytes\fP=0 - Maximum bytes of logs to return. Defaults to no limit. - -.PP -\fB\-p\fP, \fB\-\-previous\fP=false - If true, print the logs for the previous instance of the container in a pod if it exists. - -.PP -\fB\-\-since\fP=0 - Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since\-time / since may be used. - -.PP -\fB\-\-since\-time\fP="" - Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since\-time / since may be used. - -.PP -\fB\-\-tail\fP=\-1 - Lines of recent log file to display. Defaults to \-1, showing all log lines. - -.PP -\fB\-\-timestamps\fP=false - Include timestamps on each line in the log output - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Return snapshot logs from pod nginx with only one container -kubectl logs nginx - -# Return snapshot of previous terminated ruby container logs from pod web\-1 -kubectl logs \-p \-c ruby web\-1 - -# Begin streaming the logs of the ruby container in pod web\-1 -kubectl logs \-f \-c ruby web\-1 - -# Display only the most recent 20 lines of output in pod nginx -kubectl logs \-\-tail=20 nginx - -# Show all logs from pod nginx written in the last hour -kubectl logs \-\-since=1h nginx - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-namespace.1 b/docs/man/man1/kubectl-namespace.1 index 3ec8507a9d7..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-namespace.1 +++ b/docs/man/man1/kubectl-namespace.1 @@ -1,127 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl namespace \- SUPERSEDED: Set and view the current Kubernetes namespace - - -.SH SYNOPSIS -.PP -\fBkubectl namespace\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -SUPERSEDED: Set and view the current Kubernetes namespace scope for command line requests. - -.PP -namespace has been superseded by the context.namespace field of .kubeconfig files. See 'kubectl config set\-context \-\-help' for more details. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-patch.1 b/docs/man/man1/kubectl-patch.1 index 6ce3732565c..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-patch.1 +++ b/docs/man/man1/kubectl-patch.1 @@ -1,183 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl patch \- Update field(s) of a resource using strategic merge patch. - - -.SH SYNOPSIS -.PP -\fBkubectl patch\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Update field(s) of a resource using strategic merge patch - -.PP -JSON and YAML formats are accepted. - -.PP -Please refer to the models in -\[la]https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html\[ra] to find if a field is mutable. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to update - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output mode. Use "\-o name" for shorter output (resource/name). - -.PP -\fB\-p\fP, \fB\-\-patch\fP="" - The patch to be applied to the resource JSON file. - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-type\fP="strategic" - The type of patch being provided; one of [json merge strategic] - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - -# Partially update a node using strategic merge patch -kubectl patch node k8s\-node\-1 \-p '{"spec":{"unschedulable":true}}' - -# Partially update a node identified by the type and name specified in "node.json" using strategic merge patch -kubectl patch \-f node.json \-p '{"spec":{"unschedulable":true}}' - -# Update a container's image; spec.containers[*].name is required because it's a merge key -kubectl patch pod valid\-pod \-p '{"spec":{"containers":[{"name":"kubernetes\-serve\-hostname","image":"new image"}]}}' - -# Update a container's image using a json patch with positional arrays -kubectl patch pod valid\-pod \-\-type='json' \-p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]' - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-port-forward.1 b/docs/man/man1/kubectl-port-forward.1 index d4149bad7eb..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-port-forward.1 +++ b/docs/man/man1/kubectl-port-forward.1 @@ -1,152 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl port\-forward \- Forward one or more local ports to a pod. - - -.SH SYNOPSIS -.PP -\fBkubectl port\-forward\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Forward one or more local ports to a pod. - - -.SH OPTIONS -.PP -\fB\-p\fP, \fB\-\-pod\fP="" - Pod name - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf - -# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod -kubectl port\-forward mypod 5000 6000 - -# Listen on port 8888 locally, forwarding to 5000 in the pod -kubectl port\-forward mypod 8888:5000 - -# Listen on a random port locally, forwarding to 5000 in the pod -kubectl port\-forward mypod :5000 - -# Listen on a random port locally, forwarding to 5000 in the pod -kubectl port\-forward mypod 0:5000 - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-proxy.1 b/docs/man/man1/kubectl-proxy.1 index db50532edcb..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-proxy.1 +++ b/docs/man/man1/kubectl-proxy.1 @@ -1,211 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl proxy \- Run a proxy to the Kubernetes API server - - -.SH SYNOPSIS -.PP -\fBkubectl proxy\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -To proxy all of the kubernetes api and nothing else, use: - -.PP -kubectl proxy \-\-api\-prefix=/ - -.PP -To proxy only part of the kubernetes api and also some static files: - -.PP -kubectl proxy \-\-www=/my/files \-\-www\-prefix=/static/ \-\-api\-prefix=/api/ - -.PP -The above lets you 'curl localhost:8001/api/v1/pods'. - -.PP -To proxy the entire kubernetes api at a different root, use: - -.PP -kubectl proxy \-\-api\-prefix=/custom/ - -.PP -The above lets you 'curl localhost:8001/custom/api/v1/pods' - - -.SH OPTIONS -.PP -\fB\-\-accept\-hosts\fP="^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$" - Regular expression for hosts that the proxy should accept. - -.PP -\fB\-\-accept\-paths\fP="^/.*" - Regular expression for paths that the proxy should accept. - -.PP -\fB\-\-address\fP="127.0.0.1" - The IP address on which to serve on. - -.PP -\fB\-\-api\-prefix\fP="/" - Prefix to serve the proxied API under. - -.PP -\fB\-\-disable\-filter\fP=false - If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. - -.PP -\fB\-p\fP, \fB\-\-port\fP=8001 - The port on which to run the proxy. Set to 0 to pick a random port. - -.PP -\fB\-\-reject\-methods\fP="POST,PUT,PATCH" - Regular expression for HTTP methods that the proxy should reject. - -.PP -\fB\-\-reject\-paths\fP="^/api/.\fI/exec,^/api/.\fP/run,^/api/.*/attach" - Regular expression for paths that the proxy should reject. - -.PP -\fB\-u\fP, \fB\-\-unix\-socket\fP="" - Unix socket on which to run the proxy. - -.PP -\fB\-w\fP, \fB\-\-www\fP="" - Also serve static files from the given directory under the specified prefix. - -.PP -\fB\-P\fP, \fB\-\-www\-prefix\fP="/static/" - Prefix to serve static files under, if static file directory is specified. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/ -kubectl proxy \-\-port=8011 \-\-www=./local/www/ - -# Run a proxy to kubernetes apiserver on an arbitrary local port. -# The chosen port for the server will be output to stdout. -kubectl proxy \-\-port=0 - -# Run a proxy to kubernetes apiserver, changing the api prefix to k8s\-api -# This makes e.g. the pods api available at localhost:8011/k8s\-api/v1/pods/ -kubectl proxy \-\-api\-prefix=/k8s\-api - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-replace.1 b/docs/man/man1/kubectl-replace.1 index 48c8df1e5fc..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-replace.1 +++ b/docs/man/man1/kubectl-replace.1 @@ -1,204 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl replace \- Replace a resource by filename or stdin. - - -.SH SYNOPSIS -.PP -\fBkubectl replace\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Replace a resource by filename or stdin. - -.PP -JSON and YAML formats are accepted. If replacing an existing resource, the -complete resource spec must be provided. This can be obtained by -$ kubectl get TYPE NAME \-o yaml - -.PP -Please refer to the models in -\[la]https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html\[ra] to find if a field is mutable. - - -.SH OPTIONS -.PP -\fB\-\-cascade\fP=false - Only relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to file to use to replace the resource. - -.PP -\fB\-\-force\fP=false - Delete and re\-create the specified resource - -.PP -\fB\-\-grace\-period\fP=\-1 - Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output mode. Use "\-o name" for shorter output (resource/name). - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-\-timeout\fP=0 - Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Replace a pod using the data in pod.json. -kubectl replace \-f ./pod.json - -# Replace a pod based on the JSON passed into stdin. -cat pod.json | kubectl replace \-f \- - -# Update a single\-container pod's image version (tag) to v4 -kubectl get pod mypod \-o yaml | sed 's/\\(image: myimage\\):.*$/\\1:v4/' | kubectl replace \-f \- - -# Force replace, delete and then re\-create the resource -kubectl replace \-\-force \-f ./pod.json - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-rolling-update.1 b/docs/man/man1/kubectl-rolling-update.1 index 2f8d3ced180..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-rolling-update.1 +++ b/docs/man/man1/kubectl-rolling-update.1 @@ -1,240 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl rolling\-update \- Perform a rolling update of the given ReplicationController. - - -.SH SYNOPSIS -.PP -\fBkubectl rolling\-update\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Perform a rolling update of the given ReplicationController. - -.PP -Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the -new PodTemplate. The new\-controller.json must specify the same namespace as the -existing replication controller and overwrite at least one (common) label in its replicaSelector. - - -.SH OPTIONS -.PP -\fB\-\-container\fP="" - Container name which will have its image upgraded. Only relevant when \-\-image is specified, ignored otherwise. Required when using \-\-image on a multi\-container pod - -.PP -\fB\-\-deployment\-label\-key\fP="deployment" - The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when \-\-image is specified, ignored otherwise - -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename or URL to file to use to create the new replication controller. - -.PP -\fB\-\-image\fP="" - Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag). Can not be used with \-\-filename/\-f - -.PP -\fB\-\-image\-pull\-policy\fP="" - Explicit policy for when to pull container images. Required when \-\-image is same as existing image, ignored otherwise. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-poll\-interval\fP=3s - Time delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - -.PP -\fB\-\-rollback\fP=false - If true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-timeout\fP=5m0s - Max time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - -.PP -\fB\-\-update\-period\fP=1m0s - Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Update pods of frontend\-v1 using new replication controller data in frontend\-v2.json. -kubectl rolling\-update frontend\-v1 \-f frontend\-v2.json - -# Update pods of frontend\-v1 using JSON data passed into stdin. -cat frontend\-v2.json | kubectl rolling\-update frontend\-v1 \-f \- - -# Update the pods of frontend\-v1 to frontend\-v2 by just changing the image, and switching the -# name of the replication controller. -kubectl rolling\-update frontend\-v1 frontend\-v2 \-\-image=image:v2 - -# Update the pods of frontend by just changing the image, and keeping the old name. -kubectl rolling\-update frontend \-\-image=image:v2 - -# Abort and reverse an existing rollout in progress (from frontend\-v1 to frontend\-v2). -kubectl rolling\-update frontend\-v1 frontend\-v2 \-\-rollback - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-rollout-history.1 b/docs/man/man1/kubectl-rollout-history.1 index 7f35dc9f8e3..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-rollout-history.1 +++ b/docs/man/man1/kubectl-rollout-history.1 @@ -1,153 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl rollout history \- view rollout history - - -.SH SYNOPSIS -.PP -\fBkubectl rollout history\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -View previous rollout revisions and configurations. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to get from a server. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-revision\fP=0 - See the details, including podTemplate of the revision specified - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# View the rollout history of a deployment -kubectl rollout history deployment/abc - -# View the details of deployment revision 3 -kubectl rollout history deployment/abc \-\-revision=3 - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-rollout(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-rollout-pause.1 b/docs/man/man1/kubectl-rollout-pause.1 index 7b11b89f558..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-rollout-pause.1 +++ b/docs/man/man1/kubectl-rollout-pause.1 @@ -1,153 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl rollout pause \- Mark the provided resource as paused - - -.SH SYNOPSIS -.PP -\fBkubectl rollout pause\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Mark the provided resource as paused - -.PP -Paused resources will not be reconciled by a controller. -Use \\"kubectl rollout resume\\" to resume a paused resource. -Currently only deployments support being paused. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to get from a server. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Mark the nginx deployment as paused. Any current state of -# the deployment will continue its function, new updates to the deployment will not -# have an effect as long as the deployment is paused. -kubectl rollout pause deployment/nginx - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-rollout(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-rollout-resume.1 b/docs/man/man1/kubectl-rollout-resume.1 index 796ba295d07..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-rollout-resume.1 +++ b/docs/man/man1/kubectl-rollout-resume.1 @@ -1,151 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl rollout resume \- Resume a paused resource - - -.SH SYNOPSIS -.PP -\fBkubectl rollout resume\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Resume a paused resource - -.PP -Paused resources will not be reconciled by a controller. By resuming a -resource, we allow it to be reconciled again. -Currently only deployments support being resumed. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to get from a server. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Resume an already paused deployment -kubectl rollout resume deployment/nginx - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-rollout(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-rollout-status.1 b/docs/man/man1/kubectl-rollout-status.1 index 60cfef1a78a..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-rollout-status.1 +++ b/docs/man/man1/kubectl-rollout-status.1 @@ -1,146 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl rollout status \- Watch rollout status until it's done - - -.SH SYNOPSIS -.PP -\fBkubectl rollout status\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Watch the status of current rollout, until it's done. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to get from a server. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Watch the rollout status of a deployment -kubectl rollout status deployment/nginx - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-rollout(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-rollout-undo.1 b/docs/man/man1/kubectl-rollout-undo.1 index db2a7924b98..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-rollout-undo.1 +++ b/docs/man/man1/kubectl-rollout-undo.1 @@ -1,153 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl rollout undo \- undoes a previous rollout - - -.SH SYNOPSIS -.PP -\fBkubectl rollout undo\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Rollback to a previous rollout. - - -.SH OPTIONS -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to get from a server. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-to\-revision\fP=0 - The revision to rollback to. Default to 0 (last revision). - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Rollback to the previous deployment -kubectl rollout undo deployment/abc - -# Rollback to deployment revision 3 -kubectl rollout undo deployment/abc \-\-to\-revision=3 - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-rollout(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-rollout.1 b/docs/man/man1/kubectl-rollout.1 index 2c269290072..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-rollout.1 +++ b/docs/man/man1/kubectl-rollout.1 @@ -1,136 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl rollout \- rollout manages a deployment - - -.SH SYNOPSIS -.PP -\fBkubectl rollout\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Manages a deployment using subcommands like "kubectl rollout undo deployment/abc" - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Rollback to the previous deployment -kubectl rollout undo deployment/abc - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, \fBkubectl\-rollout\-history(1)\fP, \fBkubectl\-rollout\-pause(1)\fP, \fBkubectl\-rollout\-resume(1)\fP, \fBkubectl\-rollout\-undo(1)\fP, \fBkubectl\-rollout\-status(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-run.1 b/docs/man/man1/kubectl-run.1 index 4001a62137e..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-run.1 +++ b/docs/man/man1/kubectl-run.1 @@ -1,293 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl run \- Run a particular image on the cluster. - - -.SH SYNOPSIS -.PP -\fBkubectl run\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Create and run a particular image, possibly replicated. -Creates a deployment or job to manage the created container(s). - - -.SH OPTIONS -.PP -\fB\-\-attach\fP=false - If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '\-i/\-\-stdin' is set, in which case the default is true. - -.PP -\fB\-\-command\fP=false - If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. - -.PP -\fB\-\-dry\-run\fP=false - If true, only print the object that would be sent, without sending it. - -.PP -\fB\-\-env\fP=[] - Environment variables to set in the container - -.PP -\fB\-\-expose\fP=false - If true, a public, external service is created for the container(s) which are run - -.PP -\fB\-\-generator\fP="" - The name of the API generator to use. Default is 'deployment/v1beta1' if \-\-restart=Always, 'job/v1' for OnFailure and 'run\-pod/v1' for Never. This will happen only for cluster version at least 1.3, for 1.2 we will fallback to 'deployment/v1beta1' for \-\-restart=Always, 'job/v1' for others, for olders we will fallback to 'run/v1' for \-\-restart=Always, 'run\-pod/v1' for others. - -.PP -\fB\-\-hostport\fP=\-1 - The host port mapping for the container port. To demonstrate a single\-machine container. - -.PP -\fB\-\-image\fP="" - The image for the container to run. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-l\fP, \fB\-\-labels\fP="" - Labels to apply to the pod(s). - -.PP -\fB\-\-leave\-stdin\-open\fP=false - If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. - -.PP -\fB\-\-limits\fP="" - The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-overrides\fP="" - An inline JSON override for the generated object. If this is non\-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. - -.PP -\fB\-\-port\fP=\-1 - The port that this container exposes. If \-\-expose is true, this is also the port used by the service that is created. - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-r\fP, \fB\-\-replicas\fP=1 - Number of replicas to create for this container. Default is 1. - -.PP -\fB\-\-requests\fP="" - The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges. - -.PP -\fB\-\-restart\fP="Always" - The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to 'OnFailure', a job is created for this pod, if set to 'Never', a regular pod is created. For the latter two \-\-replicas must be 1. Default 'Always' - -.PP -\fB\-\-rm\fP=false - If true, delete resources created in this command for attached containers. - -.PP -\fB\-\-save\-config\fP=false - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -.PP -\fB\-\-service\-generator\fP="service/v2" - The name of the generator to use for creating a service. Only used if \-\-expose is true - -.PP -\fB\-\-service\-overrides\fP="" - An inline JSON override for the generated service object. If this is non\-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if \-\-expose is true. - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-i\fP, \fB\-\-stdin\fP=false - Keep stdin open on the container(s) in the pod, even if nothing is attached. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-t\fP, \fB\-\-tty\fP=false - Allocated a TTY for each container in the pod. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Start a single instance of nginx. -kubectl run nginx \-\-image=nginx - -# Start a single instance of hazelcast and let the container expose port 5701 . -kubectl run hazelcast \-\-image=hazelcast \-\-port=5701 - -# Start a single instance of hazelcast and set environment variables "DNS\_DOMAIN=cluster" and "POD\_NAMESPACE=default" in the container. -kubectl run hazelcast \-\-image=hazelcast \-\-env="DNS\_DOMAIN=cluster" \-\-env="POD\_NAMESPACE=default" - -# Start a replicated instance of nginx. -kubectl run nginx \-\-image=nginx \-\-replicas=5 - -# Dry run. Print the corresponding API objects without creating them. -kubectl run nginx \-\-image=nginx \-\-dry\-run - -# Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON. -kubectl run nginx \-\-image=nginx \-\-overrides='{ "apiVersion": "v1", "spec": { ... } }' - -# Start a pod of busybox and keep it in the foreground, don't restart it if it exits. -kubectl run \-i \-t busybox \-\-image=busybox \-\-restart=Never - -# Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command. -kubectl run nginx \-\-image=nginx \-\- ... - -# Start the nginx container using a different command and custom arguments. -kubectl run nginx \-\-image=nginx \-\-command \-\- ... - -# Start the perl container to compute π to 2000 places and print it out. -kubectl run pi \-\-image=perl \-\-restart=OnFailure \-\- perl \-Mbignum=bpi \-wle 'print bpi(2000)' - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-scale.1 b/docs/man/man1/kubectl-scale.1 index d7d0fb2d983..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-scale.1 +++ b/docs/man/man1/kubectl-scale.1 @@ -1,192 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl scale \- Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. - - -.SH SYNOPSIS -.PP -\fBkubectl scale\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. - -.PP -Scale also allows users to specify one or more preconditions for the scale action. -If \-\-current\-replicas or \-\-resource\-version is specified, it is validated before the -scale is attempted, and it is guaranteed that the precondition holds true when the -scale is sent to the server. - - -.SH OPTIONS -.PP -\fB\-\-current\-replicas\fP=\-1 - Precondition for current size. Requires that the current size of the resource match this value in order to scale. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to set a new size - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output mode. Use "\-o name" for shorter output (resource/name). - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-\-replicas\fP=\-1 - The new desired number of replicas. Required. - -.PP -\fB\-\-resource\-version\fP="" - Precondition for resource version. Requires that the current resource version match this value in order to scale. - -.PP -\fB\-\-timeout\fP=0 - The length of time to wait before giving up on a scale operation, zero means don't wait. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Scale a replicaset named 'foo' to 3. -kubectl scale \-\-replicas=3 rs/foo - -# Scale a resource identified by type and name specified in "foo.yaml" to 3. -kubectl scale \-\-replicas=3 \-f foo.yaml - -# If the deployment named mysql's current size is 2, scale mysql to 3. -kubectl scale \-\-current\-replicas=2 \-\-replicas=3 deployment/mysql - -# Scale multiple replication controllers. -kubectl scale \-\-replicas=5 rc/foo rc/bar rc/baz - -# Scale job named 'cron' to 3. -kubectl scale \-\-replicas=3 job/cron - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-set-image.1 b/docs/man/man1/kubectl-set-image.1 index a48d16d5912..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-set-image.1 +++ b/docs/man/man1/kubectl-set-image.1 @@ -1,206 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl set image \- Update image of a pod template - - -.SH SYNOPSIS -.PP -\fBkubectl set image\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Update existing container image(s) of resources. - -.PP -Possible resources include (case insensitive): - pod (po), replicationcontroller (rc), deployment, daemonset (ds), job, replicaset (rs) - - -.SH OPTIONS -.PP -\fB\-\-all\fP=false - select all resources in the namespace of the specified resource types - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to a file identifying the resource to get from a server. - -.PP -\fB\-\-local\fP=false - If true, set image will NOT contact api\-server but run locally. - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-record\fP=false - Record current kubectl command in the resource annotation. - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'. -kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1 - -# Update all deployments' and rc's nginx container's image to 'nginx:1.9.1' -kubectl set image deployments,rc nginx=nginx:1.9.1 \-\-all - -# Update image of all containers of daemonset abc to 'nginx:1.9.1' -kubectl set image daemonset abc *=nginx:1.9.1 - -# Print result (in yaml format) of updating nginx container image from local file, without hitting the server -kubectl set image \-f path/to/file.yaml nginx=nginx:1.9.1 \-\-local \-o yaml - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl\-set(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-set.1 b/docs/man/man1/kubectl-set.1 index b89dfbd76f3..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-set.1 +++ b/docs/man/man1/kubectl-set.1 @@ -1,127 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl set \- Set specific features on objects - - -.SH SYNOPSIS -.PP -\fBkubectl set\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Configure application resources - -.PP -These commands help you make changes to existing application resources. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, \fBkubectl\-set\-image(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-stop.1 b/docs/man/man1/kubectl-stop.1 index a5407fd82dd..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-stop.1 +++ b/docs/man/man1/kubectl-stop.1 @@ -1,191 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl stop \- Deprecated: Gracefully shut down a resource by name or filename. - - -.SH SYNOPSIS -.PP -\fBkubectl stop\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Deprecated: Gracefully shut down a resource by name or filename. - -.PP -The stop command is deprecated, all its functionalities are covered by delete command. -See 'kubectl delete \-\-help' for more details. - -.PP -Attempts to shut down and delete a resource that supports graceful termination. -If the resource is scalable it will be scaled to 0 before deletion. - - -.SH OPTIONS -.PP -\fB\-\-all\fP=false - [\-all] to select all the specified resources. - -.PP -\fB\-f\fP, \fB\-\-filename\fP=[] - Filename, directory, or URL to file of resource(s) to be stopped. - -.PP -\fB\-\-grace\-period\fP=\-1 - Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. - -.PP -\fB\-\-ignore\-not\-found\fP=false - Treat "resource not found" as a successful stop. - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output mode. Use "\-o name" for shorter output (resource/name). - -.PP -\fB\-R\fP, \fB\-\-recursive\fP=false - If true, process directory recursively. - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on. - -.PP -\fB\-\-timeout\fP=0 - The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Shut down foo. -kubectl stop replicationcontroller foo - -# Stop pods and services with label name=myLabel. -kubectl stop pods,services \-l name=myLabel - -# Shut down the service defined in service.json -kubectl stop \-f service.json - -# Shut down all resources in the path/to/resources directory -kubectl stop \-f path/to/resources - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-taint.1 b/docs/man/man1/kubectl-taint.1 index 69342b7aa7d..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-taint.1 +++ b/docs/man/man1/kubectl-taint.1 @@ -1,203 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl taint \- Update the taints on one or more nodes - - -.SH SYNOPSIS -.PP -\fBkubectl taint\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Update the taints on one or more nodes. - -.PP -A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. -The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The effect must be NoSchedule or PreferNoSchedule. -Currently taint can only apply to node. - - -.SH OPTIONS -.PP -\fB\-\-all\fP=false - select all nodes in the cluster - -.PP -\fB\-\-include\-extended\-apis\fP=true - If true, include definitions of new APIs via calls to the API server. [default true] - -.PP -\fB\-\-no\-headers\fP=false - When using the default output, don't print headers. - -.PP -\fB\-o\fP, \fB\-\-output\fP="" - Output format. One of: json|yaml|wide|name|go\-template=...|go\-template\-file=...|jsonpath=...|jsonpath\-file=... See golang template [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]] and jsonpath template [ -\[la]http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md\[ra]]. - -.PP -\fB\-\-output\-version\fP="" - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -.PP -\fB\-\-overwrite\fP=false - If true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. - -.PP -\fB\-\-schema\-cache\-dir\fP="\~/.kube/schema" - If non\-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -.PP -\fB\-l\fP, \fB\-\-selector\fP="" - Selector (label query) to filter on - -.PP -\fB\-a\fP, \fB\-\-show\-all\fP=false - When printing, show all resources (default hide terminated pods.) - -.PP -\fB\-\-show\-labels\fP=false - When printing, show all labels as the last column (default hide labels column) - -.PP -\fB\-\-sort\-by\fP="" - If non\-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -.PP -\fB\-\-template\fP="" - Template string or path to template file to use when \-o=go\-template, \-o=go\-template\-file. The template format is golang templates [ -\[la]http://golang.org/pkg/text/template/#pkg-overview\[ra]]. - -.PP -\fB\-\-validate\fP=true - If true, use a schema to validate the input before sending it - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Update node 'foo' with a taint with key 'dedicated' and value 'special\-user' and effect 'NoSchedule'. -# If a taint with that key already exists, its value and effect are replaced as specified. -kubectl taint nodes foo dedicated=special\-user:NoSchedule -# Remove from node 'foo' the taint with key 'dedicated' if one exists. -kubectl taint nodes foo dedicated\- - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-uncordon.1 b/docs/man/man1/kubectl-uncordon.1 index f43355596ed..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-uncordon.1 +++ b/docs/man/man1/kubectl-uncordon.1 @@ -1,137 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl uncordon \- Mark node as schedulable - - -.SH SYNOPSIS -.PP -\fBkubectl uncordon\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Mark node as schedulable. - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH EXAMPLE -.PP -.RS - -.nf -# Mark node "foo" as schedulable. -$ kubectl uncordon foo - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl-version.1 b/docs/man/man1/kubectl-version.1 index 87323f51151..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl-version.1 +++ b/docs/man/man1/kubectl-version.1 @@ -1,130 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl version \- Print the client and server version information. - - -.SH SYNOPSIS -.PP -\fBkubectl version\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -Print the client and server version information. - - -.SH OPTIONS -.PP -\fB\-\-client\fP=false - Client version only (no server required). - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/man/man1/kubectl.1 b/docs/man/man1/kubectl.1 index 924893c7b05..b6fd7a0f989 100644 --- a/docs/man/man1/kubectl.1 +++ b/docs/man/man1/kubectl.1 @@ -1,128 +1,3 @@ -.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" "" - - -.SH NAME -.PP -kubectl \- kubectl controls the Kubernetes cluster manager - - -.SH SYNOPSIS -.PP -\fBkubectl\fP [OPTIONS] - - -.SH DESCRIPTION -.PP -kubectl controls the Kubernetes cluster manager. - -.PP -Find more information at -\[la]https://github.com/kubernetes/kubernetes\[ra]. - - -.SH OPTIONS -.PP -\fB\-\-alsologtostderr\fP=false - log to standard error as well as files - -.PP -\fB\-\-api\-version\fP="" - DEPRECATED: The API version to use when talking to the server - -.PP -\fB\-\-as\fP="" - Username to impersonate for the operation. - -.PP -\fB\-\-certificate\-authority\fP="" - Path to a cert. file for the certificate authority. - -.PP -\fB\-\-client\-certificate\fP="" - Path to a client certificate file for TLS. - -.PP -\fB\-\-client\-key\fP="" - Path to a client key file for TLS. - -.PP -\fB\-\-cluster\fP="" - The name of the kubeconfig cluster to use - -.PP -\fB\-\-context\fP="" - The name of the kubeconfig context to use - -.PP -\fB\-\-insecure\-skip\-tls\-verify\fP=false - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - -.PP -\fB\-\-kubeconfig\fP="" - Path to the kubeconfig file to use for CLI requests. - -.PP -\fB\-\-log\-backtrace\-at\fP=:0 - when logging hits line file:N, emit a stack trace - -.PP -\fB\-\-log\-dir\fP="" - If non\-empty, write log files in this directory - -.PP -\fB\-\-log\-flush\-frequency\fP=5s - Maximum number of seconds between log flushes - -.PP -\fB\-\-logtostderr\fP=true - log to standard error instead of files - -.PP -\fB\-\-match\-server\-version\fP=false - Require server version to match client version - -.PP -\fB\-\-namespace\fP="" - If present, the namespace scope for this CLI request. - -.PP -\fB\-\-password\fP="" - Password for basic authentication to the API server. - -.PP -\fB\-s\fP, \fB\-\-server\fP="" - The address and port of the Kubernetes API server - -.PP -\fB\-\-stderrthreshold\fP=2 - logs at or above this threshold go to stderr - -.PP -\fB\-\-token\fP="" - Bearer token for authentication to the API server. - -.PP -\fB\-\-user\fP="" - The name of the kubeconfig user to use - -.PP -\fB\-\-username\fP="" - Username for basic authentication to the API server. - -.PP -\fB\-\-v\fP=0 - log level for V logs - -.PP -\fB\-\-vmodule\fP= - comma\-separated list of pattern=N settings for file\-filtered logging - - -.SH SEE ALSO -.PP -\fBkubectl\-get(1)\fP, \fBkubectl\-set(1)\fP, \fBkubectl\-describe(1)\fP, \fBkubectl\-create(1)\fP, \fBkubectl\-replace(1)\fP, \fBkubectl\-patch(1)\fP, \fBkubectl\-delete(1)\fP, \fBkubectl\-edit(1)\fP, \fBkubectl\-apply(1)\fP, \fBkubectl\-namespace(1)\fP, \fBkubectl\-logs(1)\fP, \fBkubectl\-rolling\-update(1)\fP, \fBkubectl\-scale(1)\fP, \fBkubectl\-cordon(1)\fP, \fBkubectl\-drain(1)\fP, \fBkubectl\-uncordon(1)\fP, \fBkubectl\-attach(1)\fP, \fBkubectl\-exec(1)\fP, \fBkubectl\-port\-forward(1)\fP, \fBkubectl\-proxy(1)\fP, \fBkubectl\-run(1)\fP, \fBkubectl\-stop(1)\fP, \fBkubectl\-expose(1)\fP, \fBkubectl\-autoscale(1)\fP, \fBkubectl\-rollout(1)\fP, \fBkubectl\-label(1)\fP, \fBkubectl\-annotate(1)\fP, \fBkubectl\-taint(1)\fP, \fBkubectl\-config(1)\fP, \fBkubectl\-cluster\-info(1)\fP, \fBkubectl\-api\-versions(1)\fP, \fBkubectl\-version(1)\fP, \fBkubectl\-explain(1)\fP, \fBkubectl\-convert(1)\fP, \fBkubectl\-completion(1)\fP, - - -.SH HISTORY -.PP -January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md index 23af11bedca..80294a54ef7 100644 --- a/docs/user-guide/kubectl/kubectl.md +++ b/docs/user-guide/kubectl/kubectl.md @@ -32,87 +32,9 @@ Documentation for other releases can be found at -## kubectl - -kubectl controls the Kubernetes cluster manager - -### Synopsis - - -kubectl controls the Kubernetes cluster manager. - -Find more information at https://github.com/kubernetes/kubernetes. - -``` -kubectl -``` - -### Options - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl annotate](kubectl_annotate.md) - Update the annotations on a resource -* [kubectl api-versions](kubectl_api-versions.md) - Print the supported API versions on the server, in the form of "group/version". -* [kubectl apply](kubectl_apply.md) - Apply a configuration to a resource by filename or stdin -* [kubectl attach](kubectl_attach.md) - Attach to a running container. -* [kubectl autoscale](kubectl_autoscale.md) - Auto-scale a Deployment, ReplicaSet, or ReplicationController -* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info -* [kubectl completion](kubectl_completion.md) - Output shell completion code for the given shell (bash or zsh) -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -* [kubectl convert](kubectl_convert.md) - Convert config files between different API versions -* [kubectl cordon](kubectl_cordon.md) - Mark node as unschedulable -* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -* [kubectl delete](kubectl_delete.md) - Delete resources by filenames, stdin, resources and names, or by resources and label selector. -* [kubectl describe](kubectl_describe.md) - Show details of a specific resource or group of resources -* [kubectl drain](kubectl_drain.md) - Drain node in preparation for maintenance -* [kubectl edit](kubectl_edit.md) - Edit a resource on the server -* [kubectl exec](kubectl_exec.md) - Execute a command in a container. -* [kubectl explain](kubectl_explain.md) - Documentation of resources. -* [kubectl expose](kubectl_expose.md) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service -* [kubectl get](kubectl_get.md) - Display one or many resources -* [kubectl label](kubectl_label.md) - Update the labels on a resource -* [kubectl logs](kubectl_logs.md) - Print the logs for a container in a pod. -* [kubectl namespace](kubectl_namespace.md) - SUPERSEDED: Set and view the current Kubernetes namespace -* [kubectl patch](kubectl_patch.md) - Update field(s) of a resource using strategic merge patch. -* [kubectl port-forward](kubectl_port-forward.md) - Forward one or more local ports to a pod. -* [kubectl proxy](kubectl_proxy.md) - Run a proxy to the Kubernetes API server -* [kubectl replace](kubectl_replace.md) - Replace a resource by filename or stdin. -* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController. -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment -* [kubectl run](kubectl_run.md) - Run a particular image on the cluster. -* [kubectl scale](kubectl_scale.md) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. -* [kubectl set](kubectl_set.md) - Set specific features on objects -* [kubectl taint](kubectl_taint.md) - Update the taints on one or more nodes -* [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable -* [kubectl version](kubectl_version.md) - Print the client and server version information. - -###### Auto generated by spf13/cobra on 30-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_annotate.md b/docs/user-guide/kubectl/kubectl_annotate.md index f0afee6f4ac..48d1f9295f0 100644 --- a/docs/user-guide/kubectl/kubectl_annotate.md +++ b/docs/user-guide/kubectl/kubectl_annotate.md @@ -32,108 +32,9 @@ Documentation for other releases can be found at -## kubectl annotate - -Update the annotations on a resource - -### Synopsis - - -Update the annotations on one or more resources. - -An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data. -It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions. -If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. -If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. - -Possible resources include (case insensitive): - pod (po), service (svc), replicationcontroller (rc), - node (no), event (ev), componentstatuse (cs), - limitrange (limits), persistentvolume (pv), persistentvolumeclaim (pvc), - horizontalpodautoscaler (hpa), resourcequota (quota), secret - - -``` -kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version] -``` - -### Examples - -``` -# Update pod 'foo' with the annotation 'description' and the value 'my frontend'. -# If the same annotation is set multiple times, only the last value will be applied -kubectl annotate pods foo description='my frontend' - -# Update a pod identified by type and name in "pod.json" -kubectl annotate -f pod.json description='my frontend' - -# Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value. -kubectl annotate --overwrite pods foo description='my frontend running nginx' - -# Update all pods in the namespace -kubectl annotate pods --all description='my frontend running nginx' - -# Update pod 'foo' only if the resource is unchanged from version 1. -kubectl annotate pods foo description='my frontend running nginx' --resource-version=1 - -# Update pod 'foo' by removing an annotation named 'description' if it exists. -# Does not require the --overwrite flag. -kubectl annotate pods foo description- -``` - -### Options - -``` - --all[=false]: select all resources in the namespace of the specified resource types - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the annotation - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --overwrite[=false]: If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --resource-version="": If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. - -l, --selector="": Selector (label query) to filter on - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 10-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_annotate.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_api-versions.md b/docs/user-guide/kubectl/kubectl_api-versions.md index 9da1ff2386d..30cf1a3988c 100644 --- a/docs/user-guide/kubectl/kubectl_api-versions.md +++ b/docs/user-guide/kubectl/kubectl_api-versions.md @@ -32,52 +32,9 @@ Documentation for other releases can be found at -## kubectl api-versions - -Print the supported API versions on the server, in the form of "group/version". - -### Synopsis - - -Print the supported API versions on the server, in the form of "group/version". - -``` -kubectl api-versions -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_api-versions.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_apply.md b/docs/user-guide/kubectl/kubectl_apply.md index 441e6a95060..368c4791755 100644 --- a/docs/user-guide/kubectl/kubectl_apply.md +++ b/docs/user-guide/kubectl/kubectl_apply.md @@ -32,78 +32,9 @@ Documentation for other releases can be found at -## kubectl apply - -Apply a configuration to a resource by filename or stdin - -### Synopsis - - -Apply a configuration to a resource by filename or stdin. -The resource will be created if it doesn't exist yet. -To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. - -JSON and YAML formats are accepted. - -``` -kubectl apply -f FILENAME -``` - -### Examples - -``` -# Apply the configuration in pod.json to a pod. -kubectl apply -f ./pod.json - -# Apply the JSON passed into stdin to a pod. -cat pod.json | kubectl apply -f - -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to file that contains the configuration to apply - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 3-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_apply.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md index f45141c5efb..ad81d7dea0c 100644 --- a/docs/user-guide/kubectl/kubectl_attach.md +++ b/docs/user-guide/kubectl/kubectl_attach.md @@ -32,74 +32,9 @@ Documentation for other releases can be found at -## kubectl attach - -Attach to a running container. - -### Synopsis - - -Attach to a process that is already running inside an existing container. - -``` -kubectl attach POD -c CONTAINER -``` - -### Examples - -``` -# Get output from running pod 123456-7890, using the first container by default -kubectl attach 123456-7890 - -# Get output from ruby-container from pod 123456-7890 -kubectl attach 123456-7890 -c ruby-container - -# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 -# and sends stdout/stderr from 'bash' back to the client -kubectl attach 123456-7890 -c ruby-container -i -t -``` - -### Options - -``` - -c, --container="": Container name. If omitted, the first container in the pod will be chosen - -i, --stdin[=false]: Pass stdin to the container - -t, --tty[=false]: Stdin is a TTY -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_attach.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_autoscale.md b/docs/user-guide/kubectl/kubectl_autoscale.md index 43f0f0da97d..d420d97e7f0 100644 --- a/docs/user-guide/kubectl/kubectl_autoscale.md +++ b/docs/user-guide/kubectl/kubectl_autoscale.md @@ -32,88 +32,9 @@ Documentation for other releases can be found at -## kubectl autoscale - -Auto-scale a Deployment, ReplicaSet, or ReplicationController - -### Synopsis - - -Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. - -Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. -An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. - -``` -kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags] -``` - -### Examples - -``` -# Auto scale a deployment "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: -kubectl autoscale deployment foo --min=2 --max=10 - -# Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80%: -kubectl autoscale rc foo --max=5 --cpu-percent=80 -``` - -### Options - -``` - --cpu-percent=-1: The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, the server will apply a default value. - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to autoscale. - --generator="horizontalpodautoscaler/v1beta1": The name of the API generator to use. Currently there is only 1 generator. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --max=-1: The upper limit for the number of pods that can be set by the autoscaler. Required. - --min=-1: The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. - --name="": The name for the newly created object. If not specified, the name of the input resource will be used. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 13-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_autoscale.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_cluster-info.md b/docs/user-guide/kubectl/kubectl_cluster-info.md index 6cc2c282412..b30769bdcd8 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info.md @@ -32,60 +32,9 @@ Documentation for other releases can be found at -## kubectl cluster-info - -Display cluster info - -### Synopsis - - -Display addresses of the master and services with label kubernetes.io/cluster-service=true -To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'. - -``` -kubectl cluster-info -``` - -### Options - -``` - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -* [kubectl cluster-info dump](kubectl_cluster-info_dump.md) - Dump lots of relevant info for debugging and diagnosis. - -###### Auto generated by spf13/cobra on 16-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cluster-info.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md index a946b835f20..5f88f7da9fd 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md @@ -27,84 +27,9 @@ Documentation for other releases can be found at -## kubectl cluster-info dump - -Dump lots of relevant info for debugging and diagnosis. - -### Synopsis - - - -Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to -stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will -build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can -switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. - -The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories -based on namespace and pod name. - - -``` -kubectl cluster-info dump -``` - -### Examples - -``` -# Dump current cluster state to stdout -kubectl cluster-info dump - -# Dump current cluster state to /path/to/cluster-state -kubectl cluster-info dump --output-directory=/path/to/cluster-state - -# Dump all namespaces to stdout -kubectl cluster-info dump --all-namespaces - -# Dump a set of namespaces to /path/to/cluster-state -kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state -``` - -### Options - -``` - --all-namespaces[=false]: If true, dump all namespaces. If true, --namespaces is ignored. - --namespaces=[]: A comma separated list of namespaces to dump. - --output-directory="": Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info - -###### Auto generated by spf13/cobra on 16-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cluster-info_dump.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_completion.md b/docs/user-guide/kubectl/kubectl_completion.md index 58272ccbd1c..29872746c1f 100644 --- a/docs/user-guide/kubectl/kubectl_completion.md +++ b/docs/user-guide/kubectl/kubectl_completion.md @@ -27,75 +27,9 @@ Documentation for other releases can be found at -## kubectl completion - -Output shell completion code for the given shell (bash or zsh) - -### Synopsis - - -Output shell completion code for the given shell (bash or zsh). - -This command prints shell code which must be evaluation to provide interactive -completion of kubectl commands. - - -``` -kubectl completion SHELL -``` - -### Examples - -``` - -$ source <(kubectl completion bash) - -will load the kubectl completion code for bash. Note that this depends on the bash-completion -framework. It must be sourced before sourcing the kubectl completion, i.e. on the Mac: - -$ brew install bash-completion -$ source $(brew --prefix)/etc/bash_completion -$ source <(kubectl completion bash) - -If you use zsh, the following will load kubectl zsh completion: - -$ source <(kubectl completion zsh) - -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_completion.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config.md b/docs/user-guide/kubectl/kubectl_config.md index e1cb41845c7..9ab12a904fc 100644 --- a/docs/user-guide/kubectl/kubectl_config.md +++ b/docs/user-guide/kubectl/kubectl_config.md @@ -32,71 +32,9 @@ Documentation for other releases can be found at -## kubectl config - -config modifies kubeconfig files - -### Synopsis - - -config modifies kubeconfig files using subcommands like "kubectl config set current-context my-context" - -The loading order follows these rules: -1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. -2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged together. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. -3. Otherwise, ${HOME}/.kube/config is used and no merging takes place. - - -``` -kubectl config SUBCOMMAND -``` - -### Options - -``` - --kubeconfig="": use a particular kubeconfig file -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -* [kubectl config current-context](kubectl_config_current-context.md) - Displays the current-context -* [kubectl config set](kubectl_config_set.md) - Sets an individual value in a kubeconfig file -* [kubectl config set-cluster](kubectl_config_set-cluster.md) - Sets a cluster entry in kubeconfig -* [kubectl config set-context](kubectl_config_set-context.md) - Sets a context entry in kubeconfig -* [kubectl config set-credentials](kubectl_config_set-credentials.md) - Sets a user entry in kubeconfig -* [kubectl config unset](kubectl_config_unset.md) - Unsets an individual value in a kubeconfig file -* [kubectl config use-context](kubectl_config_use-context.md) - Sets the current-context in a kubeconfig file -* [kubectl config view](kubectl_config_view.md) - Displays merged kubeconfig settings or a specified kubeconfig file. - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_current-context.md b/docs/user-guide/kubectl/kubectl_config_current-context.md index 989acf4908c..ef74bcb905b 100644 --- a/docs/user-guide/kubectl/kubectl_config_current-context.md +++ b/docs/user-guide/kubectl/kubectl_config_current-context.md @@ -32,59 +32,9 @@ Documentation for other releases can be found at -## kubectl config current-context - -Displays the current-context - -### Synopsis - - -Displays the current-context - -``` -kubectl config current-context -``` - -### Examples - -``` -# Display the current-context -kubectl config current-context -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_current-context.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set-cluster.md b/docs/user-guide/kubectl/kubectl_config_set-cluster.md index 2299fbacf1d..79f15f731e0 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-cluster.md +++ b/docs/user-guide/kubectl/kubectl_config_set-cluster.md @@ -32,73 +32,9 @@ Documentation for other releases can be found at -## kubectl config set-cluster - -Sets a cluster entry in kubeconfig - -### Synopsis - - -Sets a cluster entry in kubeconfig. -Specifying a name that already exists will merge new fields on top of existing values for those fields. - -``` -kubectl config set-cluster NAME [--server=server] [--certificate-authority=path/to/certficate/authority] [--insecure-skip-tls-verify=true] -``` - -### Examples - -``` -# Set only the server field on the e2e cluster entry without touching other values. -kubectl config set-cluster e2e --server=https://1.2.3.4 - -# Embed certificate authority data for the e2e cluster entry -kubectl config set-cluster e2e --certificate-authority=~/.kube/e2e/kubernetes.ca.crt - -# Disable cert checking for the dev cluster entry -kubectl config set-cluster e2e --insecure-skip-tls-verify=true -``` - -### Options - -``` - --api-version="": api-version for the cluster entry in kubeconfig - --certificate-authority="": path to certificate-authority file for the cluster entry in kubeconfig - --embed-certs[=false]: embed-certs for the cluster entry in kubeconfig - --insecure-skip-tls-verify[=false]: insecure-skip-tls-verify for the cluster entry in kubeconfig - --server="": server for the cluster entry in kubeconfig -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-cluster.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set-context.md b/docs/user-guide/kubectl/kubectl_config_set-context.md index e4b0c5e5c50..1d9fedff5ed 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-context.md +++ b/docs/user-guide/kubectl/kubectl_config_set-context.md @@ -32,65 +32,9 @@ Documentation for other releases can be found at -## kubectl config set-context - -Sets a context entry in kubeconfig - -### Synopsis - - -Sets a context entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values for those fields. - -``` -kubectl config set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace] -``` - -### Examples - -``` -# Set the user field on the gce context entry without touching other values -kubectl config set-context gce --user=cluster-admin -``` - -### Options - -``` - --cluster="": cluster for the context entry in kubeconfig - --namespace="": namespace for the context entry in kubeconfig - --user="": user for the context entry in kubeconfig -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-context.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set-credentials.md b/docs/user-guide/kubectl/kubectl_config_set-credentials.md index 01096060b02..0c90e60bf9f 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-credentials.md +++ b/docs/user-guide/kubectl/kubectl_config_set-credentials.md @@ -32,85 +32,9 @@ Documentation for other releases can be found at -## kubectl config set-credentials - -Sets a user entry in kubeconfig - -### Synopsis - - -Sets a user entry in kubeconfig -Specifying a name that already exists will merge new fields on top of existing values. - - Client-certificate flags: - --client-certificate=certfile --client-key=keyfile - - Bearer token flags: - --token=bearer_token - - Basic auth flags: - --username=basic_user --password=basic_password - - Bearer token and basic auth are mutually exclusive. - - -``` -kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] -``` - -### Examples - -``` -# Set only the "client-key" field on the "cluster-admin" -# entry, without touching other values: -kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key - -# Set basic auth for the "cluster-admin" entry -kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU9l35qcif - -# Embed client certificate data in the "cluster-admin" entry -kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true -``` - -### Options - -``` - --client-certificate="": path to client-certificate file for the user entry in kubeconfig - --client-key="": path to client-key file for the user entry in kubeconfig - --embed-certs[=false]: embed client cert/key for the user entry in kubeconfig - --password="": password for the user entry in kubeconfig - --token="": token for the user entry in kubeconfig - --username="": username for the user entry in kubeconfig -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --user="": The name of the kubeconfig user to use - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-credentials.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_set.md b/docs/user-guide/kubectl/kubectl_config_set.md index 743acc2e728..c2da2d84647 100644 --- a/docs/user-guide/kubectl/kubectl_config_set.md +++ b/docs/user-guide/kubectl/kubectl_config_set.md @@ -32,60 +32,9 @@ Documentation for other releases can be found at -## kubectl config set - -Sets an individual value in a kubeconfig file - -### Synopsis - - -Sets an individual value in a kubeconfig file -PROPERTY_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. -PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. - -``` -kubectl config set PROPERTY_NAME PROPERTY_VALUE -``` - -### Options - -``` - --set-raw-bytes[=false]: When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 14-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_unset.md b/docs/user-guide/kubectl/kubectl_config_unset.md index c46dabffbd2..dc98e1ffff8 100644 --- a/docs/user-guide/kubectl/kubectl_config_unset.md +++ b/docs/user-guide/kubectl/kubectl_config_unset.md @@ -32,53 +32,9 @@ Documentation for other releases can be found at -## kubectl config unset - -Unsets an individual value in a kubeconfig file - -### Synopsis - - -Unsets an individual value in a kubeconfig file -PROPERTY_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. - -``` -kubectl config unset PROPERTY_NAME -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_unset.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_use-context.md b/docs/user-guide/kubectl/kubectl_config_use-context.md index ae63a23ea8f..4e17d02b328 100644 --- a/docs/user-guide/kubectl/kubectl_config_use-context.md +++ b/docs/user-guide/kubectl/kubectl_config_use-context.md @@ -32,52 +32,9 @@ Documentation for other releases can be found at -## kubectl config use-context - -Sets the current-context in a kubeconfig file - -### Synopsis - - -Sets the current-context in a kubeconfig file - -``` -kubectl config use-context CONTEXT_NAME -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_use-context.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_config_view.md b/docs/user-guide/kubectl/kubectl_config_view.md index 1d502f94304..0b52d494c09 100644 --- a/docs/user-guide/kubectl/kubectl_config_view.md +++ b/docs/user-guide/kubectl/kubectl_config_view.md @@ -32,80 +32,9 @@ Documentation for other releases can be found at -## kubectl config view - -Displays merged kubeconfig settings or a specified kubeconfig file. - -### Synopsis - - -Displays merged kubeconfig settings or a specified kubeconfig file. - -You can use --output jsonpath={...} to extract specific values using a jsonpath expression. - -``` -kubectl config view -``` - -### Examples - -``` -# Show Merged kubeconfig settings. -kubectl config view - -# Get the password for the e2e user -kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' -``` - -### Options - -``` - --flatten[=false]: flatten the resulting kubeconfig file into self contained output (useful for creating portable kubeconfig files) - --merge[=true]: merge together the full hierarchy of kubeconfig files - --minify[=false]: remove all information not used by current-context from the output - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --raw[=false]: display raw byte data - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": use a particular kubeconfig file - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_view.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_convert.md b/docs/user-guide/kubectl/kubectl_convert.md index 93fdbedb83b..889a1499304 100644 --- a/docs/user-guide/kubectl/kubectl_convert.md +++ b/docs/user-guide/kubectl/kubectl_convert.md @@ -32,94 +32,9 @@ Documentation for other releases can be found at -## kubectl convert - -Convert config files between different API versions - -### Synopsis - - -Convert config files between different API versions. Both YAML -and JSON formats are accepted. - -The command takes filename, directory, or URL as input, and convert it into format -of version specified by --output-version flag. If target version is not specified or -not supported, convert to latest version. - -The default output will be printed to stdout in YAML format. One can use -o option -to change to output destination. - - -``` -kubectl convert -f FILENAME -``` - -### Examples - -``` -# Convert 'pod.yaml' to latest version and print to stdout. -kubectl convert -f pod.yaml - -# Convert the live state of the resource specified by 'pod.yaml' to the latest version -# and print to stdout in json format. -kubectl convert -f pod.yaml --local -o json - -# Convert all files under current directory to latest version and create them all. -kubectl convert -f . | kubectl create -f - - -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to file to need to get converted. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --local[=true]: If true, convert will NOT try to contact api-server but run locally. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -R, --recursive[=false]: If true, process directory recursively. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_convert.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_cordon.md b/docs/user-guide/kubectl/kubectl_cordon.md index 83d30ab1433..c5f61849b00 100644 --- a/docs/user-guide/kubectl/kubectl_cordon.md +++ b/docs/user-guide/kubectl/kubectl_cordon.md @@ -32,61 +32,9 @@ Documentation for other releases can be found at -## kubectl cordon - -Mark node as unschedulable - -### Synopsis - - -Mark node as unschedulable. - - -``` -kubectl cordon NODE -``` - -### Examples - -``` -# Mark node "foo" as unschedulable. -kubectl cordon foo - -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cordon.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create.md b/docs/user-guide/kubectl/kubectl_create.md index f29f65427c3..ab1323943b7 100644 --- a/docs/user-guide/kubectl/kubectl_create.md +++ b/docs/user-guide/kubectl/kubectl_create.md @@ -32,81 +32,9 @@ Documentation for other releases can be found at -## kubectl create - -Create a resource by filename or stdin - -### Synopsis - - -Create a resource by filename or stdin. - -JSON and YAML formats are accepted. - -``` -kubectl create -f FILENAME -``` - -### Examples - -``` -# Create a pod using the data in pod.json. -kubectl create -f ./pod.json - -# Create a pod based on the JSON passed into stdin. -cat pod.json | kubectl create -f - -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to file to use to create the resource - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -* [kubectl create configmap](kubectl_create_configmap.md) - Create a configMap from a local file, directory or literal value. -* [kubectl create namespace](kubectl_create_namespace.md) - Create a namespace with the specified name. -* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. -* [kubectl create serviceaccount](kubectl_create_serviceaccount.md) - Create a service account with the specified name. - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create_configmap.md b/docs/user-guide/kubectl/kubectl_create_configmap.md index c41435068cf..7a036ddd88e 100644 --- a/docs/user-guide/kubectl/kubectl_create_configmap.md +++ b/docs/user-guide/kubectl/kubectl_create_configmap.md @@ -32,94 +32,9 @@ Documentation for other releases can be found at -## kubectl create configmap - -Create a configMap from a local file, directory or literal value. - -### Synopsis - - -Create a configmap based on a file, directory, or specified literal value. - -A single configmap may package one or more key/value pairs. - -When creating a configmap based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. - -When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be -packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). - - -``` -kubectl create configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run] -``` - -### Examples - -``` - # Create a new configmap named my-config with keys for each file in folder bar - kubectl create configmap my-config --from-file=path/to/bar - - # Create a new configmap named my-config with specified keys instead of names on disk - kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt - - # Create a new configMap named my-config with key1=config1 and key2=config2 - kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2 -``` - -### Options - -``` - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --from-file=[]: Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key. - --from-literal=[]: Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) - --generator="configmap/v1": The name of the API generator to use. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin - -###### Auto generated by spf13/cobra on 6-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_configmap.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create_namespace.md b/docs/user-guide/kubectl/kubectl_create_namespace.md index efc011489b7..5e046270ddc 100644 --- a/docs/user-guide/kubectl/kubectl_create_namespace.md +++ b/docs/user-guide/kubectl/kubectl_create_namespace.md @@ -32,77 +32,9 @@ Documentation for other releases can be found at -## kubectl create namespace - -Create a namespace with the specified name. - -### Synopsis - - - -Create a namespace with the specified name. - -``` -kubectl create namespace NAME [--dry-run] -``` - -### Examples - -``` - # Create a new namespace named my-namespace - kubectl create namespace my-namespace -``` - -### Options - -``` - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --generator="namespace/v1": The name of the API generator to use. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_namespace.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create_secret.md b/docs/user-guide/kubectl/kubectl_create_secret.md index e8338f0c557..e2a17650c96 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret.md +++ b/docs/user-guide/kubectl/kubectl_create_secret.md @@ -32,55 +32,9 @@ Documentation for other releases can be found at -## kubectl create secret - -Create a secret using specified subcommand. - -### Synopsis - - -Create a secret using specified subcommand. - -``` -kubectl create secret -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -* [kubectl create secret docker-registry](kubectl_create_secret_docker-registry.md) - Create a secret for use with a Docker registry. -* [kubectl create secret generic](kubectl_create_secret_generic.md) - Create a secret from a local file, directory or literal value. -* [kubectl create secret tls](kubectl_create_secret_tls.md) - Create a TLS secret. - -###### Auto generated by spf13/cobra on 25-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md index 9637b2003ff..e3008576bd8 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md @@ -32,93 +32,9 @@ Documentation for other releases can be found at -## kubectl create secret docker-registry - -Create a secret for use with a Docker registry. - -### Synopsis - - - -Create a new secret for use with Docker registries. - -Dockercfg secrets are used to authenticate against Docker registries. - -When using the Docker command line to push images, you can authenticate to a given registry by running - 'docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'. -That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to -authenticate to the registry. - -When creating applications, you may have a Docker registry that requires authentication. In order for the -nodes to pull images on your behalf, they have to have the credentials. You can provide this information -by creating a dockercfg secret and attaching it to your service account. - -``` -kubectl create secret docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run] -``` - -### Examples - -``` - # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: - kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL -``` - -### Options - -``` - --docker-email="": Email for Docker registry - --docker-password="": Password for Docker registry authentication - --docker-server="https://index.docker.io/v1/": Server location for Docker registry - --docker-username="": Username for Docker registry authentication - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --generator="secret-for-docker-registry/v1": The name of the API generator to use. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. - -###### Auto generated by spf13/cobra on 16-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create_secret_generic.md b/docs/user-guide/kubectl/kubectl_create_secret_generic.md index 77c799aea3f..c48dc6e062c 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_generic.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_generic.md @@ -32,96 +32,9 @@ Documentation for other releases can be found at -## kubectl create secret generic - -Create a secret from a local file, directory or literal value. - -### Synopsis - - - -Create a secret based on a file, directory, or specified literal value. - -A single secret may package one or more key/value pairs. - -When creating a secret based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key. - -When creating a secret based on a directory, each file whose basename is a valid key in the directory will be -packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc). - - -``` -kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run] -``` - -### Examples - -``` - # Create a new secret named my-secret with keys for each file in folder bar - kubectl create secret generic my-secret --from-file=path/to/bar - - # Create a new secret named my-secret with specified keys instead of names on disk - kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub - - # Create a new secret named my-secret with key1=supersecret and key2=topsecret - kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret -``` - -### Options - -``` - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --from-file=[]: Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. - --from-literal=[]: Specify a key and literal value to insert in secret (i.e. mykey=somevalue) - --generator="secret/v1": The name of the API generator to use. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --type="": The type of secret to create - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_generic.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create_secret_tls.md b/docs/user-guide/kubectl/kubectl_create_secret_tls.md index d468320ab3c..6f7faf6a9f5 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_tls.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_tls.md @@ -27,81 +27,9 @@ Documentation for other releases can be found at -## kubectl create secret tls - -Create a TLS secret. - -### Synopsis - - - -Create a TLS secret from the given public/private key pair. - -The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key. - -``` -kubectl create secret tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run] -``` - -### Examples - -``` - # Create a new TLS secret named tls-secret with the given key pair: - kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key -``` - -### Options - -``` - --cert="": Path to PEM encoded public key certificate. - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --generator="secret-for-tls/v1": The name of the API generator to use. - --key="": Path to private key associated with given certificate. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. - -###### Auto generated by spf13/cobra on 16-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_tls.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md index 21006cb0b78..f1979d04575 100644 --- a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md +++ b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md @@ -32,78 +32,9 @@ Documentation for other releases can be found at -## kubectl create serviceaccount - -Create a service account with the specified name. - -### Synopsis - - - -Create a service account with the specified name. - -``` -kubectl create serviceaccount NAME [--dry-run] -``` - -### Examples - -``` - # Create a new service account named my-service-account - $ kubectl create serviceaccount my-service-account -``` - -### Options - -``` - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --generator="serviceaccount/v1": The name of the API generator to use. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin - -###### Auto generated by spf13/cobra on 6-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_serviceaccount.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_delete.md b/docs/user-guide/kubectl/kubectl_delete.md index b1fad60246e..49e4c777610 100644 --- a/docs/user-guide/kubectl/kubectl_delete.md +++ b/docs/user-guide/kubectl/kubectl_delete.md @@ -32,101 +32,9 @@ Documentation for other releases can be found at -## kubectl delete - -Delete resources by filenames, stdin, resources and names, or by resources and label selector. - -### Synopsis - - -Delete resources by filenames, stdin, resources and names, or by resources and label selector. - -JSON and YAML formats are accepted. - -Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector - -Note that the delete command does NOT do resource version checks, so if someone -submits an update to a resource right when you submit a delete, their update -will be lost along with the rest of the resource. - -``` -kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)]) -``` - -### Examples - -``` -# Delete a pod using the type and name specified in pod.json. -kubectl delete -f ./pod.json - -# Delete a pod based on the type and name in the JSON passed into stdin. -cat pod.json | kubectl delete -f - - -# Delete pods and services with same names "baz" and "foo" -kubectl delete pod,service baz foo - -# Delete pods and services with label name=myLabel. -kubectl delete pods,services -l name=myLabel - -# Delete a pod immediately (no graceful shutdown) -kubectl delete pod foo --now - -# Delete a pod with UID 1234-56-7890-234234-456456. -kubectl delete pod 1234-56-7890-234234-456456 - -# Delete all pods -kubectl delete pods --all -``` - -### Options - -``` - --all[=false]: [-all] to select all the specified resources. - --cascade[=true]: If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. - -f, --filename=[]: Filename, directory, or URL to a file containing the resource to delete. - --grace-period=-1: Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. - --ignore-not-found[=false]: Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --now[=false]: If true, resources are force terminated without graceful deletion (same as --grace-period=0). - -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). - -R, --recursive[=false]: If true, process directory recursively. - -l, --selector="": Selector (label query) to filter on. - --timeout=0: The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 6-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_delete.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index 1c6123b547f..a44cec4ebe3 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -32,99 +32,9 @@ Documentation for other releases can be found at -## kubectl describe - -Show details of a specific resource or group of resources - -### Synopsis - - -Show details of a specific resource or group of resources. - -This command joins many API calls together to form a detailed description of a -given resource or group of resources. - -$ kubectl describe TYPE NAME_PREFIX - -will first check for an exact match on TYPE and NAME_PREFIX. If no such resource -exists, it will output details for every resource that has a name prefixed with NAME_PREFIX - -Possible resource types include (case insensitive): pods (po), services (svc), deployments, -replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), -persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), -serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, -componentstatuses (cs), endpoints (ep), and secrets. - -``` -kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) -``` - -### Examples - -``` -# Describe a node -kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal - -# Describe a pod -kubectl describe pods/nginx - -# Describe a pod identified by type and name in "pod.json" -kubectl describe -f pod.json - -# Describe all pods -kubectl describe pods - -# Describe pods by label name=myLabel -kubectl describe po -l name=myLabel - -# Describe all pods managed by the 'frontend' replication controller (rc-created pods -# get the name of the rc as a prefix in the pod the name). -kubectl describe pods frontend -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to a file containing the resource to describe - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -R, --recursive[=false]: If true, process directory recursively. - -l, --selector="": Selector (label query) to filter on - --show-events[=true]: If true, display events related to the described object. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 26-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_drain.md b/docs/user-guide/kubectl/kubectl_drain.md index 678cfe48a74..63442089439 100644 --- a/docs/user-guide/kubectl/kubectl_drain.md +++ b/docs/user-guide/kubectl/kubectl_drain.md @@ -32,86 +32,9 @@ Documentation for other releases can be found at -## kubectl drain - -Drain node in preparation for maintenance - -### Synopsis - - -Drain node in preparation for maintenance. - -The given node will be marked unschedulable to prevent new pods from arriving. -Then drain deletes all pods except mirror pods (which cannot be deleted through -the API server). If there are DaemonSet-managed pods, drain will not proceed -without --ignore-daemonsets, and regardless it will not delete any -DaemonSet-managed pods, because those pods would be immediately replaced by the -DaemonSet controller, which ignores unschedulable markings. If there are any -pods that are neither mirror pods nor managed--by ReplicationController, -ReplicaSet, DaemonSet or Job--, then drain will not delete any pods unless you -use --force. - -When you are ready to put the node back into service, use kubectl uncordon, which -will make the node schedulable again. - - -``` -kubectl drain NODE -``` - -### Examples - -``` -# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. -$ kubectl drain foo --force - -# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. -$ kubectl drain foo --grace-period=900 - -``` - -### Options - -``` - --delete-local-data[=false]: Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). - --force[=false]: Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet. - --grace-period=-1: Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. - --ignore-daemonsets[=false]: Ignore DaemonSet-managed pods. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 6-Jun-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_drain.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_edit.md b/docs/user-guide/kubectl/kubectl_edit.md index cae01701a44..f5403023f6d 100644 --- a/docs/user-guide/kubectl/kubectl_edit.md +++ b/docs/user-guide/kubectl/kubectl_edit.md @@ -32,96 +32,9 @@ Documentation for other releases can be found at -## kubectl edit - -Edit a resource on the server - -### Synopsis - - -Edit a resource from the default editor. - -The edit command allows you to directly edit any API resource you can retrieve via the -command line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR -environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. -You can edit multiple objects, although changes are applied one at a time. The command -accepts filenames as well as command line arguments, although the files you point to must -be previously saved versions of resources. - -The files to edit will be output in the default API version, or a version specified -by --output-version. The default format is YAML - if you would like to edit in JSON -pass -o json. The flag --windows-line-endings can be used to force Windows line endings, -otherwise the default for your operating system will be used. - -In the event an error occurs while updating, a temporary file will be created on disk -that contains your unapplied changes. The most common error when updating a resource -is another editor changing the resource on the server. When this occurs, you will have -to apply your changes to the newer version of the resource, or update your temporary -saved copy to include the latest resource version. - -``` -kubectl edit (RESOURCE/NAME | -f FILENAME) -``` - -### Examples - -``` - # Edit the service named 'docker-registry': - kubectl edit svc/docker-registry - - # Use an alternative editor - KUBE_EDITOR="nano" kubectl edit svc/docker-registry - - # Edit the service 'docker-registry' in JSON using the v1 API format: - kubectl edit svc/docker-registry --output-version=v1 -o json -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to file to use to edit the resource - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -o, --output="yaml": Output format. One of: yaml|json. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --windows-line-endings[=false]: Use Windows line-endings (default Unix line-endings) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_edit.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md index 55a466c9e32..af0e07af50d 100644 --- a/docs/user-guide/kubectl/kubectl_exec.md +++ b/docs/user-guide/kubectl/kubectl_exec.md @@ -32,75 +32,9 @@ Documentation for other releases can be found at -## kubectl exec - -Execute a command in a container. - -### Synopsis - - -Execute a command in a container. - -``` -kubectl exec POD [-c CONTAINER] -- COMMAND [args...] -``` - -### Examples - -``` -# Get output from running 'date' from pod 123456-7890, using the first container by default -kubectl exec 123456-7890 date - -# Get output from running 'date' in ruby-container from pod 123456-7890 -kubectl exec 123456-7890 -c ruby-container date - -# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 -# and sends stdout/stderr from 'bash' back to the client -kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il -``` - -### Options - -``` - -c, --container="": Container name. If omitted, the first container in the pod will be chosen - -p, --pod="": Pod name - -i, --stdin[=false]: Pass stdin to the container - -t, --tty[=false]: Stdin is a TTY -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 3-Jun-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_exec.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_explain.md b/docs/user-guide/kubectl/kubectl_explain.md index 39fdb9e7222..0fdcdbb3cb1 100644 --- a/docs/user-guide/kubectl/kubectl_explain.md +++ b/docs/user-guide/kubectl/kubectl_explain.md @@ -32,75 +32,9 @@ Documentation for other releases can be found at -## kubectl explain - -Documentation of resources. - -### Synopsis - - -Documentation of resources. - -Possible resource types include (case insensitive): pods (po), services (svc), deployments, -replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), -persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), -serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, -componentstatuses (cs), endpoints (ep), and secrets. - -``` -kubectl explain RESOURCE -``` - -### Examples - -``` -# Get the documentation of the resource and its fields -kubectl explain pods - -# Get the documentation of a specific field of a resource -kubectl explain pods.spec.containers -``` - -### Options - -``` - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --recursive[=false]: Print the fields of fields (Currently only 1 level deep) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_explain.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index 503ce447e20..c41ff65fb2b 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -32,118 +32,9 @@ Documentation for other releases can be found at -## kubectl expose - -Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service - -### Synopsis - - -Expose a resource as a new Kubernetes service. - -Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector -for that resource as the selector for a new service on the specified port. A deployment or replica set -will be exposed as a service only if its selector is convertible to a selector that service supports, -i.e. when the selector contains only the matchLabels component. Note that if no port is specified via ---port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no -labels are specified, the new service will re-use the labels from the resource it exposes. - -Possible resources include (case insensitive): - pod (po), service (svc), replicationcontroller (rc), - deployment, replicaset (rs) - - -``` -kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type] -``` - -### Examples - -``` -# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. -kubectl expose rc nginx --port=80 --target-port=8000 - -# Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. -kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000 - -# Create a service for a pod valid-pod, which serves on port 444 with the name "frontend" -kubectl expose pod valid-pod --port=444 --name=frontend - -# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https" -kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https - -# Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'. -kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream - -# Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000. -kubectl expose rs nginx --port=80 --target-port=8000 - -# Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000. -kubectl expose deployment nginx --port=80 --target-port=8000 -``` - -### Options - -``` - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --external-ip="": Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to expose a service - --generator="service/v2": The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. - -l, --labels="": Labels to apply to the service created by this call. - --load-balancer-ip="": IP to assign to to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). - --name="": The name for the newly created object. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. - --port="": The port that the service should serve on. Copied from the resource being exposed, if unspecified - --protocol="": The network protocol for the service to be created. Default is 'TCP'. - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --selector="": A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set. - --session-affinity="": If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --target-port="": Name or number for the port on the container that the service should direct traffic to. Optional. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --type="": Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 13-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index f63c82a464d..e4d9e20a0e0 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -32,110 +32,9 @@ Documentation for other releases can be found at -## kubectl get - -Display one or many resources - -### Synopsis - - -Display one or many resources. - -Possible resource types include (case insensitive): pods (po), services (svc), deployments, -replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), -persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), -serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, -componentstatuses (cs), endpoints (ep), and secrets. - -By specifying the output as 'template' and providing a Go template as the value -of the --template flag, you can filter the attributes of the fetched resource(s). - -``` -kubectl get [(-o|--output=)json|yaml|wide|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags] -``` - -### Examples - -``` -# List all pods in ps output format. -kubectl get pods - -# List all pods in ps output format with more information (such as node name). -kubectl get pods -o wide - -# List a single replication controller with specified NAME in ps output format. -kubectl get replicationcontroller web - -# List a single pod in JSON output format. -kubectl get -o json pod web-pod-13je7 - -# List a pod identified by type and name specified in "pod.yaml" in JSON output format. -kubectl get -f pod.yaml -o json - -# Return only the phase value of the specified pod. -kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}} - -# List all replication controllers and services together in ps output format. -kubectl get rc,services - -# List one or more resources by their type and names. -kubectl get rc/web service/frontend pods/web-pod-13je7 -``` - -### Options - -``` - --all-namespaces[=false]: If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. - --export[=false]: If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information. - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -L, --label-columns=[]: Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag statements like -L label1 -L label2... - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - -R, --recursive[=false]: If true, process directory recursively. - -l, --selector="": Selector (label query) to filter on - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - -w, --watch[=false]: After listing/getting the requested object, watch for changes. - --watch-only[=false]: Watch for changes to the requested object(s), without listing/getting first. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_label.md b/docs/user-guide/kubectl/kubectl_label.md index 7fc87a65983..8acd794c722 100644 --- a/docs/user-guide/kubectl/kubectl_label.md +++ b/docs/user-guide/kubectl/kubectl_label.md @@ -32,100 +32,9 @@ Documentation for other releases can be found at -## kubectl label - -Update the labels on a resource - -### Synopsis - - -Update the labels on a resource. - -A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. -If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. -If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. - -``` -kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version] -``` - -### Examples - -``` -# Update pod 'foo' with the label 'unhealthy' and the value 'true'. -kubectl label pods foo unhealthy=true - -# Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value. -kubectl label --overwrite pods foo status=unhealthy - -# Update all pods in the namespace -kubectl label pods --all status=unhealthy - -# Update a pod identified by the type and name in "pod.json" -kubectl label -f pod.json status=unhealthy - -# Update pod 'foo' only if the resource is unchanged from version 1. -kubectl label pods foo status=unhealthy --resource-version=1 - -# Update pod 'foo' by removing a label named 'bar' if it exists. -# Does not require the --overwrite flag. -kubectl label pods foo bar- -``` - -### Options - -``` - --all[=false]: select all resources in the namespace of the specified resource types - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the labels - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --overwrite[=false]: If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --resource-version="": If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. - -l, --selector="": Selector (label query) to filter on - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_label.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index ceaefc7827a..51f8e6f8231 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -32,85 +32,9 @@ Documentation for other releases can be found at -## kubectl logs - -Print the logs for a container in a pod. - -### Synopsis - - -Print the logs for a container in a pod. If the pod has only one container, the container name is optional. - -``` -kubectl logs [-f] [-p] POD [-c CONTAINER] -``` - -### Examples - -``` -# Return snapshot logs from pod nginx with only one container -kubectl logs nginx - -# Return snapshot of previous terminated ruby container logs from pod web-1 -kubectl logs -p -c ruby web-1 - -# Begin streaming the logs of the ruby container in pod web-1 -kubectl logs -f -c ruby web-1 - -# Display only the most recent 20 lines of output in pod nginx -kubectl logs --tail=20 nginx - -# Show all logs from pod nginx written in the last hour -kubectl logs --since=1h nginx -``` - -### Options - -``` - -c, --container="": Print the logs of this container - -f, --follow[=false]: Specify if the logs should be streamed. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --limit-bytes=0: Maximum bytes of logs to return. Defaults to no limit. - -p, --previous[=false]: If true, print the logs for the previous instance of the container in a pod if it exists. - --since=0: Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. - --since-time="": Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. - --tail=-1: Lines of recent log file to display. Defaults to -1, showing all log lines. - --timestamps[=false]: Include timestamps on each line in the log output -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_logs.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_namespace.md b/docs/user-guide/kubectl/kubectl_namespace.md index 448360bd962..5c9f87ebebb 100644 --- a/docs/user-guide/kubectl/kubectl_namespace.md +++ b/docs/user-guide/kubectl/kubectl_namespace.md @@ -32,55 +32,9 @@ Documentation for other releases can be found at -## kubectl namespace - -SUPERSEDED: Set and view the current Kubernetes namespace - -### Synopsis - - -SUPERSEDED: Set and view the current Kubernetes namespace scope for command line requests. - -namespace has been superseded by the context.namespace field of .kubeconfig files. See 'kubectl config set-context --help' for more details. - - -``` -kubectl namespace [namespace] -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_namespace.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_patch.md b/docs/user-guide/kubectl/kubectl_patch.md index 3049698188f..efb95584da4 100644 --- a/docs/user-guide/kubectl/kubectl_patch.md +++ b/docs/user-guide/kubectl/kubectl_patch.md @@ -32,85 +32,9 @@ Documentation for other releases can be found at -## kubectl patch - -Update field(s) of a resource using strategic merge patch. - -### Synopsis - - -Update field(s) of a resource using strategic merge patch - -JSON and YAML formats are accepted. - -Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable. - -``` -kubectl patch (-f FILENAME | TYPE NAME) -p PATCH -``` - -### Examples - -``` - -# Partially update a node using strategic merge patch -kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' - -# Partially update a node identified by the type and name specified in "node.json" using strategic merge patch -kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}' - -# Update a container's image; spec.containers[*].name is required because it's a merge key -kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}' - -# Update a container's image using a json patch with positional arrays -kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]' -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). - -p, --patch="": The patch to be applied to the resource JSON file. - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --type="strategic": The type of patch being provided; one of [json merge strategic] -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 31-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_patch.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md index ea9ec494fab..a2d48c3723e 100644 --- a/docs/user-guide/kubectl/kubectl_port-forward.md +++ b/docs/user-guide/kubectl/kubectl_port-forward.md @@ -32,75 +32,9 @@ Documentation for other releases can be found at -## kubectl port-forward - -Forward one or more local ports to a pod. - -### Synopsis - - -Forward one or more local ports to a pod. - -``` -kubectl port-forward POD [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N] -``` - -### Examples - -``` - -# Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod -kubectl port-forward mypod 5000 6000 - -# Listen on port 8888 locally, forwarding to 5000 in the pod -kubectl port-forward mypod 8888:5000 - -# Listen on a random port locally, forwarding to 5000 in the pod -kubectl port-forward mypod :5000 - -# Listen on a random port locally, forwarding to 5000 in the pod -kubectl port-forward mypod 0:5000 -``` - -### Options - -``` - -p, --pod="": Pod name -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_port-forward.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_proxy.md b/docs/user-guide/kubectl/kubectl_proxy.md index 76c44d68af0..f7d79308315 100644 --- a/docs/user-guide/kubectl/kubectl_proxy.md +++ b/docs/user-guide/kubectl/kubectl_proxy.md @@ -32,98 +32,9 @@ Documentation for other releases can be found at -## kubectl proxy - -Run a proxy to the Kubernetes API server - -### Synopsis - - -To proxy all of the kubernetes api and nothing else, use: - -kubectl proxy --api-prefix=/ - -To proxy only part of the kubernetes api and also some static files: - -kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/ - -The above lets you 'curl localhost:8001/api/v1/pods'. - -To proxy the entire kubernetes api at a different root, use: - -kubectl proxy --api-prefix=/custom/ - -The above lets you 'curl localhost:8001/custom/api/v1/pods' - - -``` -kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix] -``` - -### Examples - -``` -# Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/ -kubectl proxy --port=8011 --www=./local/www/ - -# Run a proxy to kubernetes apiserver on an arbitrary local port. -# The chosen port for the server will be output to stdout. -kubectl proxy --port=0 - -# Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api -# This makes e.g. the pods api available at localhost:8011/k8s-api/v1/pods/ -kubectl proxy --api-prefix=/k8s-api -``` - -### Options - -``` - --accept-hosts="^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$": Regular expression for hosts that the proxy should accept. - --accept-paths="^/.*": Regular expression for paths that the proxy should accept. - --address="127.0.0.1": The IP address on which to serve on. - --api-prefix="/": Prefix to serve the proxied API under. - --disable-filter[=false]: If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. - -p, --port=8001: The port on which to run the proxy. Set to 0 to pick a random port. - --reject-methods="POST,PUT,PATCH": Regular expression for HTTP methods that the proxy should reject. - --reject-paths="^/api/.*/exec,^/api/.*/run,^/api/.*/attach": Regular expression for paths that the proxy should reject. - -u, --unix-socket="": Unix socket on which to run the proxy. - -w, --www="": Also serve static files from the given directory under the specified prefix. - -P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_proxy.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_replace.md b/docs/user-guide/kubectl/kubectl_replace.md index 8285b0c42b8..f5d6dd10bd4 100644 --- a/docs/user-guide/kubectl/kubectl_replace.md +++ b/docs/user-guide/kubectl/kubectl_replace.md @@ -32,91 +32,9 @@ Documentation for other releases can be found at -## kubectl replace - -Replace a resource by filename or stdin. - -### Synopsis - - -Replace a resource by filename or stdin. - -JSON and YAML formats are accepted. If replacing an existing resource, the -complete resource spec must be provided. This can be obtained by -$ kubectl get TYPE NAME -o yaml - -Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable. - -``` -kubectl replace -f FILENAME -``` - -### Examples - -``` -# Replace a pod using the data in pod.json. -kubectl replace -f ./pod.json - -# Replace a pod based on the JSON passed into stdin. -cat pod.json | kubectl replace -f - - -# Update a single-container pod's image version (tag) to v4 -kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f - - -# Force replace, delete and then re-create the resource -kubectl replace --force -f ./pod.json -``` - -### Options - -``` - --cascade[=false]: Only relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). - -f, --filename=[]: Filename, directory, or URL to file to use to replace the resource. - --force[=false]: Delete and re-create the specified resource - --grace-period=-1: Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - --timeout=0: Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_replace.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rolling-update.md b/docs/user-guide/kubectl/kubectl_rolling-update.md index f7c1d34cda4..1346b4acb37 100644 --- a/docs/user-guide/kubectl/kubectl_rolling-update.md +++ b/docs/user-guide/kubectl/kubectl_rolling-update.md @@ -32,102 +32,9 @@ Documentation for other releases can be found at -## kubectl rolling-update - -Perform a rolling update of the given ReplicationController. - -### Synopsis - - -Perform a rolling update of the given ReplicationController. - -Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the -new PodTemplate. The new-controller.json must specify the same namespace as the -existing replication controller and overwrite at least one (common) label in its replicaSelector. - -``` -kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC) -``` - -### Examples - -``` -# Update pods of frontend-v1 using new replication controller data in frontend-v2.json. -kubectl rolling-update frontend-v1 -f frontend-v2.json - -# Update pods of frontend-v1 using JSON data passed into stdin. -cat frontend-v2.json | kubectl rolling-update frontend-v1 -f - - -# Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the -# name of the replication controller. -kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2 - -# Update the pods of frontend by just changing the image, and keeping the old name. -kubectl rolling-update frontend --image=image:v2 - -# Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2). -kubectl rolling-update frontend-v1 frontend-v2 --rollback - -``` - -### Options - -``` - --container="": Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod - --deployment-label-key="deployment": The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when --image is specified, ignored otherwise - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - -f, --filename=[]: Filename or URL to file to use to create the new replication controller. - --image="": Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag). Can not be used with --filename/-f - --image-pull-policy="": Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --poll-interval=3s: Time delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - --rollback[=false]: If true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --timeout=5m0s: Max time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - --update-period=1m0s: Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 13-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rolling-update.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout.md b/docs/user-guide/kubectl/kubectl_rollout.md index 48c31cbc502..573f2205541 100644 --- a/docs/user-guide/kubectl/kubectl_rollout.md +++ b/docs/user-guide/kubectl/kubectl_rollout.md @@ -32,64 +32,9 @@ Documentation for other releases can be found at -## kubectl rollout - -rollout manages a deployment - -### Synopsis - - -Manages a deployment using subcommands like "kubectl rollout undo deployment/abc" - -``` -kubectl rollout SUBCOMMAND -``` - -### Examples - -``` -# Rollback to the previous deployment -kubectl rollout undo deployment/abc -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -* [kubectl rollout history](kubectl_rollout_history.md) - view rollout history -* [kubectl rollout pause](kubectl_rollout_pause.md) - Mark the provided resource as paused -* [kubectl rollout resume](kubectl_rollout_resume.md) - Resume a paused resource -* [kubectl rollout status](kubectl_rollout_status.md) - Watch rollout status until it's done -* [kubectl rollout undo](kubectl_rollout_undo.md) - undoes a previous rollout - -###### Auto generated by spf13/cobra on 10-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout_history.md b/docs/user-guide/kubectl/kubectl_rollout_history.md index 077ee267823..df4fb9cc12e 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_history.md +++ b/docs/user-guide/kubectl/kubectl_rollout_history.md @@ -32,70 +32,9 @@ Documentation for other releases can be found at -## kubectl rollout history - -view rollout history - -### Synopsis - - -View previous rollout revisions and configurations. - -``` -kubectl rollout history (TYPE NAME | TYPE/NAME) [flags] -``` - -### Examples - -``` -# View the rollout history of a deployment -kubectl rollout history deployment/abc - -# View the details of deployment revision 3 -kubectl rollout history deployment/abc --revision=3 -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - -R, --recursive[=false]: If true, process directory recursively. - --revision=0: See the details, including podTemplate of the revision specified -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment - -###### Auto generated by spf13/cobra on 6-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_history.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout_pause.md b/docs/user-guide/kubectl/kubectl_rollout_pause.md index 7368578fb12..6bf054a873e 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_pause.md +++ b/docs/user-guide/kubectl/kubectl_rollout_pause.md @@ -32,72 +32,9 @@ Documentation for other releases can be found at -## kubectl rollout pause - -Mark the provided resource as paused - -### Synopsis - - -Mark the provided resource as paused - -Paused resources will not be reconciled by a controller. -Use \"kubectl rollout resume\" to resume a paused resource. -Currently only deployments support being paused. - -``` -kubectl rollout pause RESOURCE -``` - -### Examples - -``` -# Mark the nginx deployment as paused. Any current state of -# the deployment will continue its function, new updates to the deployment will not -# have an effect as long as the deployment is paused. -kubectl rollout pause deployment/nginx -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - -R, --recursive[=false]: If true, process directory recursively. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment - -###### Auto generated by spf13/cobra on 6-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_pause.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout_resume.md b/docs/user-guide/kubectl/kubectl_rollout_resume.md index d0ed8cfafe8..34f258bacf1 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_resume.md +++ b/docs/user-guide/kubectl/kubectl_rollout_resume.md @@ -32,70 +32,9 @@ Documentation for other releases can be found at -## kubectl rollout resume - -Resume a paused resource - -### Synopsis - - -Resume a paused resource - -Paused resources will not be reconciled by a controller. By resuming a -resource, we allow it to be reconciled again. -Currently only deployments support being resumed. - -``` -kubectl rollout resume RESOURCE -``` - -### Examples - -``` -# Resume an already paused deployment -kubectl rollout resume deployment/nginx -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - -R, --recursive[=false]: If true, process directory recursively. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment - -###### Auto generated by spf13/cobra on 6-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_resume.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout_status.md b/docs/user-guide/kubectl/kubectl_rollout_status.md index 37180089cfe..35a88f8100b 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_status.md +++ b/docs/user-guide/kubectl/kubectl_rollout_status.md @@ -27,66 +27,9 @@ Documentation for other releases can be found at -## kubectl rollout status - -Watch rollout status until it's done - -### Synopsis - - -Watch the status of current rollout, until it's done. - -``` -kubectl rollout status (TYPE NAME | TYPE/NAME) [flags] -``` - -### Examples - -``` -# Watch the rollout status of a deployment -kubectl rollout status deployment/nginx -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - -R, --recursive[=false]: If true, process directory recursively. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment - -###### Auto generated by spf13/cobra on 10-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_status.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_rollout_undo.md b/docs/user-guide/kubectl/kubectl_rollout_undo.md index 0aa6ebd6417..bcec8e4184a 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_undo.md +++ b/docs/user-guide/kubectl/kubectl_rollout_undo.md @@ -32,70 +32,9 @@ Documentation for other releases can be found at -## kubectl rollout undo - -undoes a previous rollout - -### Synopsis - - -Rollback to a previous rollout. - -``` -kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags] -``` - -### Examples - -``` -# Rollback to the previous deployment -kubectl rollout undo deployment/abc - -# Rollback to deployment revision 3 -kubectl rollout undo deployment/abc --to-revision=3 -``` - -### Options - -``` - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - -R, --recursive[=false]: If true, process directory recursively. - --to-revision=0: The revision to rollback to. Default to 0 (last revision). -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment - -###### Auto generated by spf13/cobra on 6-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_undo.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md index 0cc501a63f7..b997beec20e 100644 --- a/docs/user-guide/kubectl/kubectl_run.md +++ b/docs/user-guide/kubectl/kubectl_run.md @@ -32,123 +32,9 @@ Documentation for other releases can be found at -## kubectl run - -Run a particular image on the cluster. - -### Synopsis - - -Create and run a particular image, possibly replicated. -Creates a deployment or job to manage the created container(s). - -``` -kubectl run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...] -``` - -### Examples - -``` -# Start a single instance of nginx. -kubectl run nginx --image=nginx - -# Start a single instance of hazelcast and let the container expose port 5701 . -kubectl run hazelcast --image=hazelcast --port=5701 - -# Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container. -kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default" - -# Start a replicated instance of nginx. -kubectl run nginx --image=nginx --replicas=5 - -# Dry run. Print the corresponding API objects without creating them. -kubectl run nginx --image=nginx --dry-run - -# Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON. -kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }' - -# Start a pod of busybox and keep it in the foreground, don't restart it if it exits. -kubectl run -i -t busybox --image=busybox --restart=Never - -# Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command. -kubectl run nginx --image=nginx -- ... - -# Start the nginx container using a different command and custom arguments. -kubectl run nginx --image=nginx --command -- ... - -# Start the perl container to compute π to 2000 places and print it out. -kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)' -``` - -### Options - -``` - --attach[=false]: If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true. - --command[=false]: If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --env=[]: Environment variables to set in the container - --expose[=false]: If true, a public, external service is created for the container(s) which are run - --generator="": The name of the API generator to use. Default is 'deployment/v1beta1' if --restart=Always, 'job/v1' for OnFailure and 'run-pod/v1' for Never. This will happen only for cluster version at least 1.3, for 1.2 we will fallback to 'deployment/v1beta1' for --restart=Always, 'job/v1' for others, for olders we will fallback to 'run/v1' for --restart=Always, 'run-pod/v1' for others. - --hostport=-1: The host port mapping for the container port. To demonstrate a single-machine container. - --image="": The image for the container to run. - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -l, --labels="": Labels to apply to the pod(s). - --leave-stdin-open[=false]: If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. - --limits="": The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. - --port=-1: The port that this container exposes. If --expose is true, this is also the port used by the service that is created. - --record[=false]: Record current kubectl command in the resource annotation. - -r, --replicas=1: Number of replicas to create for this container. Default is 1. - --requests="": The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges. - --restart="Always": The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to 'OnFailure', a job is created for this pod, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always' - --rm[=false]: If true, delete resources created in this command for attached containers. - --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. - --service-generator="service/v2": The name of the generator to use for creating a service. Only used if --expose is true - --service-overrides="": An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true. - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - -i, --stdin[=false]: Keep stdin open on the container(s) in the pod, even if nothing is attached. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - -t, --tty[=false]: Allocated a TTY for each container in the pod. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 1-Jun-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_run.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md index 9d4cdf319ad..0961f0de169 100644 --- a/docs/user-guide/kubectl/kubectl_scale.md +++ b/docs/user-guide/kubectl/kubectl_scale.md @@ -32,90 +32,9 @@ Documentation for other releases can be found at -## kubectl scale - -Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. - -### Synopsis - - -Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. - -Scale also allows users to specify one or more preconditions for the scale action. -If --current-replicas or --resource-version is specified, it is validated before the -scale is attempted, and it is guaranteed that the precondition holds true when the -scale is sent to the server. - -``` -kubectl scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME) -``` - -### Examples - -``` -# Scale a replicaset named 'foo' to 3. -kubectl scale --replicas=3 rs/foo - -# Scale a resource identified by type and name specified in "foo.yaml" to 3. -kubectl scale --replicas=3 -f foo.yaml - -# If the deployment named mysql's current size is 2, scale mysql to 3. -kubectl scale --current-replicas=2 --replicas=3 deployment/mysql - -# Scale multiple replication controllers. -kubectl scale --replicas=5 rc/foo rc/bar rc/baz - -# Scale job named 'cron' to 3. -kubectl scale --replicas=3 job/cron -``` - -### Options - -``` - --current-replicas=-1: Precondition for current size. Requires that the current size of the resource match this value in order to scale. - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to set a new size - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - --replicas=-1: The new desired number of replicas. Required. - --resource-version="": Precondition for resource version. Requires that the current resource version match this value in order to scale. - --timeout=0: The length of time to wait before giving up on a scale operation, zero means don't wait. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 30-Mar-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_scale.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_set.md b/docs/user-guide/kubectl/kubectl_set.md index f72666226bb..2c5b5dc03cc 100644 --- a/docs/user-guide/kubectl/kubectl_set.md +++ b/docs/user-guide/kubectl/kubectl_set.md @@ -27,55 +27,9 @@ Documentation for other releases can be found at -## kubectl set - -Set specific features on objects - -### Synopsis - - -Configure application resources - -These commands help you make changes to existing application resources. - -``` -kubectl set SUBCOMMAND -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -* [kubectl set image](kubectl_set_image.md) - Update image of a pod template - -###### Auto generated by spf13/cobra on 10-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_set.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_set_image.md b/docs/user-guide/kubectl/kubectl_set_image.md index f8c4344e0d1..7a49547ad60 100644 --- a/docs/user-guide/kubectl/kubectl_set_image.md +++ b/docs/user-guide/kubectl/kubectl_set_image.md @@ -27,89 +27,9 @@ Documentation for other releases can be found at -## kubectl set image - -Update image of a pod template - -### Synopsis - - -Update existing container image(s) of resources. - -Possible resources include (case insensitive): - pod (po), replicationcontroller (rc), deployment, daemonset (ds), job, replicaset (rs) - -``` -kubectl set image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N -``` - -### Examples - -``` -# Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'. -kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1 - -# Update all deployments' and rc's nginx container's image to 'nginx:1.9.1' -kubectl set image deployments,rc nginx=nginx:1.9.1 --all - -# Update image of all containers of daemonset abc to 'nginx:1.9.1' -kubectl set image daemonset abc *=nginx:1.9.1 - -# Print result (in yaml format) of updating nginx container image from local file, without hitting the server -kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml -``` - -### Options - -``` - --all[=false]: select all resources in the namespace of the specified resource types - -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. - --local[=false]: If true, set image will NOT contact api-server but run locally. - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --record[=false]: Record current kubectl command in the resource annotation. - -R, --recursive[=false]: If true, process directory recursively. - -l, --selector="": Selector (label query) to filter on - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl set](kubectl_set.md) - Set specific features on objects - -###### Auto generated by spf13/cobra on 17-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_set_image.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_taint.md b/docs/user-guide/kubectl/kubectl_taint.md index c7187d18542..0be1adff338 100644 --- a/docs/user-guide/kubectl/kubectl_taint.md +++ b/docs/user-guide/kubectl/kubectl_taint.md @@ -27,86 +27,9 @@ Documentation for other releases can be found at -## kubectl taint - -Update the taints on one or more nodes - -### Synopsis - - -Update the taints on one or more nodes. - -A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. -The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. -The effect must be NoSchedule or PreferNoSchedule. -Currently taint can only apply to node. - -``` -kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N -``` - -### Examples - -``` -# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. -# If a taint with that key already exists, its value and effect are replaced as specified. -kubectl taint nodes foo dedicated=special-user:NoSchedule -# Remove from node 'foo' the taint with key 'dedicated' if one exists. -kubectl taint nodes foo dedicated- -``` - -### Options - -``` - --all[=false]: select all nodes in the cluster - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] - --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. - --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). - --overwrite[=false]: If true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. - --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' - -l, --selector="": Selector (label query) to filter on - -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) - --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) - --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. - --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --validate[=true]: If true, use a schema to validate the input before sending it -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 17-May-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_taint.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_uncordon.md b/docs/user-guide/kubectl/kubectl_uncordon.md index 35169d6ca82..f27740ee3e9 100644 --- a/docs/user-guide/kubectl/kubectl_uncordon.md +++ b/docs/user-guide/kubectl/kubectl_uncordon.md @@ -32,61 +32,9 @@ Documentation for other releases can be found at -## kubectl uncordon - -Mark node as schedulable - -### Synopsis - - -Mark node as schedulable. - - -``` -kubectl uncordon NODE -``` - -### Examples - -``` -# Mark node "foo" as schedulable. -$ kubectl uncordon foo - -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_uncordon.md?pixel)]() diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index f3a8af39502..f3f50cb4555 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -32,58 +32,9 @@ Documentation for other releases can be found at -## kubectl version - -Print the client and server version information. - -### Synopsis - - -Print the client and server version information. - -``` -kubectl version -``` - -### Options - -``` - --client[=false]: Client version only (no server required). -``` - -### Options inherited from parent commands - -``` - --alsologtostderr[=false]: log to standard error as well as files - --as="": Username to impersonate for the operation. - --certificate-authority="": Path to a cert. file for the certificate authority. - --client-certificate="": Path to a client certificate file for TLS. - --client-key="": Path to a client key file for TLS. - --cluster="": The name of the kubeconfig cluster to use - --context="": The name of the kubeconfig context to use - --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. - --kubeconfig="": Path to the kubeconfig file to use for CLI requests. - --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace - --log-dir="": If non-empty, write log files in this directory - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --logtostderr[=true]: log to standard error instead of files - --match-server-version[=false]: Require server version to match client version - --namespace="": If present, the namespace scope for this CLI request. - --password="": Password for basic authentication to the API server. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --token="": Bearer token for authentication to the API server. - --user="": The name of the kubeconfig user to use - --username="": Username for basic authentication to the API server. - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager - -###### Auto generated by spf13/cobra on 5-Apr-2016 +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_version.md?pixel)]() diff --git a/docs/yaml/kubectl/kubectl.yaml b/docs/yaml/kubectl/kubectl.yaml index c80267363e5..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl.yaml +++ b/docs/yaml/kubectl/kubectl.yaml @@ -1,103 +1,3 @@ -name: kubectl -synopsis: kubectl controls the Kubernetes cluster manager -description: |- - kubectl controls the Kubernetes cluster manager. - - Find more information at https://github.com/kubernetes/kubernetes. -options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -see_also: -- get -- set -- describe -- create -- replace -- patch -- delete -- edit -- apply -- namespace -- logs -- rolling-update -- scale -- cordon -- drain -- uncordon -- attach -- exec -- port-forward -- proxy -- run -- stop -- expose -- autoscale -- rollout -- label -- annotate -- taint -- config -- cluster-info -- api-versions -- version -- explain -- convert -- completion +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_annotate.yaml b/docs/yaml/kubectl/kubectl_annotate.yaml index ba5307f7461..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_annotate.yaml +++ b/docs/yaml/kubectl/kubectl_annotate.yaml @@ -1,154 +1,3 @@ -name: annotate -synopsis: Update the annotations on a resource -description: | - Update the annotations on one or more resources. - - An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data. - It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions. - If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. - If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. - - Possible resources include (case insensitive): - pod (po), service (svc), replicationcontroller (rc), - node (no), event (ev), componentstatuse (cs), - limitrange (limits), persistentvolume (pv), persistentvolumeclaim (pvc), - horizontalpodautoscaler (hpa), resourcequota (quota), secret -options: -- name: all - default_value: "false" - usage: | - select all resources in the namespace of the specified resource types -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file identifying the resource to update the annotation -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: overwrite - default_value: "false" - usage: | - If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: resource-version - usage: | - If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. -- name: selector - shorthand: l - usage: Selector (label query) to filter on -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Update pod 'foo' with the annotation 'description' and the value 'my frontend'. - # If the same annotation is set multiple times, only the last value will be applied - kubectl annotate pods foo description='my frontend' - - # Update a pod identified by type and name in "pod.json" - kubectl annotate -f pod.json description='my frontend' - - # Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value. - kubectl annotate --overwrite pods foo description='my frontend running nginx' - - # Update all pods in the namespace - kubectl annotate pods --all description='my frontend running nginx' - - # Update pod 'foo' only if the resource is unchanged from version 1. - kubectl annotate pods foo description='my frontend running nginx' --resource-version=1 - - # Update pod 'foo' by removing an annotation named 'description' if it exists. - # Does not require the --overwrite flag. - kubectl annotate pods foo description- -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_api-versions.yaml b/docs/yaml/kubectl/kubectl_api-versions.yaml index eae489900a7..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_api-versions.yaml +++ b/docs/yaml/kubectl/kubectl_api-versions.yaml @@ -1,66 +1,3 @@ -name: api-versions -synopsis: | - Print the supported API versions on the server, in the form of "group/version". -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_apply.yaml b/docs/yaml/kubectl/kubectl_apply.yaml index 9c768600c7f..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_apply.yaml +++ b/docs/yaml/kubectl/kubectl_apply.yaml @@ -1,104 +1,3 @@ -name: apply -synopsis: Apply a configuration to a resource by filename or stdin -description: "Apply a configuration to a resource by filename or stdin.\nThe resource - will be created if it doesn't exist yet. \nTo use 'apply', always create the resource - initially with either 'apply' or 'create --save-config'.\n\nJSON and YAML formats - are accepted." -options: -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to file that contains the configuration to apply -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: output - shorthand: o - usage: | - Output mode. Use "-o name" for shorter output (resource/name). -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: schema-cache-dir - default_value: ~/.kube/schema - usage: | - If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -- name: validate - default_value: "true" - usage: | - If true, use a schema to validate the input before sending it -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Apply the configuration in pod.json to a pod. - kubectl apply -f ./pod.json - - # Apply the JSON passed into stdin to a pod. - cat pod.json | kubectl apply -f - -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_attach.yaml b/docs/yaml/kubectl/kubectl_attach.yaml index 56620043ff8..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_attach.yaml +++ b/docs/yaml/kubectl/kubectl_attach.yaml @@ -1,90 +1,3 @@ -name: attach -synopsis: Attach to a running container. -description: | - Attach to a process that is already running inside an existing container. -options: -- name: container - shorthand: c - usage: | - Container name. If omitted, the first container in the pod will be chosen -- name: stdin - shorthand: i - default_value: "false" - usage: Pass stdin to the container -- name: tty - shorthand: t - default_value: "false" - usage: Stdin is a TTY -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Get output from running pod 123456-7890, using the first container by default - kubectl attach 123456-7890 - - # Get output from ruby-container from pod 123456-7890 - kubectl attach 123456-7890 -c ruby-container - - # Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-7890 - # and sends stdout/stderr from 'bash' back to the client - kubectl attach 123456-7890 -c ruby-container -i -t -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_autoscale.yaml b/docs/yaml/kubectl/kubectl_autoscale.yaml index 22af59e2d01..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_autoscale.yaml +++ b/docs/yaml/kubectl/kubectl_autoscale.yaml @@ -1,146 +1,3 @@ -name: autoscale -synopsis: | - Auto-scale a Deployment, ReplicaSet, or ReplicationController -description: |- - Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. - - Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. - An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. -options: -- name: cpu-percent - default_value: "-1" - usage: | - The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, the server will apply a default value. -- name: dry-run - default_value: "false" - usage: | - If true, only print the object that would be sent, without sending it. -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file identifying the resource to autoscale. -- name: generator - default_value: horizontalpodautoscaler/v1beta1 - usage: | - The name of the API generator to use. Currently there is only 1 generator. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: max - default_value: "-1" - usage: | - The upper limit for the number of pods that can be set by the autoscaler. Required. -- name: min - default_value: "-1" - usage: | - The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. -- name: name - usage: | - The name for the newly created object. If not specified, the name of the input resource will be used. -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: save-config - default_value: "false" - usage: | - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Auto scale a deployment "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: - kubectl autoscale deployment foo --min=2 --max=10 - - # Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80%: - kubectl autoscale rc foo --max=5 --cpu-percent=80 -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_cluster-info.yaml b/docs/yaml/kubectl/kubectl_cluster-info.yaml index bc017e4cfd1..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_cluster-info.yaml +++ b/docs/yaml/kubectl/kubectl_cluster-info.yaml @@ -1,74 +1,3 @@ -name: cluster-info -synopsis: Display cluster info -description: |- - Display addresses of the master and services with label kubernetes.io/cluster-service=true - To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'. -options: -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -see_also: -- kubectl -- dump +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_completion.yaml b/docs/yaml/kubectl/kubectl_completion.yaml index 66cc3e3ef09..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_completion.yaml +++ b/docs/yaml/kubectl/kubectl_completion.yaml @@ -1,85 +1,3 @@ -name: completion -synopsis: | - Output shell completion code for the given shell (bash or zsh) -description: | - Output shell completion code for the given shell (bash or zsh). - - This command prints shell code which must be evaluation to provide interactive - completion of kubectl commands. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |2 - - $ source <(kubectl completion bash) - - will load the kubectl completion code for bash. Note that this depends on the bash-completion - framework. It must be sourced before sourcing the kubectl completion, i.e. on the Mac: - - $ brew install bash-completion - $ source $(brew --prefix)/etc/bash_completion - $ source <(kubectl completion bash) - - If you use zsh, the following will load kubectl zsh completion: - - $ source <(kubectl completion zsh) -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_config.yaml b/docs/yaml/kubectl/kubectl_config.yaml index c439c996ab8..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_config.yaml +++ b/docs/yaml/kubectl/kubectl_config.yaml @@ -1,81 +1,3 @@ -name: config -synopsis: config modifies kubeconfig files -description: | - config modifies kubeconfig files using subcommands like "kubectl config set current-context my-context" - - The loading order follows these rules: - 1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. - 2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged together. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. - 3. Otherwise, ${HOME}/.kube/config is used and no merging takes place. -options: -- name: kubeconfig - usage: use a particular kubeconfig file -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -see_also: -- kubectl -- view -- set-cluster -- set-credentials -- set-context -- set -- unset -- current-context -- use-context +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_convert.yaml b/docs/yaml/kubectl/kubectl_convert.yaml index ec651ba01ed..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_convert.yaml +++ b/docs/yaml/kubectl/kubectl_convert.yaml @@ -1,136 +1,3 @@ -name: convert -synopsis: Convert config files between different API versions -description: | - Convert config files between different API versions. Both YAML - and JSON formats are accepted. - - The command takes filename, directory, or URL as input, and convert it into format - of version specified by --output-version flag. If target version is not specified or - not supported, convert to latest version. - - The default output will be printed to stdout in YAML format. One can use -o option - to change to output destination. -options: -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to file to need to get converted. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: local - default_value: "true" - usage: | - If true, convert will NOT try to contact api-server but run locally. -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: schema-cache-dir - default_value: ~/.kube/schema - usage: | - If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -- name: validate - default_value: "true" - usage: | - If true, use a schema to validate the input before sending it -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: | - # Convert 'pod.yaml' to latest version and print to stdout. - kubectl convert -f pod.yaml - - # Convert the live state of the resource specified by 'pod.yaml' to the latest version - # and print to stdout in json format. - kubectl convert -f pod.yaml --local -o json - - # Convert all files under current directory to latest version and create them all. - kubectl convert -f . | kubectl create -f - -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_cordon.yaml b/docs/yaml/kubectl/kubectl_cordon.yaml index 9db7fb3862f..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_cordon.yaml +++ b/docs/yaml/kubectl/kubectl_cordon.yaml @@ -1,70 +1,3 @@ -name: cordon -synopsis: Mark node as unschedulable -description: | - Mark node as unschedulable. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: | - # Mark node "foo" as unschedulable. - kubectl cordon foo -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_create.yaml b/docs/yaml/kubectl/kubectl_create.yaml index 7c642dffb4d..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_create.yaml +++ b/docs/yaml/kubectl/kubectl_create.yaml @@ -1,112 +1,3 @@ -name: create -synopsis: Create a resource by filename or stdin -description: |- - Create a resource by filename or stdin. - - JSON and YAML formats are accepted. -options: -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to file to use to create the resource -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: output - shorthand: o - usage: | - Output mode. Use "-o name" for shorter output (resource/name). -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: save-config - default_value: "false" - usage: | - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. -- name: schema-cache-dir - default_value: ~/.kube/schema - usage: | - If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -- name: validate - default_value: "true" - usage: | - If true, use a schema to validate the input before sending it -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Create a pod using the data in pod.json. - kubectl create -f ./pod.json - - # Create a pod based on the JSON passed into stdin. - cat pod.json | kubectl create -f - -see_also: -- kubectl -- namespace -- secret -- configmap -- serviceaccount +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_delete.yaml b/docs/yaml/kubectl/kubectl_delete.yaml index b42ede19d6a..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_delete.yaml +++ b/docs/yaml/kubectl/kubectl_delete.yaml @@ -1,141 +1,3 @@ -name: delete -synopsis: | - Delete resources by filenames, stdin, resources and names, or by resources and label selector. -description: |- - Delete resources by filenames, stdin, resources and names, or by resources and label selector. - - JSON and YAML formats are accepted. - - Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector - - Note that the delete command does NOT do resource version checks, so if someone - submits an update to a resource right when you submit a delete, their update - will be lost along with the rest of the resource. -options: -- name: all - default_value: "false" - usage: '[-all] to select all the specified resources.' -- name: cascade - default_value: "true" - usage: | - If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file containing the resource to delete. -- name: grace-period - default_value: "-1" - usage: | - Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. -- name: ignore-not-found - default_value: "false" - usage: | - Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: now - default_value: "false" - usage: | - If true, resources are force terminated without graceful deletion (same as --grace-period=0). -- name: output - shorthand: o - usage: | - Output mode. Use "-o name" for shorter output (resource/name). -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: selector - shorthand: l - usage: Selector (label query) to filter on. -- name: timeout - default_value: "0" - usage: | - The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Delete a pod using the type and name specified in pod.json. - kubectl delete -f ./pod.json - - # Delete a pod based on the type and name in the JSON passed into stdin. - cat pod.json | kubectl delete -f - - - # Delete pods and services with same names "baz" and "foo" - kubectl delete pod,service baz foo - - # Delete pods and services with label name=myLabel. - kubectl delete pods,services -l name=myLabel - - # Delete a pod immediately (no graceful shutdown) - kubectl delete pod foo --now - - # Delete a pod with UID 1234-56-7890-234234-456456. - kubectl delete pod 1234-56-7890-234234-456456 - - # Delete all pods - kubectl delete pods --all -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_describe.yaml b/docs/yaml/kubectl/kubectl_describe.yaml index 678fef12722..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_describe.yaml +++ b/docs/yaml/kubectl/kubectl_describe.yaml @@ -1,120 +1,3 @@ -name: describe -synopsis: Show details of a specific resource or group of resources -description: |- - Show details of a specific resource or group of resources. - - This command joins many API calls together to form a detailed description of a - given resource or group of resources. - - $ kubectl describe TYPE NAME_PREFIX - - will first check for an exact match on TYPE and NAME_PREFIX. If no such resource - exists, it will output details for every resource that has a name prefixed with NAME_PREFIX - - Possible resource types include (case insensitive): pods (po), services (svc), deployments, - replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), - persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), - serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, - componentstatuses (cs), endpoints (ep), and secrets. -options: -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file containing the resource to describe -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: selector - shorthand: l - usage: Selector (label query) to filter on -- name: show-events - default_value: "true" - usage: If true, display events related to the described object. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Describe a node - kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal - - # Describe a pod - kubectl describe pods/nginx - - # Describe a pod identified by type and name in "pod.json" - kubectl describe -f pod.json - - # Describe all pods - kubectl describe pods - - # Describe pods by label name=myLabel - kubectl describe po -l name=myLabel - - # Describe all pods managed by the 'frontend' replication controller (rc-created pods - # get the name of the rc as a prefix in the pod the name). - kubectl describe pods frontend -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_drain.yaml b/docs/yaml/kubectl/kubectl_drain.yaml index 33c13f45188..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_drain.yaml +++ b/docs/yaml/kubectl/kubectl_drain.yaml @@ -1,102 +1,3 @@ -name: drain -synopsis: Drain node in preparation for maintenance -description: | - Drain node in preparation for maintenance. - - The given node will be marked unschedulable to prevent new pods from arriving. - Then drain deletes all pods except mirror pods (which cannot be deleted through - the API server). If there are DaemonSet-managed pods, drain will not proceed - without --ignore-daemonsets, and regardless it will not delete any - DaemonSet-managed pods, because those pods would be immediately replaced by the - DaemonSet controller, which ignores unschedulable markings. If there are any - pods that are neither mirror pods nor managed--by ReplicationController, - ReplicaSet, DaemonSet or Job--, then drain will not delete any pods unless you - use --force. - - When you are ready to put the node back into service, use kubectl uncordon, which - will make the node schedulable again. -options: -- name: delete-local-data - default_value: "false" - usage: | - Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). -- name: force - default_value: "false" - usage: | - Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet. -- name: grace-period - default_value: "-1" - usage: | - Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. -- name: ignore-daemonsets - default_value: "false" - usage: Ignore DaemonSet-managed pods. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: | - # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. - $ kubectl drain foo --force - - # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. - $ kubectl drain foo --grace-period=900 -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_edit.yaml b/docs/yaml/kubectl/kubectl_edit.yaml index 7d9d6db2732..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_edit.yaml +++ b/docs/yaml/kubectl/kubectl_edit.yaml @@ -1,125 +1,3 @@ -name: edit -synopsis: Edit a resource on the server -description: |- - Edit a resource from the default editor. - - The edit command allows you to directly edit any API resource you can retrieve via the - command line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR - environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. - You can edit multiple objects, although changes are applied one at a time. The command - accepts filenames as well as command line arguments, although the files you point to must - be previously saved versions of resources. - - The files to edit will be output in the default API version, or a version specified - by --output-version. The default format is YAML - if you would like to edit in JSON - pass -o json. The flag --windows-line-endings can be used to force Windows line endings, - otherwise the default for your operating system will be used. - - In the event an error occurs while updating, a temporary file will be created on disk - that contains your unapplied changes. The most common error when updating a resource - is another editor changing the resource on the server. When this occurs, you will have - to apply your changes to the newer version of the resource, or update your temporary - saved copy to include the latest resource version. -options: -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to file to use to edit the resource -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: output - shorthand: o - default_value: yaml - usage: 'Output format. One of: yaml|json.' -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: save-config - default_value: "false" - usage: | - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. -- name: windows-line-endings - default_value: "false" - usage: Use Windows line-endings (default Unix line-endings) -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |2- - # Edit the service named 'docker-registry': - kubectl edit svc/docker-registry - - # Use an alternative editor - KUBE_EDITOR="nano" kubectl edit svc/docker-registry - - # Edit the service 'docker-registry' in JSON using the v1 API format: - kubectl edit svc/docker-registry --output-version=v1 -o json -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_exec.yaml b/docs/yaml/kubectl/kubectl_exec.yaml index ba20b93998e..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_exec.yaml +++ b/docs/yaml/kubectl/kubectl_exec.yaml @@ -1,88 +1,3 @@ -name: exec -synopsis: Execute a command in a container. -description: Execute a command in a container. -options: -- name: container - shorthand: c - usage: | - Container name. If omitted, the first container in the pod will be chosen -- name: pod - shorthand: p - usage: Pod name -- name: stdin - shorthand: i - default_value: "false" - usage: Pass stdin to the container -- name: tty - shorthand: t - default_value: "false" - usage: Stdin is a TTY -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: "# Get output from running 'date' from pod 123456-7890, using the first container - by default\nkubectl exec 123456-7890 date\n\t\n# Get output from running 'date' - in ruby-container from pod 123456-7890\nkubectl exec 123456-7890 -c ruby-container - date\n\n# Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from - pod 123456-7890\n# and sends stdout/stderr from 'bash' back to the client\nkubectl - exec 123456-7890 -c ruby-container -i -t -- bash -il" -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_explain.yaml b/docs/yaml/kubectl/kubectl_explain.yaml index 565aca130e3..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_explain.yaml +++ b/docs/yaml/kubectl/kubectl_explain.yaml @@ -1,87 +1,3 @@ -name: explain -synopsis: Documentation of resources. -description: |- - Documentation of resources. - - Possible resource types include (case insensitive): pods (po), services (svc), deployments, - replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), - persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), - serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, - componentstatuses (cs), endpoints (ep), and secrets. -options: -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: recursive - default_value: "false" - usage: Print the fields of fields (Currently only 1 level deep) -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Get the documentation of the resource and its fields - kubectl explain pods - - # Get the documentation of a specific field of a resource - kubectl explain pods.spec.containers -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_expose.yaml b/docs/yaml/kubectl/kubectl_expose.yaml index e9525b00a5c..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_expose.yaml +++ b/docs/yaml/kubectl/kubectl_expose.yaml @@ -1,185 +1,3 @@ -name: expose -synopsis: | - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service -description: "Expose a resource as a new Kubernetes service.\n\nLooks up a deployment, - service, replica set, replication controller or pod by name and uses the selector\nfor - that resource as the selector for a new service on the specified port. A deployment - or replica set\nwill be exposed as a service only if its selector is convertible - to a selector that service supports,\ni.e. when the selector contains only the matchLabels - component. Note that if no port is specified via\n--port and the exposed resource - has multiple ports, all will be re-used by the new service. Also if no \nlabels - are specified, the new service will re-use the labels from the resource it exposes.\n\nPossible - resources include (case insensitive):\n pod (po), service (svc), replicationcontroller - (rc),\n deployment, replicaset (rs)\n" -options: -- name: container-port - usage: Synonym for --target-port -- name: create-external-load-balancer - default_value: "false" - usage: | - If true, create an external load balancer for this service (trumped by --type). Implementation is cloud provider dependent. Default is 'false'. -- name: dry-run - default_value: "false" - usage: | - If true, only print the object that would be sent, without sending it. -- name: external-ip - usage: | - Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file identifying the resource to expose a service -- name: generator - default_value: service/v2 - usage: | - The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. -- name: labels - shorthand: l - usage: Labels to apply to the service created by this call. -- name: load-balancer-ip - usage: | - IP to assign to to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). -- name: name - usage: The name for the newly created object. -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: overrides - usage: | - An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. -- name: port - usage: | - The port that the service should serve on. Copied from the resource being exposed, if unspecified -- name: protocol - usage: | - The network protocol for the service to be created. Default is 'TCP'. -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: save-config - default_value: "false" - usage: | - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. -- name: selector - usage: | - A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set. -- name: session-affinity - usage: | - If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: target-port - usage: | - Name or number for the port on the container that the service should direct traffic to. Optional. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -- name: type - usage: | - Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. - kubectl expose rc nginx --port=80 --target-port=8000 - - # Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000. - kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000 - - # Create a service for a pod valid-pod, which serves on port 444 with the name "frontend" - kubectl expose pod valid-pod --port=444 --name=frontend - - # Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https" - kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https - - # Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'. - kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream - - # Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000. - kubectl expose rs nginx --port=80 --target-port=8000 - - # Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000. - kubectl expose deployment nginx --port=80 --target-port=8000 -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_get.yaml b/docs/yaml/kubectl/kubectl_get.yaml index 80d70009b46..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_get.yaml +++ b/docs/yaml/kubectl/kubectl_get.yaml @@ -1,164 +1,3 @@ -name: get -synopsis: Display one or many resources -description: |- - Display one or many resources. - - Possible resource types include (case insensitive): pods (po), services (svc), deployments, - replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), - persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), - serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, - componentstatuses (cs), endpoints (ep), and secrets. - - By specifying the output as 'template' and providing a Go template as the value - of the --template flag, you can filter the attributes of the fetched resource(s). -options: -- name: all-namespaces - default_value: "false" - usage: | - If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. -- name: export - default_value: "false" - usage: | - If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information. -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file identifying the resource to get from a server. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: label-columns - shorthand: L - default_value: '[]' - usage: | - Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag statements like -L label1 -L label2... -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: selector - shorthand: l - usage: Selector (label query) to filter on -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -- name: watch - shorthand: w - default_value: "false" - usage: | - After listing/getting the requested object, watch for changes. -- name: watch-only - default_value: "false" - usage: | - Watch for changes to the requested object(s), without listing/getting first. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # List all pods in ps output format. - kubectl get pods - - # List all pods in ps output format with more information (such as node name). - kubectl get pods -o wide - - # List a single replication controller with specified NAME in ps output format. - kubectl get replicationcontroller web - - # List a single pod in JSON output format. - kubectl get -o json pod web-pod-13je7 - - # List a pod identified by type and name specified in "pod.yaml" in JSON output format. - kubectl get -f pod.yaml -o json - - # Return only the phase value of the specified pod. - kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}} - - # List all replication controllers and services together in ps output format. - kubectl get rc,services - - # List one or more resources by their type and names. - kubectl get rc/web service/frontend pods/web-pod-13je7 -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_label.yaml b/docs/yaml/kubectl/kubectl_label.yaml index b16f695479f..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_label.yaml +++ b/docs/yaml/kubectl/kubectl_label.yaml @@ -1,150 +1,3 @@ -name: label -synopsis: Update the labels on a resource -description: |- - Update the labels on a resource. - - A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. - If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error. - If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. -options: -- name: all - default_value: "false" - usage: | - select all resources in the namespace of the specified resource types -- name: dry-run - default_value: "false" - usage: | - If true, only print the object that would be sent, without sending it. -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file identifying the resource to update the labels -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: overwrite - default_value: "false" - usage: | - If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: resource-version - usage: | - If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. -- name: selector - shorthand: l - usage: Selector (label query) to filter on -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Update pod 'foo' with the label 'unhealthy' and the value 'true'. - kubectl label pods foo unhealthy=true - - # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value. - kubectl label --overwrite pods foo status=unhealthy - - # Update all pods in the namespace - kubectl label pods --all status=unhealthy - - # Update a pod identified by the type and name in "pod.json" - kubectl label -f pod.json status=unhealthy - - # Update pod 'foo' only if the resource is unchanged from version 1. - kubectl label pods foo status=unhealthy --resource-version=1 - - # Update pod 'foo' by removing a label named 'bar' if it exists. - # Does not require the --overwrite flag. - kubectl label pods foo bar- -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_logs.yaml b/docs/yaml/kubectl/kubectl_logs.yaml index 09667195415..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_logs.yaml +++ b/docs/yaml/kubectl/kubectl_logs.yaml @@ -1,119 +1,3 @@ -name: logs -synopsis: Print the logs for a container in a pod. -description: | - Print the logs for a container in a pod. If the pod has only one container, the container name is optional. -options: -- name: container - shorthand: c - usage: Print the logs of this container -- name: follow - shorthand: f - default_value: "false" - usage: Specify if the logs should be streamed. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: interactive - default_value: "false" - usage: If true, prompt the user for input when required. -- name: limit-bytes - default_value: "0" - usage: Maximum bytes of logs to return. Defaults to no limit. -- name: previous - shorthand: p - default_value: "false" - usage: | - If true, print the logs for the previous instance of the container in a pod if it exists. -- name: since - default_value: "0" - usage: | - Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. -- name: since-time - usage: | - Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. -- name: tail - default_value: "-1" - usage: | - Lines of recent log file to display. Defaults to -1, showing all log lines. -- name: timestamps - default_value: "false" - usage: Include timestamps on each line in the log output -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Return snapshot logs from pod nginx with only one container - kubectl logs nginx - - # Return snapshot of previous terminated ruby container logs from pod web-1 - kubectl logs -p -c ruby web-1 - - # Begin streaming the logs of the ruby container in pod web-1 - kubectl logs -f -c ruby web-1 - - # Display only the most recent 20 lines of output in pod nginx - kubectl logs --tail=20 nginx - - # Show all logs from pod nginx written in the last hour - kubectl logs --since=1h nginx -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_namespace.yaml b/docs/yaml/kubectl/kubectl_namespace.yaml index eaf3fd37ac4..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_namespace.yaml +++ b/docs/yaml/kubectl/kubectl_namespace.yaml @@ -1,69 +1,3 @@ -name: namespace -synopsis: 'SUPERSEDED: Set and view the current Kubernetes namespace' -description: | - SUPERSEDED: Set and view the current Kubernetes namespace scope for command line requests. - - namespace has been superseded by the context.namespace field of .kubeconfig files. See 'kubectl config set-context --help' for more details. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_patch.yaml b/docs/yaml/kubectl/kubectl_patch.yaml index cf08306166b..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_patch.yaml +++ b/docs/yaml/kubectl/kubectl_patch.yaml @@ -1,112 +1,3 @@ -name: patch -synopsis: Update field(s) of a resource using strategic merge patch. -description: |- - Update field(s) of a resource using strategic merge patch - - JSON and YAML formats are accepted. - - Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable. -options: -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file identifying the resource to update -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: output - shorthand: o - usage: | - Output mode. Use "-o name" for shorter output (resource/name). -- name: patch - shorthand: p - usage: The patch to be applied to the resource JSON file. -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: type - default_value: strategic - usage: | - The type of patch being provided; one of [json merge strategic] -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |2- - - # Partially update a node using strategic merge patch - kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' - - # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch - kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}' - - # Update a container's image; spec.containers[*].name is required because it's a merge key - kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}' - - # Update a container's image using a json patch with positional arrays - kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]' -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_port-forward.yaml b/docs/yaml/kubectl/kubectl_port-forward.yaml index 45b71c79702..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_port-forward.yaml +++ b/docs/yaml/kubectl/kubectl_port-forward.yaml @@ -1,83 +1,3 @@ -name: port-forward -synopsis: Forward one or more local ports to a pod. -description: Forward one or more local ports to a pod. -options: -- name: pod - shorthand: p - usage: Pod name -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |2- - - # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod - kubectl port-forward mypod 5000 6000 - - # Listen on port 8888 locally, forwarding to 5000 in the pod - kubectl port-forward mypod 8888:5000 - - # Listen on a random port locally, forwarding to 5000 in the pod - kubectl port-forward mypod :5000 - - # Listen on a random port locally, forwarding to 5000 in the pod - kubectl port-forward mypod 0:5000 -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_proxy.yaml b/docs/yaml/kubectl/kubectl_proxy.yaml index eedd0717484..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_proxy.yaml +++ b/docs/yaml/kubectl/kubectl_proxy.yaml @@ -1,133 +1,3 @@ -name: proxy -synopsis: Run a proxy to the Kubernetes API server -description: | - To proxy all of the kubernetes api and nothing else, use: - - kubectl proxy --api-prefix=/ - - To proxy only part of the kubernetes api and also some static files: - - kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/ - - The above lets you 'curl localhost:8001/api/v1/pods'. - - To proxy the entire kubernetes api at a different root, use: - - kubectl proxy --api-prefix=/custom/ - - The above lets you 'curl localhost:8001/custom/api/v1/pods' -options: -- name: accept-hosts - default_value: ^localhost$,^127\.0\.0\.1$,^\[::1\]$ - usage: Regular expression for hosts that the proxy should accept. -- name: accept-paths - default_value: ^/.* - usage: Regular expression for paths that the proxy should accept. -- name: address - default_value: 127.0.0.1 - usage: The IP address on which to serve on. -- name: api-prefix - default_value: / - usage: Prefix to serve the proxied API under. -- name: disable-filter - default_value: "false" - usage: | - If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. -- name: port - shorthand: p - default_value: "8001" - usage: | - The port on which to run the proxy. Set to 0 to pick a random port. -- name: reject-methods - default_value: POST,PUT,PATCH - usage: | - Regular expression for HTTP methods that the proxy should reject. -- name: reject-paths - default_value: ^/api/.*/exec,^/api/.*/run,^/api/.*/attach - usage: Regular expression for paths that the proxy should reject. -- name: unix-socket - shorthand: u - usage: Unix socket on which to run the proxy. -- name: www - shorthand: w - usage: | - Also serve static files from the given directory under the specified prefix. -- name: www-prefix - shorthand: P - default_value: /static/ - usage: | - Prefix to serve static files under, if static file directory is specified. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/ - kubectl proxy --port=8011 --www=./local/www/ - - # Run a proxy to kubernetes apiserver on an arbitrary local port. - # The chosen port for the server will be output to stdout. - kubectl proxy --port=0 - - # Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api - # This makes e.g. the pods api available at localhost:8011/k8s-api/v1/pods/ - kubectl proxy --api-prefix=/k8s-api -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_replace.yaml b/docs/yaml/kubectl/kubectl_replace.yaml index a15d96a05a1..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_replace.yaml +++ b/docs/yaml/kubectl/kubectl_replace.yaml @@ -1,133 +1,3 @@ -name: replace -synopsis: Replace a resource by filename or stdin. -description: |- - Replace a resource by filename or stdin. - - JSON and YAML formats are accepted. If replacing an existing resource, the - complete resource spec must be provided. This can be obtained by - $ kubectl get TYPE NAME -o yaml - - Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable. -options: -- name: cascade - default_value: "false" - usage: | - Only relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to file to use to replace the resource. -- name: force - default_value: "false" - usage: Delete and re-create the specified resource -- name: grace-period - default_value: "-1" - usage: | - Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: output - shorthand: o - usage: | - Output mode. Use "-o name" for shorter output (resource/name). -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: save-config - default_value: "false" - usage: | - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. -- name: schema-cache-dir - default_value: ~/.kube/schema - usage: | - If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -- name: timeout - default_value: "0" - usage: | - Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object -- name: validate - default_value: "true" - usage: | - If true, use a schema to validate the input before sending it -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Replace a pod using the data in pod.json. - kubectl replace -f ./pod.json - - # Replace a pod based on the JSON passed into stdin. - cat pod.json | kubectl replace -f - - - # Update a single-container pod's image version (tag) to v4 - kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f - - - # Force replace, delete and then re-create the resource - kubectl replace --force -f ./pod.json -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_rolling-update.yaml b/docs/yaml/kubectl/kubectl_rolling-update.yaml index b30ebfbfe71..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_rolling-update.yaml +++ b/docs/yaml/kubectl/kubectl_rolling-update.yaml @@ -1,163 +1,3 @@ -name: rolling-update -synopsis: Perform a rolling update of the given ReplicationController. -description: |- - Perform a rolling update of the given ReplicationController. - - Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the - new PodTemplate. The new-controller.json must specify the same namespace as the - existing replication controller and overwrite at least one (common) label in its replicaSelector. -options: -- name: container - usage: | - Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod -- name: deployment-label-key - default_value: deployment - usage: | - The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when --image is specified, ignored otherwise -- name: dry-run - default_value: "false" - usage: | - If true, only print the object that would be sent, without sending it. -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename or URL to file to use to create the new replication controller. -- name: image - usage: | - Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag). Can not be used with --filename/-f -- name: image-pull-policy - usage: | - Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: poll-interval - default_value: 3s - usage: | - Time delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". -- name: rollback - default_value: "false" - usage: | - If true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout -- name: schema-cache-dir - default_value: ~/.kube/schema - usage: | - If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -- name: timeout - default_value: 5m0s - usage: | - Max time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". -- name: update-period - default_value: 1m0s - usage: | - Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". -- name: validate - default_value: "true" - usage: | - If true, use a schema to validate the input before sending it -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: | - # Update pods of frontend-v1 using new replication controller data in frontend-v2.json. - kubectl rolling-update frontend-v1 -f frontend-v2.json - - # Update pods of frontend-v1 using JSON data passed into stdin. - cat frontend-v2.json | kubectl rolling-update frontend-v1 -f - - - # Update the pods of frontend-v1 to frontend-v2 by just changing the image, and switching the - # name of the replication controller. - kubectl rolling-update frontend-v1 frontend-v2 --image=image:v2 - - # Update the pods of frontend by just changing the image, and keeping the old name. - kubectl rolling-update frontend --image=image:v2 - - # Abort and reverse an existing rollout in progress (from frontend-v1 to frontend-v2). - kubectl rolling-update frontend-v1 frontend-v2 --rollback -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_rollout.yaml b/docs/yaml/kubectl/kubectl_rollout.yaml index db3ec1976b7..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_rollout.yaml +++ b/docs/yaml/kubectl/kubectl_rollout.yaml @@ -1,75 +1,3 @@ -name: rollout -synopsis: rollout manages a deployment -description: | - Manages a deployment using subcommands like "kubectl rollout undo deployment/abc" -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Rollback to the previous deployment - kubectl rollout undo deployment/abc -see_also: -- kubectl -- history -- pause -- resume -- undo -- status +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_run.yaml b/docs/yaml/kubectl/kubectl_run.yaml index 89f252de11a..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_run.yaml +++ b/docs/yaml/kubectl/kubectl_run.yaml @@ -1,212 +1,3 @@ -name: run -synopsis: Run a particular image on the cluster. -description: |- - Create and run a particular image, possibly replicated. - Creates a deployment or job to manage the created container(s). -options: -- name: attach - default_value: "false" - usage: | - If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true. -- name: command - default_value: "false" - usage: | - If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. -- name: dry-run - default_value: "false" - usage: | - If true, only print the object that would be sent, without sending it. -- name: env - default_value: '[]' - usage: Environment variables to set in the container -- name: expose - default_value: "false" - usage: | - If true, a public, external service is created for the container(s) which are run -- name: generator - usage: | - The name of the API generator to use. Default is 'deployment/v1beta1' if --restart=Always, 'job/v1' for OnFailure and 'run-pod/v1' for Never. This will happen only for cluster version at least 1.3, for 1.2 we will fallback to 'deployment/v1beta1' for --restart=Always, 'job/v1' for others, for olders we will fallback to 'run/v1' for --restart=Always, 'run-pod/v1' for others. -- name: hostport - default_value: "-1" - usage: | - The host port mapping for the container port. To demonstrate a single-machine container. -- name: image - usage: The image for the container to run. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: labels - shorthand: l - usage: Labels to apply to the pod(s). -- name: leave-stdin-open - default_value: "false" - usage: | - If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. -- name: limits - usage: | - The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges. -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: overrides - usage: | - An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. -- name: port - default_value: "-1" - usage: | - The port that this container exposes. If --expose is true, this is also the port used by the service that is created. -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: replicas - shorthand: r - default_value: "1" - usage: | - Number of replicas to create for this container. Default is 1. -- name: requests - usage: | - The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges. -- name: restart - default_value: Always - usage: | - The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to 'OnFailure', a job is created for this pod, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always' -- name: rm - default_value: "false" - usage: | - If true, delete resources created in this command for attached containers. -- name: save-config - default_value: "false" - usage: | - If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. -- name: service-generator - default_value: service/v2 - usage: | - The name of the generator to use for creating a service. Only used if --expose is true -- name: service-overrides - usage: | - An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true. -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: stdin - shorthand: i - default_value: "false" - usage: | - Keep stdin open on the container(s) in the pod, even if nothing is attached. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -- name: tty - shorthand: t - default_value: "false" - usage: Allocated a TTY for each container in the pod. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Start a single instance of nginx. - kubectl run nginx --image=nginx - - # Start a single instance of hazelcast and let the container expose port 5701 . - kubectl run hazelcast --image=hazelcast --port=5701 - - # Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container. - kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default" - - # Start a replicated instance of nginx. - kubectl run nginx --image=nginx --replicas=5 - - # Dry run. Print the corresponding API objects without creating them. - kubectl run nginx --image=nginx --dry-run - - # Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON. - kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }' - - # Start a pod of busybox and keep it in the foreground, don't restart it if it exits. - kubectl run -i -t busybox --image=busybox --restart=Never - - # Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command. - kubectl run nginx --image=nginx -- ... - - # Start the nginx container using a different command and custom arguments. - kubectl run nginx --image=nginx --command -- ... - - # Start the perl container to compute π to 2000 places and print it out. - kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)' -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_scale.yaml b/docs/yaml/kubectl/kubectl_scale.yaml index 6ac6d0ce7c3..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_scale.yaml +++ b/docs/yaml/kubectl/kubectl_scale.yaml @@ -1,123 +1,3 @@ -name: scale -synopsis: | - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. -description: |- - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. - - Scale also allows users to specify one or more preconditions for the scale action. - If --current-replicas or --resource-version is specified, it is validated before the - scale is attempted, and it is guaranteed that the precondition holds true when the - scale is sent to the server. -options: -- name: current-replicas - default_value: "-1" - usage: | - Precondition for current size. Requires that the current size of the resource match this value in order to scale. -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to a file identifying the resource to set a new size -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: output - shorthand: o - usage: | - Output mode. Use "-o name" for shorter output (resource/name). -- name: record - default_value: "false" - usage: Record current kubectl command in the resource annotation. -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: replicas - default_value: "-1" - usage: The new desired number of replicas. Required. -- name: resource-version - usage: | - Precondition for resource version. Requires that the current resource version match this value in order to scale. -- name: timeout - default_value: "0" - usage: | - The length of time to wait before giving up on a scale operation, zero means don't wait. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Scale a replicaset named 'foo' to 3. - kubectl scale --replicas=3 rs/foo - - # Scale a resource identified by type and name specified in "foo.yaml" to 3. - kubectl scale --replicas=3 -f foo.yaml - - # If the deployment named mysql's current size is 2, scale mysql to 3. - kubectl scale --current-replicas=2 --replicas=3 deployment/mysql - - # Scale multiple replication controllers. - kubectl scale --replicas=5 rc/foo rc/bar rc/baz - - # Scale job named 'cron' to 3. - kubectl scale --replicas=3 job/cron -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_set.yaml b/docs/yaml/kubectl/kubectl_set.yaml index 555ba331212..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_set.yaml +++ b/docs/yaml/kubectl/kubectl_set.yaml @@ -1,68 +1,3 @@ -name: set -synopsis: Set specific features on objects -description: "Configure application resources\n\t\nThese commands help you make changes - to existing application resources." -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -see_also: -- kubectl -- image +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_stop.yaml b/docs/yaml/kubectl/kubectl_stop.yaml index 833228dbcff..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_stop.yaml +++ b/docs/yaml/kubectl/kubectl_stop.yaml @@ -1,121 +1,3 @@ -name: stop -synopsis: | - Deprecated: Gracefully shut down a resource by name or filename. -description: |- - Deprecated: Gracefully shut down a resource by name or filename. - - The stop command is deprecated, all its functionalities are covered by delete command. - See 'kubectl delete --help' for more details. - - Attempts to shut down and delete a resource that supports graceful termination. - If the resource is scalable it will be scaled to 0 before deletion. -options: -- name: all - default_value: "false" - usage: '[-all] to select all the specified resources.' -- name: filename - shorthand: f - default_value: '[]' - usage: | - Filename, directory, or URL to file of resource(s) to be stopped. -- name: grace-period - default_value: "-1" - usage: | - Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. -- name: ignore-not-found - default_value: "false" - usage: Treat "resource not found" as a successful stop. -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: output - shorthand: o - usage: | - Output mode. Use "-o name" for shorter output (resource/name). -- name: recursive - shorthand: R - default_value: "false" - usage: If true, process directory recursively. -- name: selector - shorthand: l - usage: Selector (label query) to filter on. -- name: timeout - default_value: "0" - usage: | - The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Shut down foo. - kubectl stop replicationcontroller foo - - # Stop pods and services with label name=myLabel. - kubectl stop pods,services -l name=myLabel - - # Shut down the service defined in service.json - kubectl stop -f service.json - - # Shut down all resources in the path/to/resources directory - kubectl stop -f path/to/resources -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_taint.yaml b/docs/yaml/kubectl/kubectl_taint.yaml index 87f0aeaae96..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_taint.yaml +++ b/docs/yaml/kubectl/kubectl_taint.yaml @@ -1,127 +1,3 @@ -name: taint -synopsis: Update the taints on one or more nodes -description: |- - Update the taints on one or more nodes. - - A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. - The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. - The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. - The effect must be NoSchedule or PreferNoSchedule. - Currently taint can only apply to node. -options: -- name: all - default_value: "false" - usage: select all nodes in the cluster -- name: include-extended-apis - default_value: "true" - usage: | - If true, include definitions of new APIs via calls to the API server. [default true] -- name: no-headers - default_value: "false" - usage: When using the default output, don't print headers. -- name: output - shorthand: o - usage: | - Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md]. -- name: output-version - usage: | - Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). -- name: overwrite - default_value: "false" - usage: | - If true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. -- name: schema-cache-dir - default_value: ~/.kube/schema - usage: | - If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -- name: selector - shorthand: l - usage: Selector (label query) to filter on -- name: show-all - shorthand: a - default_value: "false" - usage: | - When printing, show all resources (default hide terminated pods.) -- name: show-labels - default_value: "false" - usage: | - When printing, show all labels as the last column (default hide labels column) -- name: sort-by - usage: | - If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -- name: template - usage: | - Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. -- name: validate - default_value: "true" - usage: | - If true, use a schema to validate the input before sending it -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: |- - # Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. - # If a taint with that key already exists, its value and effect are replaced as specified. - kubectl taint nodes foo dedicated=special-user:NoSchedule - # Remove from node 'foo' the taint with key 'dedicated' if one exists. - kubectl taint nodes foo dedicated- -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_uncordon.yaml b/docs/yaml/kubectl/kubectl_uncordon.yaml index 08078846e59..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_uncordon.yaml +++ b/docs/yaml/kubectl/kubectl_uncordon.yaml @@ -1,70 +1,3 @@ -name: uncordon -synopsis: Mark node as schedulable -description: | - Mark node as schedulable. -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -example: | - # Mark node "foo" as schedulable. - $ kubectl uncordon foo -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. diff --git a/docs/yaml/kubectl/kubectl_version.yaml b/docs/yaml/kubectl/kubectl_version.yaml index c01c2be4acd..b6fd7a0f989 100644 --- a/docs/yaml/kubectl/kubectl_version.yaml +++ b/docs/yaml/kubectl/kubectl_version.yaml @@ -1,69 +1,3 @@ -name: version -synopsis: Print the client and server version information. -options: -- name: client - default_value: "false" - usage: Client version only (no server required). -inherited_options: -- name: alsologtostderr - default_value: "false" - usage: log to standard error as well as files -- name: api-version - usage: | - DEPRECATED: The API version to use when talking to the server -- name: as - usage: Username to impersonate for the operation. -- name: certificate-authority - usage: Path to a cert. file for the certificate authority. -- name: client-certificate - usage: Path to a client certificate file for TLS. -- name: client-key - usage: Path to a client key file for TLS. -- name: cluster - usage: The name of the kubeconfig cluster to use -- name: context - usage: The name of the kubeconfig context to use -- name: insecure-skip-tls-verify - default_value: "false" - usage: | - If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. -- name: kubeconfig - usage: Path to the kubeconfig file to use for CLI requests. -- name: log-backtrace-at - default_value: :0 - usage: when logging hits line file:N, emit a stack trace -- name: log-dir - usage: If non-empty, write log files in this directory -- name: log-flush-frequency - default_value: 5s - usage: Maximum number of seconds between log flushes -- name: logtostderr - default_value: "true" - usage: log to standard error instead of files -- name: match-server-version - default_value: "false" - usage: Require server version to match client version -- name: namespace - usage: If present, the namespace scope for this CLI request. -- name: password - usage: Password for basic authentication to the API server. -- name: server - shorthand: s - usage: The address and port of the Kubernetes API server -- name: stderrthreshold - default_value: "2" - usage: logs at or above this threshold go to stderr -- name: token - usage: Bearer token for authentication to the API server. -- name: user - usage: The name of the kubeconfig user to use -- name: username - usage: Username for basic authentication to the API server. -- name: v - default_value: "0" - usage: log level for V logs -- name: vmodule - usage: | - comma-separated list of pattern=N settings for file-filtered logging -see_also: -- kubectl +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file.