Skip to content

Commit

Permalink
Merge branch 'master' into verify-toc
Browse files Browse the repository at this point in the history
  • Loading branch information
janetkuo committed Jan 5, 2017
2 parents 701f01d + 50d34bd commit 65633ae
Show file tree
Hide file tree
Showing 119 changed files with 2,033 additions and 846 deletions.
1 change: 0 additions & 1 deletion OWNERS
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
assignees:
- lavalamp
- smarterclayton
- janetkuo
- pwittrock
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can click the **Fork** button in the upper-right area of the screen to creat

For more information about contributing to the Kubernetes documentation, see:

* [Contributing to the kubernetes Documentation](http://kubernetes.io/editdocs/)
* [Contributing to the Kubernetes Documentation](http://kubernetes.io/editdocs/)
* [Creating a Documentation Pull Request](http://kubernetes.io/docs/contribute/create-pull-request/)
* [Writing a New Topic](http://kubernetes.io/docs/contribute/write-new-topic/)
* [Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/stage-documentation-changes/)
Expand Down
41 changes: 36 additions & 5 deletions _data/guides.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ toc:
- docs/getting-started-guides/network-policy/walkthrough.md
- docs/getting-started-guides/network-policy/calico.md
- docs/getting-started-guides/network-policy/romana.md
- docs/getting-started-guides/network-policy/weave.md

- title: Batch Jobs
section:
Expand All @@ -67,7 +68,9 @@ toc:
- docs/user-guide/simple-nginx.md
- docs/user-guide/pods/single-container.md
- docs/user-guide/pods/multi-container.md
- docs/user-guide/pods/init-container.md
- docs/user-guide/configuring-containers.md
- docs/user-guide/pod-templates.md
- docs/user-guide/production-pods.md
- docs/user-guide/containers.md
- docs/user-guide/environment-guide/index.md
Expand All @@ -84,8 +87,11 @@ toc:
- title: Monitoring, Logging, and Debugging Containers
section:
- docs/user-guide/monitoring.md
- docs/getting-started-guides/logging.md
- docs/getting-started-guides/logging-elasticsearch.md
- title: Logging
section:
- docs/user-guide/logging/overview.md
- docs/user-guide/logging/stackdriver.md
- docs/user-guide/logging/elasticsearch.md
- docs/user-guide/getting-into-containers.md
- docs/user-guide/connecting-to-applications-proxy.md
- docs/user-guide/connecting-to-applications-port-forward.md
Expand Down Expand Up @@ -146,7 +152,11 @@ toc:
- docs/getting-started-guides/fedora/flannel_multi_node_cluster.md
- docs/getting-started-guides/centos/centos_manual_config.md
- docs/getting-started-guides/coreos/index.md
- /docs/getting-started-guides/ubuntu/
- title: Ubuntu
section:
- docs/getting-started-guides/ubuntu/automated.md
- docs/getting-started-guides/ubuntu/calico.md
- docs/getting-started-guides/ubuntu/manual.md
- docs/getting-started-guides/windows/index.md
- docs/admin/node-conformance.md
- docs/getting-started-guides/docker-multinode.md
Expand All @@ -160,11 +170,16 @@ toc:
- docs/admin/cluster-management.md
- docs/admin/kubeadm.md
- docs/admin/addons.md
- docs/admin/audit.md
- docs/admin/ha-master-gce.md
- docs/admin/namespaces/index.md
- docs/admin/namespaces/walkthrough.md
- docs/admin/limitrange/index.md
- docs/admin/disruptions.md
- docs/admin/resourcequota/index.md
- docs/admin/resourcequota/walkthrough.md
- docs/admin/rescheduler.md
- docs/admin/sysctls.md
- docs/admin/cluster-components.md
- docs/admin/etcd.md
- docs/admin/multi-cluster.md
Expand All @@ -186,5 +201,21 @@ toc:

- title: Administering Federation
section:
- /docs/admin/federation/kubfed/
- docs/admin/federation/index.md
- docs/admin/federation/kubefed.md
- title: Federated Kubernetes Objects
section:
- docs/user-guide/federation/index.md
- docs/user-guide/federation/configmap.md
- docs/user-guide/federation/daemonsets.md
- docs/user-guide/federation/deployment.md
- docs/user-guide/federation/events.md
- docs/user-guide/federation/federated-ingress.md
- docs/user-guide/federation/namespaces.md
- docs/user-guide/federation/replicasets.md
- docs/user-guide/federation/secrets.md
- docs/federation/api-reference/index.md
- title: Federation Components
section:
- docs/admin/federation-apiserver.md
- title : federation-controller-mananger
path: /docs/admin/federation-controller-manager
18 changes: 1 addition & 17 deletions _data/reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ toc:
- docs/admin/service-accounts-admin.md
- docs/api-reference/v1/operations.html
- docs/api-reference/v1/definitions.html
- docs/api-reference/labels-annotations-taints.md
- kubernetes/third_party/swagger-ui/index.md

- title: Autoscaling API
Expand Down Expand Up @@ -183,20 +184,3 @@ toc:
- title: Security in Kubernetes
path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security.md

- title: Federation
section:
- docs/user-guide/federation/index.md
- docs/user-guide/federation/configmap.md
- docs/user-guide/federation/daemonsets.md
- docs/user-guide/federation/deployment.md
- docs/user-guide/federation/events.md
- docs/user-guide/federation/federated-ingress.md
- docs/user-guide/federation/namespaces.md
- docs/user-guide/federation/replicasets.md
- docs/user-guide/federation/secrets.md
- docs/federation/api-reference/README.md
- title: Federation Components
section:
- docs/admin/federation-apiserver.md
- title : federation-controller-mananger
path: /docs/admin/federation-controller-manager
6 changes: 5 additions & 1 deletion _data/support.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ toc:
- docs/contribute/write-new-topic.md
- docs/contribute/stage-documentation-changes.md
- docs/contribute/page-templates.md
- docs/contribute/review-issues.md
- docs/contribute/style-guide.md


- title: Troubleshooting
section:
- docs/user-guide/debugging-pods-and-replication-controllers.md
- docs/user-guide/introspection-and-debugging.md
- docs/user-guide/logging.md
- docs/user-guide/application-troubleshooting.md
- docs/admin/cluster-troubleshooting.md
- docs/user-guide/debugging-services.md
Expand All @@ -39,3 +40,6 @@ toc:
path: https://github.com/kubernetes/kubernetes/releases/
- title: Release Roadmap
path: https://github.com/kubernetes/kubernetes/milestones/

- title: Deprecation Policy
path: /docs/deprecation-policy.md
7 changes: 5 additions & 2 deletions _data/tasks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,14 @@ toc:
- docs/tasks/configure-pod-container/assign-cpu-ram-container.md
- docs/tasks/configure-pod-container/configure-volume-storage.md
- docs/tasks/configure-pod-container/distribute-credentials-secure.md
- docs/tasks/configure-pod-container/pull-image-private-registry.md
- docs/tasks/configure-pod-container/configure-liveness-readiness-probes.md
- docs/tasks/configure-pod-container/communicate-containers-same-pod.md

- title: Accessing Applications in a Cluster
section:
- docs/tasks/access-application-cluster/port-forward-access-application-cluster.md
- docs/tasks/access-application-cluster/load-balance-access-application-cluster.md

- title: Debugging Applications in a Cluster
section:
Expand All @@ -26,7 +30,6 @@ toc:
- title: Administering a Cluster
section:
- docs/tasks/administer-cluster/assign-pods-nodes.md

- docs/tasks/administer-cluster/dns-horizontal-autoscaling.md
- docs/tasks/administer-cluster/safely-drain-node.md

Expand All @@ -41,4 +44,4 @@ toc:
- title: Troubleshooting
section:
- docs/tasks/troubleshoot/debug-init-containers.md
- /docs/tasks/administer-cluster/access-control-identity-management/
- docs/tasks/administer-cluster/access-control-identity-management/
16 changes: 16 additions & 0 deletions _data/tools.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,19 @@ bigheader: "Tools"
abstract: "Tools to help you use and enhance Kubernetes."
toc:
- docs/tools/index.md

- title: Native Tools
section:
- title: Kubectl
path: /docs/user-guide/kubectl/
- title: Kubefed
path: /docs/admin/federation/kubefed/
- title: Kubernetes Dashboard
path: /docs/user-guide/ui/

- title: Third-Party Tools
section:
- docs/tools/kompose/index.md
- docs/tools/kompose/user-guide.md
- title: Helm
path: https://github.com/kubernetes/helm
3 changes: 3 additions & 0 deletions _data/tutorials.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,6 @@ toc:
- docs/tutorials/stateful-application/run-stateful-application.md
- docs/tutorials/stateful-application/run-replicated-stateful-application.md
- docs/tutorials/stateful-application/zookeeper.md
- title: Services
section:
- docs/tutorials/services/source-ip.md
6 changes: 3 additions & 3 deletions _includes/tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
{% assign path = item.path %}
{% assign title = item.title %}
{% else %}
{% assign page = site.pages | where: "path", item | first %}
{% assign title = page.title %}
{% assign path = page.url %}
{% assign found_page = site.pages | where: "path", item | first %}
{% assign title = found_page.title %}
{% assign path = found_page.url %}
{% endif %}
{% endcapture %}

Expand Down
4 changes: 1 addition & 3 deletions docs/admin/audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@
assignees:
- soltysh
- sttts

title: Audit in Kubernetes
---

* TOC
{:toc}

## Audit in Kubernetes

Kubernetes Audit provides a security-relevant chronological set of records documenting
the sequence of activities that have affected system by individual users, administrators
or other components of the system. It allows cluster administrator to
Expand Down
11 changes: 2 additions & 9 deletions docs/admin/cluster-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,8 @@ about containers in a central database, and provides a UI for browsing that data

#### Cluster-level Logging

[Container Logging](/docs/user-guide/monitoring) saves container logs
to a central log store with search/browsing interface. There are two
implementations:

* [Cluster-level logging to Google Cloud Logging](
/docs/user-guide/logging/#cluster-level-logging-to-google-cloud-logging)

* [Cluster-level Logging with Elasticsearch and Kibana](
/docs/getting-started-guides/logging-elasticsearch/)
A [Cluster-level logging](/docs/user-guide/logging/overview) mechanism is responsible for
saving container logs to a central log store with search/browsing interface.

## Node components

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ For the purposes of these flags, _legacy_ APIs are those APIs which have been ex

The objects that are stored to disk for a cluster's internal representation of the Kubernetes resources active in the cluster are written using a particular version of the API.
When the supported API changes, these objects may need to be rewritten in the newer API. Failure to do this will eventually result in resources that are no longer decodable or usable
by the kubernetes API server.
by the Kubernetes API server.

`KUBE_API_VERSIONS` environment variable for the `kube-apiserver` binary which controls the API versions that are supported in the cluster. The first version in the list is used as the cluster's storage version. Hence, to set a specific version as the storage version, bring it to the front of list of versions in the value of `KUBE_API_VERSIONS`. You need to restart the `kube-apiserver` binary
for changes to this variable to take effect.
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/disruptions.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
assignees:
- davidopp

title: Pod Disruption Budget
---
This guide is for anyone wishing to specify safety constraints on pods or anyone
wishing to write software (typically automation software) that respects those
Expand Down
3 changes: 2 additions & 1 deletion docs/admin/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ metadata:
spec:
selector:
name: busybox
clusterIP: None
ports:
- name: foo # Actually, no port is needed.
port: 1234
Expand Down Expand Up @@ -383,7 +384,7 @@ for more information.
## References
- [Docs for the DNS cluster addon](http://releases.k8s.io/{{page.githubbranch}}/build-tools/kube-dns/README.md)
- [Docs for the DNS cluster addon](http://releases.k8s.io/{{page.githubbranch}}/build/kube-dns/README.md)
## What's next
- [Autoscaling the DNS Service in a Cluster](/docs/tasks/administer-cluster/dns-horizontal-autoscaling/).
4 changes: 2 additions & 2 deletions docs/admin/federation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ Once you've registered your cluster with the federation, you'll need to update K

### Kubernetes 1.5+: Passing federations flag via config map to kube-dns

For kubernetes clusters of version 1.5+, you can pass the
For Kubernetes clusters of version 1.5+, you can pass the
`--federations` flag to kube-dns via the kube-dns config map.
The flag uses the following format:

Expand Down Expand Up @@ -352,7 +352,7 @@ $ KUBERNETES_PROVIDER=gce FEDERATION_DNS_PROVIDER=google-clouddns FEDERATION_NAM
set appropriately if it is missing and `KUBERNETES_PROVIDER` is one of `gce`, `gke` and `aws`.
This is used to resolve DNS requests for federation services. The service
controller keeps DNS records with the provider updated as services/pods are
updated in underlying kubernetes clusters.
updated in underlying Kubernetes clusters.

`FEDERATION_NAME` is a name you can choose for your federation. This is the name that will appear in DNS routes.

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/federation/kubefed.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
assignees:
- madhusudancs

title: Setting up Cluster Federation with Kubefed
---

* TOC
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/garbage-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ External garbage collection tools are not recommended as these tools can potenti

### Image Collection

kubernetes manages lifecycle of all images through imageManager, with the cooperation
Kubernetes manages lifecycle of all images through imageManager, with the cooperation
of cadvisor.

The policy for garbage collecting images takes two factors into consideration:
Expand Down
4 changes: 1 addition & 3 deletions docs/admin/ha-master-gce.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
---
assignees:
- jszczepkowski

title: Setting up High-Availability Kubernetes Masters
---

* TOC
{:toc}

## Introduction

Kubernetes version 1.5 adds alpha support for replicating Kubernetes masters in `kube-up` or `kube-down` scripts for Google Compute Engine.
This document describes how to use kube-up/down scripts to manage highly available (HA) masters and how HA masters are implemented for use with GCE.

Expand Down
9 changes: 5 additions & 4 deletions docs/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It assumes some familiarity with concepts in the [User Guide](/docs/user-guide/)

## Planning a cluster

There are many different examples of how to setup a kubernetes cluster. Many of them are listed in this
There are many different examples of how to setup a Kubernetes cluster. Many of them are listed in this
[matrix](/docs/getting-started-guides/). We call each of the combinations in this matrix a *distro*.

Before choosing a particular guide, here are some things to consider:
Expand All @@ -25,12 +25,12 @@ Before choosing a particular guide, here are some things to consider:
- Will your cluster be on-premises, or in the cloud (IaaS)? Kubernetes does not directly support hybrid clusters. We
recommend setting up multiple clusters rather than spanning distant locations.
- Will you be running Kubernetes on "bare metal" or virtual machines? Kubernetes supports both, via different distros.
- Do you just want to run a cluster, or do you expect to do active development of kubernetes project code? If the
- Do you just want to run a cluster, or do you expect to do active development of Kubernetes project code? If the
latter, it is better to pick a distro actively used by other developers. Some distros only use binary releases, but
offer is a greater variety of choices.
- Not all distros are maintained as actively. Prefer ones which are listed as tested on a more recent version of
Kubernetes.
- If you are configuring kubernetes on-premises, you will need to consider what [networking
- If you are configuring Kubernetes on-premises, you will need to consider what [networking
model](/docs/admin/networking) fits best.
- If you are designing for very high-availability, you may want [clusters in multiple zones](/docs/admin/multi-cluster).
- You may want to familiarize yourself with the various
Expand Down Expand Up @@ -61,7 +61,8 @@ project](/docs/admin/salt).
* **DNS Integration with SkyDNS** ([dns.md](/docs/admin/dns)):
Resolving a DNS name directly to a Kubernetes service.

* **Logging** with [Kibana](/docs/user-guide/logging)
* [**Cluster-level logging**](/docs/user-guide/logging/overview)
Saving container logs to a central log store with search/browsing interface.

## Multi-tenant support

Expand Down
4 changes: 2 additions & 2 deletions docs/admin/kube-controller-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ StreamingProxyRedirects=true|false (ALPHA - default=false)
--google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication.
--horizontal-pod-autoscaler-sync-period duration The period for syncing the number of pods in horizontal pod autoscaler. (default 30s)
--insecure-experimental-approve-all-kubelet-csrs-for-group string The group for which the controller-manager will auto approve all CSRs for kubelet client certificates.
--kube-api-burst int32 Burst to use while talking with kubernetes apiserver (default 30)
--kube-api-burst int32 Burst to use while talking with Kubernetes apiserver (default 30)
--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 20)
--kube-api-qps float32 QPS to use while talking with Kubernetes apiserver (default 20)
--kubeconfig string Path to kubeconfig file with authorization and master location information.
--large-cluster-size-threshold int32 Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller. (default 50)
--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)
Expand Down
Loading

0 comments on commit 65633ae

Please sign in to comment.