Generating docs for v1.6.0-beta.0 on release-1.6.

kubernetes · Feb 22, 2017 · 609565b · 609565b
1 parent f7691fc
commit 609565b
Show file tree

Hide file tree

Showing 214 changed files with 38,630 additions and 642 deletions.
diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md
diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md
@@ -1,3 +1,48 @@
-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.
+## 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 ip                             The IP address to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
+      --cluster-monitor-period duration        The period for syncing ClusterStatus in ClusterController. (default 40s)
+      --concurrent-replicaset-syncs int        The number of ReplicaSets syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 10)
+      --concurrent-service-syncs int           The number of service syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 10)
+      --controllers mapStringString            A set of key=value pairs that describe controller configuration that may be passed to controller manager to enable/disable specific controllers. Valid options are: 
+ingress=true|false (default=true)
+      --dns-provider string                    DNS provider. Valid values are: ["google-clouddns" "aws-route53" "coredns"]
+      --dns-provider-config string             Path to config file for configuring DNS provider.
+      --federated-api-burst int                Burst to use while talking with federation apiserver (default 30)
+      --federated-api-qps float32              QPS to use while talking with federation apiserver (default 20)
+      --federation-name string                 Federation name.
+      --kube-api-content-type string           ContentType of requests sent to apiserver. Passing application/vnd.kubernetes.protobuf is an experimental feature now.
+      --kubeconfig string                      Path to kubeconfig file with authorization and master location information.
+      --leader-elect                           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 duration   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. (default 15s)
+      --leader-elect-renew-deadline duration   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. (default 10s)
+      --leader-elect-retry-period duration     The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s)
+      --master string                          The address of the federation API server (overrides any value in kubeconfig)
+      --port int                               The port that the controller-manager's http service runs on (default 10253)
+      --profiling                              Enable profiling via web interface host:port/debug/pprof/ (default true)
+      --service-dns-suffix string              DNS Suffix to use when publishing federated service names.  Defaults to zone-name
+      --zone-id string                         Zone ID, needed if the zone name is not unique.
+      --zone-name string                       Zone name, like example.com.
+```
+
+###### Auto generated by spf13/cobra on 21-Feb-2017
diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md
diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md
diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md
@@ -1,3 +1,61 @@
-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.
+## 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
+
+```
+      --azure-container-registry-config string       Path to the file container Azure container registry configuration information.
+      --bind-address ip                              The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0)
+      --cleanup-iptables                             If true cleanup iptables rules and exit.
+      --cluster-cidr string                          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 duration                  How often configuration from the apiserver is refreshed.  Must be greater than 0. (default 15m0s)
+      --conntrack-max-per-core int32                 Maximum number of NAT connections to track per CPU core (0 to leave the limit as-is and ignore conntrack-min). (default 32768)
+      --conntrack-min int32                          Minimum number of conntrack entries to allocate, regardless of conntrack-max-per-core (set conntrack-max-per-core=0 to leave the limit as-is). (default 131072)
+      --conntrack-tcp-timeout-close-wait duration    NAT timeout for TCP connections in the CLOSE_WAIT state (default 1h0m0s)
+      --conntrack-tcp-timeout-established duration   Idle timeout for established TCP connections (0 to leave as-is) (default 24h0m0s)
+      --feature-gates mapStringBool                  A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+AffinityInAnnotations=true|false (ALPHA - default=false)
+AllAlpha=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
+AppArmor=true|false (BETA - default=true)
+DynamicKubeletConfig=true|false (ALPHA - default=false)
+DynamicVolumeProvisioning=true|false (ALPHA - default=true)
+ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
+ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
+StreamingProxyRedirects=true|false (BETA - default=true)
+      --google-json-key string                       The Google Cloud Platform Service Account JSON Key to use for authentication.
+      --healthz-bind-address ip                      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) (default 127.0.0.1)
+      --healthz-port int32                           The port to bind the health check server. Use 0 to disable. (default 10249)
+      --hostname-override string                     If non-empty, will use this string as identification instead of the actual hostname.
+      --iptables-masquerade-bit int32                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]. (default 14)
+      --iptables-min-sync-period duration            The minimum interval of how often the iptables rules can be refreshed as endpoints and services change (e.g. '5s', '1m', '2h22m').
+      --iptables-sync-period duration                The maximum interval of how often iptables rules are refreshed (e.g. '5s', '1m', '2h22m').  Must be greater than 0. (default 30s)
+      --kube-api-burst int32                         Burst to use while talking with kubernetes apiserver (default 10)
+      --kube-api-content-type string                 Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
+      --kube-api-qps float32                         QPS to use while talking with kubernetes apiserver (default 5)
+      --kubeconfig string                            Path to kubeconfig file with authorization information (the master location is set by the master flag).
+      --masquerade-all                               If using the pure iptables proxy, SNAT everything
+      --master string                                The address of the Kubernetes API server (overrides any value in kubeconfig)
+      --oom-score-adj int32                          The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000] (default -999)
+      --proxy-mode ProxyMode                         Which proxy mode to use: 'userspace' (older) or 'iptables' (faster). If blank, 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 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 duration                         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 (default 250ms)
+```
+
+###### Auto generated by spf13/cobra on 21-Feb-2017
diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md
@@ -1,3 +1,54 @@
-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.
+## 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 string                           The IP address to serve on (set to 0.0.0.0 for all interfaces) (default "0.0.0.0")
+      --algorithm-provider string                The scheduling algorithm provider to use, one of: ClusterAutoscalerProvider | DefaultProvider (default "DefaultProvider")
+      --azure-container-registry-config string   Path to the file container Azure container registry configuration information.
+      --contention-profiling                     Enable lock contention profiling, if profiling is enabled
+      --feature-gates mapStringBool              A set of key=value pairs that describe feature gates for alpha/experimental features. Options are:
+AffinityInAnnotations=true|false (ALPHA - default=false)
+AllAlpha=true|false (ALPHA - default=false)
+AllowExtTrafficLocalEndpoints=true|false (BETA - default=true)
+AppArmor=true|false (BETA - default=true)
+DynamicKubeletConfig=true|false (ALPHA - default=false)
+DynamicVolumeProvisioning=true|false (ALPHA - default=true)
+ExperimentalCriticalPodAnnotation=true|false (ALPHA - default=false)
+ExperimentalHostUserNamespaceDefaulting=true|false (BETA - default=false)
+StreamingProxyRedirects=true|false (BETA - default=true)
+      --google-json-key string                   The Google Cloud Platform Service Account JSON Key to use for authentication.
+      --hard-pod-affinity-symmetric-weight int   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. (default 1)
+      --kube-api-burst int32                     Burst to use while talking with kubernetes apiserver (default 100)
+      --kube-api-content-type string             Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf")
+      --kube-api-qps float32                     QPS to use while talking with kubernetes apiserver (default 50)
+      --kubeconfig string                        Path to kubeconfig file with authorization and master location information.
+      --leader-elect                             Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. (default true)
+      --leader-elect-lease-duration duration     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. (default 15s)
+      --leader-elect-renew-deadline duration     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. (default 10s)
+      --leader-elect-retry-period duration       The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s)
+      --master string                            The address of the Kubernetes API server (overrides any value in kubeconfig)
+      --policy-config-file string                File with scheduler policy configuration
+      --port int32                               The port that the scheduler's http service runs on (default 10251)
+      --profiling                                Enable profiling via web interface host:port/debug/pprof/ (default true)
+      --scheduler-name string                    Name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's "spec.SchedulerName". (default "default-scheduler")
+```
+
+###### Auto generated by spf13/cobra on 21-Feb-2017