diff --git a/README.md b/README.md index 381cd46567..2801eaead0 100644 --- a/README.md +++ b/README.md @@ -174,14 +174,7 @@ example. If creating an image for a doc, follow the section on "Docker images" from the Kubernetes repository. ## Partners -Kubernetes partners refers to the companies who contribute to the Kubernetes core codebase and/or extend their platform to support Kubernetes. Partners can get their logos added to the partner section of the [community page](http://k8s.io/community) by following the below steps and meeting the below logo specifications. Partners will also need to have a URL that is specific to integrating with Kubernetes ready; this URL will be the destination when the logo is clicked. - -* The partner product logo should be a transparent png image centered in a 215x125 px frame. (look at the existing logos for reference) -* The logo must link to a URL that is specific to integrating with Kubernetes, hosted on the partner's site. -* The logo should be named *product-name*_logo.png and placed in the `/images/community_logos` folder. -* The image reference (including the link to the partner URL) should be added in `community.html` under `
...
`. -* Please do not change the order of the existing partner images. Append your logo to the end of the list. -* Once completed and tested the look and feel, submit the pull request. +Kubernetes partners refers to the companies who contribute to the Kubernetes core codebase, extend their platform to support Kubernetes or provide managed services to users centered around the Kubernetes platform. Partners can get their services and offerings added to the [partner page](https://k8s.io/partners) by completing and submitting the [partner request form](https://goo.gl/qcSnZF). Once the information and assets are verified, the partner product/services will be listed in the partner page. This would typically take 7-10 days. ## Thank you! diff --git a/_data/concepts.yml b/_data/concepts.yml index a69276201e..f9422daa98 100644 --- a/_data/concepts.yml +++ b/_data/concepts.yml @@ -1,4 +1,5 @@ bigheader: "Concepts" +abstract: "Detailed explanations of Kubernetes system concepts and abstractions." toc: - title: Concepts path: /docs/concepts/ diff --git a/_data/docs-home.yml b/_data/docs-home.yml new file mode 100644 index 0000000000..1cb8c9b05a --- /dev/null +++ b/_data/docs-home.yml @@ -0,0 +1,5 @@ +bigheader: "Kubernetes Documentation" +abstract: "Documentation for using and learning about Kubernetes." +toc: +- title: Kubernetes Documentation + path: /docs/ diff --git a/_data/globals.yml b/_data/globals.yml index 73978ea750..2994e8b519 100644 --- a/_data/globals.yml +++ b/_data/globals.yml @@ -1,4 +1,5 @@ tocs: +- docs-home - guides - tutorials - tasks diff --git a/_data/guides.yml b/_data/guides.yml index e31411ea48..85c5dd4103 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -1,8 +1,8 @@ bigheader: "Guides" -abstract: "How to get started, and achieve tasks, using Kubernetes" +abstract: "How to get started, and accomplish tasks, using Kubernetes." toc: - title: Guides - path: /docs/ + path: /docs/user-guide/ - title: Getting Started section: diff --git a/_data/support.yml b/_data/support.yml index e280c827d7..1b8e80699a 100644 --- a/_data/support.yml +++ b/_data/support.yml @@ -14,6 +14,8 @@ toc: path: /docs/contribute/stage-documentation-changes/ - title: Using Page Templates path: /docs/contribute/page-templates/ + - title: Documentation Style Guide + path: /docs/contribute/style-guide/ - title: Troubleshooting section: diff --git a/_data/tasks.yml b/_data/tasks.yml index 38e1a89c68..4c6cd1b709 100644 --- a/_data/tasks.yml +++ b/_data/tasks.yml @@ -1,4 +1,5 @@ bigheader: "Tasks" +abstract: "Step-by-step instructions for performing operations with Kuberentes." toc: - title: Tasks path: /docs/tasks/ diff --git a/_data/tools.yml b/_data/tools.yml index 8993e091bb..cf2afca34c 100644 --- a/_data/tools.yml +++ b/_data/tools.yml @@ -1,4 +1,5 @@ bigheader: "Tools" +abstract: "Tools to help you use and enhance Kubernetes." toc: - title: Tools path: /docs/tools/ diff --git a/_data/tutorials.yml b/_data/tutorials.yml index 01440b09d7..61555427d1 100644 --- a/_data/tutorials.yml +++ b/_data/tutorials.yml @@ -1,4 +1,5 @@ bigheader: "Tutorials" +abstract: "Detailed walkthroughs of common Kubernetes operations and workflows." toc: - title: Tutorials path: /docs/tutorials/ @@ -50,3 +51,7 @@ toc: path: /docs/tutorials/stateless-application/expose-external-ip-address-service/ - title: Exposing an External IP Address to Access an Application in a Cluster path: /docs/tutorials/stateless-application/expose-external-ip-address/ +- title: Stateful Applications + section: + - title: Running a Single-Instance Stateful Application + path: /docs/tutorials/stateful-application/run-stateful-application/ diff --git a/_includes/partner-script.js b/_includes/partner-script.js index e4a5362df0..5763047efc 100644 --- a/_includes/partner-script.js +++ b/_includes/partner-script.js @@ -35,6 +35,27 @@ link: 'http://wercker.com/workflows/partners/kubernetes/', blurb: 'Netscaler CPX gives app developers all the features they need to load balance their microservices and containerized apps with Kubernetes.' }, + { + type: 0, + name: 'Cockroach Labs', + logo: 'cockroach_labs', + link: 'https://www.cockroachlabs.com/blog/running-cockroachdb-on-kubernetes/', + blurb: 'CockroachDB is a distributed SQL database whose built-in replication and survivability model pair with Kubernetes to truly make data easy.' + }, + { + type: 0, + name: 'Skippbox', + logo: 'skippbox', + link: 'http://www.skippbox.com/tag/products/', + blurb: 'Creator of Cabin the first mobile application for Kubernetes, and kompose. Skippbox’s solutions distill all the power of k8s in simple easy to use interfaces.' + }, + { + type: 0, + name: 'Weave Works', + logo: 'weave_works', + link: ' https://weave.works/kubernetes', + blurb: 'Weaveworks enables Developers and Dev/Ops teams to easily connect, deploy, secure, manage, and troubleshoot microservices in Kubernetes.' + }, { type: 0, name: 'Wercker', @@ -140,6 +161,34 @@ link: 'https://www.diamanti.com/products/', blurb: 'Diamanti deploys containers with guaranteed performance using Kubernetes in the first hyperconverged appliance purpose built for containerized applications.' }, + { + type: 0, + name: 'Apprenda', + logo: 'apprenda', + link: 'https://apprenda.com/kubernetes-support/', + blurb: 'Apprenda creates and supports modern, enterprise-ready application platforms for both cloud native and traditional application workloads.' + }, + { + type: 0, + name: 'Aporeto', + logo: 'aporeto', + link: 'https://aporeto.com/trireme', + blurb: 'Aporeto makes cloud-native applications secure by default without impacting developer velocity and works at any scale, on any cloud.' + }, + { + type: 0, + name: 'Giant Swarm', + logo: 'giant_swarm', + link: 'https://giantswarm.io', + blurb: 'Giant Swarm provides fully-managed Kubernetes Clusters in your location of choice, so you can focus on your product.' + }, + { + type: 0, + name: 'Mirantis', + logo: 'mirantis', + link: 'https://content.mirantis.com/Containerizing-OpenStack-on-Kubernetes-Video-Landing-Page.html', + blurb: 'Mirantis builds and manages private clouds with open source software such as OpenStack, deployed as containers orchestrated by Kubernetes.' + }, { type: 1, name: 'Apprenda', @@ -190,12 +239,26 @@ blurb: 'Jetstack is an organisation focused entirely on Kubernetes. They will help you to get the most out of Kubernetes through expert professional services and open source tooling. Get in touch, and accelerate your project.' }, { - type: 1, + type: 0, name: 'Tigera', logo: 'tigera', link: 'http://docs.projectcalico.org/v1.5/getting-started/kubernetes/', blurb: 'Tigera builds high performance, policy driven, cloud native networking solutions for Kubernetes.' - } + }, + { + type: 1, + name: 'Skippbox', + logo: 'skippbox', + link: 'http://www.skippbox.com/services/', + blurb: 'Skippbox brings its Kubernetes expertise to help companies embrace Kubernetes on their way to digital transformation. Skippbox offers both professional services and expert training.' + }, + { + type: 1, + name: 'Endocode', + logo: 'endocode', + link: 'https://endocode.com/kubernetes/', + blurb: 'Endocode practices and teaches the open source way. Kernel to cluster - Dev to Ops. We offer Kubernetes trainings, services and support.' + } ] var isvContainer = document.getElementById('isvContainer') diff --git a/_layouts/docwithnav.html b/_layouts/docwithnav.html index c2f74c1bb4..8ca0906065 100755 --- a/_layouts/docwithnav.html +++ b/_layouts/docwithnav.html @@ -11,13 +11,14 @@
{{ site.data[foundTOC].abstract }}
diff --git a/docs/admin/addons.md b/docs/admin/addons.md index 1969ab04c7..f2bd18aaa5 100644 --- a/docs/admin/addons.md +++ b/docs/admin/addons.md @@ -11,6 +11,7 @@ This page lists some of the available add-ons and links to their respective inst * [Weave Net](https://github.com/weaveworks/weave-kube) provides networking and network policy, will carry on working on both sides of a network partition, and does not require an external database. * [Calico](http://docs.projectcalico.org/v1.5/getting-started/kubernetes/installation/hosted/) is a secure L3 networking and network policy provider. +* [Flannel](https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml) is a overlay network provider that can be used with Kubernetes. * [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm) unites Flannel and Calico, providing networking and network policy. * [Romana](http://romana.io) is a Layer 3 networking solution for pod networks that also supports the [NetworkPolicy API](/docs/user-guide/networkpolicies/). Kubeadm add-on installation details available [here](https://github.com/romana/romana/tree/master/containerize). diff --git a/docs/admin/kubeadm.md b/docs/admin/kubeadm.md index a8acd6b1cb..e1c8537149 100644 --- a/docs/admin/kubeadm.md +++ b/docs/admin/kubeadm.md @@ -3,6 +3,7 @@ assignees: - mikedanese - luxas - errordeveloper +- jbeda --- @@ -104,17 +105,16 @@ and `--external-etcd-keyfile` flags. - `--pod-network-cidr` -By default, `kubeadm init` does not set node CIDR's for pods and allows you to -bring your own networking configuration through a CNI compatible network -controller addon such as [Weave Net](https://github.com/weaveworks/weave-kube), -[Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) -or [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm). -If you are using a compatible cloud provider or flannel, you can specify a -subnet to use for each pod on the cluster with the `--pod-network-cidr` flag. -This should be a minimum of a /16 so that kubeadm is able to assign /24 subnets -to each node in the cluster. +For certain networking solutions the Kubernetes master can also play a role in +allocating network ranges (CIDRs) to each node. This includes many cloud providers +and flannel. You can specify a subnet range that will be broken down and handed out +to each node with the `--pod-network-cidr` flag. This should be a minimum of a /16 so +controller-manager is able to assign /24 subnets to each node in the cluster. +If you are using flannel with [this manifest](https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml) +you should use `--pod-network-cidr=10.244.0.0/16`. Most CNI based networking solutions +do not require this flag. -- `--service-cidr` (default '10.12.0.0/12') +- `--service-cidr` (default '10.96.0.0/12') You can use the `--service-cidr` flag to override the subnet Kubernetes uses to assign pods IP addresses. If you do, you will also need to update the @@ -141,7 +141,7 @@ By default, `kubeadm init` automatically generates the token used to initialise each new node. If you would like to manually specify this token, you can use the `--token` flag. The token must be of the format `<6 character string>.<16 character string>`. -- `--use-kubernetes-version` (default 'v1.4.1') the kubernetes version to initialise +- `--use-kubernetes-version` (default 'v1.4.4') the kubernetes version to initialise `kubeadm` was originally built for Kubernetes version **v1.4.0**, older versions are not supported. With this flag you can try any future version, e.g. **v1.5.0-beta.1** @@ -203,6 +203,27 @@ There are some environment variables that modify the way that `kubeadm` works. | `KUBE_COMPONENT_LOGLEVEL` | `--v=4` | Logging configuration for all Kubernetes components | +## Releases and release notes + +If you already have kubeadm installed and want to upgrade, run `apt-get update && apt-get upgrade` or `yum update` to get the latest version of kubeadm. + + - Second release between v1.4 and v1.5: `v1.5.0-alpha.2.421+a6bea3d79b8bba` + - Switch to the 10.96.0.0/12 subnet: [#35290](https://github.com/kubernetes/kubernetes/pull/35290) + - Fix kubeadm on AWS by including /etc/ssl/certs in the controller-manager [#33681](https://github.com/kubernetes/kubernetes/pull/33681) + - The API was refactored and is now componentconfig: [#33728](https://github.com/kubernetes/kubernetes/pull/33728), [#34147](https://github.com/kubernetes/kubernetes/pull/34147) and [#34555](https://github.com/kubernetes/kubernetes/pull/34555) + - Allow kubeadm to get config options from a file: [#34501](https://github.com/kubernetes/kubernetes/pull/34501), [#34885](https://github.com/kubernetes/kubernetes/pull/34885) and [#34891](https://github.com/kubernetes/kubernetes/pull/34891) + - Implement preflight checks: [#34341](https://github.com/kubernetes/kubernetes/pull/34341) and [#35843](https://github.com/kubernetes/kubernetes/pull/35843) + - Using kubernetes v1.4.4 by default: [#34419](https://github.com/kubernetes/kubernetes/pull/34419) and [#35270](https://github.com/kubernetes/kubernetes/pull/35270) + - Make api and discovery ports configurable and default to 6443: [#34719](https://github.com/kubernetes/kubernetes/pull/34719) + - Implement kubeadm reset: [#34807](https://github.com/kubernetes/kubernetes/pull/34807) + - Make kubeadm poll/wait for endpoints instead of directly fail when the master isn't available [#34703](https://github.com/kubernetes/kubernetes/pull/34703) and [#34718](https://github.com/kubernetes/kubernetes/pull/34718) + - Allow empty directories in the directory preflight check: [#35632](https://github.com/kubernetes/kubernetes/pull/35632) + - Started adding unit tests: [#35231](https://github.com/kubernetes/kubernetes/pull/35231), [#35326](https://github.com/kubernetes/kubernetes/pull/35326) and [#35332](https://github.com/kubernetes/kubernetes/pull/35332) + - Various enhancements: [#35075](https://github.com/kubernetes/kubernetes/pull/35075), [#35111](https://github.com/kubernetes/kubernetes/pull/35111), [#35119](https://github.com/kubernetes/kubernetes/pull/35119), [#35124](https://github.com/kubernetes/kubernetes/pull/35124), [#35265](https://github.com/kubernetes/kubernetes/pull/35265) and [#35777](https://github.com/kubernetes/kubernetes/pull/35777) + - Bug fixes: [#34352](https://github.com/kubernetes/kubernetes/pull/34352), [#34558](https://github.com/kubernetes/kubernetes/pull/34558), [#34573](https://github.com/kubernetes/kubernetes/pull/34573), [#34834](https://github.com/kubernetes/kubernetes/pull/34834), [#34607](https://github.com/kubernetes/kubernetes/pull/34607), [#34907](https://github.com/kubernetes/kubernetes/pull/34907) and [#35796](https://github.com/kubernetes/kubernetes/pull/35796) + - Initial v1.4 release: `v1.5.0-alpha.0.1534+cf7301f16c0363` + + ## Troubleshooting * Some users on RHEL/CentOS 7 have reported issues with traffic being routed incorrectly due to iptables being bypassed. You should ensure `net.bridge.bridge-nf-call-iptables` is set to 1 in your sysctl config, eg. diff --git a/docs/admin/networking.md b/docs/admin/networking.md index 2acbf062d4..0cfd9d7989 100644 --- a/docs/admin/networking.md +++ b/docs/admin/networking.md @@ -83,7 +83,7 @@ talk to other VMs in your project. This is the same basic model. Until now this document has talked about containers. In reality, Kubernetes applies IP addresses at the `Pod` scope - containers within a `Pod` share their network namespaces - including their IP address. This means that containers -within a `Pod` can all reach each other’s ports on `localhost`. This does imply +within a `Pod` can all reach each other's ports on `localhost`. This does imply that containers within a `Pod` must coordinate port usage, but this is no different than processes in a VM. We call this the "IP-per-pod" model. This is implemented in Docker as a "pod container" which holds the network namespace @@ -163,7 +163,7 @@ Lars Kellogg-Stedman. [Weave Net](https://www.weave.works/products/weave-net/) is a resilient and simple to use network for Kubernetes and its hosted applications. Weave Net runs as a [CNI plug-in](https://www.weave.works/docs/net/latest/cni-plugin/) -or stand-alone. In either version, it doesn’t require any configuration or extra code +or stand-alone. In either version, it doesn't require any configuration or extra code to run, and in both cases, the network provides one IP address per pod - as is standard for Kubernetes. diff --git a/docs/api.md b/docs/api.md index aa9aea1d7f..9ea627721e 100644 --- a/docs/api.md +++ b/docs/api.md @@ -95,46 +95,3 @@ DaemonSets, Deployments, HorizontalPodAutoscalers, Ingress, Jobs and ReplicaSets Other extensions resources can be enabled by setting runtime-config on apiserver. runtime-config accepts comma separated values. For ex: to disable deployments and jobs, set `--runtime-config=extensions/v1beta1/deployments=false,extensions/v1beta1/jobs=false` - -## v1beta1, v1beta2, and v1beta3 are deprecated; please move to v1 ASAP - -As of June 4, 2015, the Kubernetes v1 API has been enabled by default. The v1beta1 and v1beta2 APIs were deleted on June 1, 2015. v1beta3 is planned to be deleted on July 6, 2015. - -### v1 conversion tips (from v1beta3) - -We're working to convert all documentation and examples to v1. Use `kubectl create --validate` in order to validate your json or yaml against our Swagger spec. - -Changes to services are the most significant difference between v1beta3 and v1. - -* The `service.spec.portalIP` property is renamed to `service.spec.clusterIP`. -* The `service.spec.createExternalLoadBalancer` property is removed. Specify `service.spec.type: "LoadBalancer"` to create an external load balancer instead. -* The `service.spec.publicIPs` property is deprecated and now called `service.spec.deprecatedPublicIPs`. This property will be removed entirely when v1beta3 is removed. The vast majority of users of this field were using it to expose services on ports on the node. Those users should specify `service.spec.type: "NodePort"` instead. Read [External Services](/docs/user-guide/services/#external-services) for more info. If this is not sufficient for your use case, please file an issue or contact @thockin. - -Some other difference between v1beta3 and v1: - -* The `pod.spec.containers[*].privileged` and `pod.spec.containers[*].capabilities` properties are now nested under the `pod.spec.containers[*].securityContext` property. See [Security Contexts](/docs/user-guide/security-context). -* The `pod.spec.host` property is renamed to `pod.spec.nodeName`. -* The `endpoints.subsets[*].addresses.IP` property is renamed to `endpoints.subsets[*].addresses.ip`. -* The `pod.status.containerStatuses[*].state.termination` and `pod.status.containerStatuses[*].lastState.termination` properties are renamed to `pod.status.containerStatuses[*].state.terminated` and `pod.status.containerStatuses[*].lastState.terminated` respectively. -* The `pod.status.Condition` property is renamed to `pod.status.conditions`. -* The `status.details.id` property is renamed to `status.details.name`. - -### v1beta3 conversion tips (from v1beta1/2) - -Some important differences between v1beta1/2 and v1beta3: - -* The resource `id` is now called `name`. -* `name`, `labels`, `annotations`, and other metadata are now nested in a map called `metadata` -* `desiredState` is now called `spec`, and `currentState` is now called `status` -* `/minions` has been moved to `/nodes`, and the resource has kind `Node` -* The namespace is required (for all namespaced resources) and has moved from a URL parameter to the path: `/api/v1beta3/namespaces/{namespace}/{resource_collection}/{resource_name}`. If you were not using a namespace before, use `default` here. -* The names of all resource collections are now lower cased - instead of `replicationControllers`, use `replicationcontrollers`. -* To watch for changes to a resource, open an HTTP or Websocket connection to the collection query and provide the `?watch=true` query parameter along with the desired `resourceVersion` parameter to watch from. -* The `labels` query parameter has been renamed to `labelSelector`. -* The `fields` query parameter has been renamed to `fieldSelector`. -* The container `entrypoint` has been renamed to `command`, and `command` has been renamed to `args`. -* Container, volume, and node resources are expressed as nested maps (e.g., `resources{cpu:1}`) rather than as individual fields, and resource values support [scaling suffixes](/docs/user-guide/compute-resources/#specifying-resource-quantities) rather than fixed scales (e.g., milli-cores). -* Restart policy is represented simply as a string (e.g., `"Always"`) rather than as a nested map (`always{}`). -* Pull policies changed from `PullAlways`, `PullNever`, and `PullIfNotPresent` to `Always`, `Never`, and `IfNotPresent`. -* The volume `source` is inlined into `volume` rather than nested. -* Host volumes have been changed from `hostDir` to `hostPath` to better reflect that they can be files or directories. \ No newline at end of file diff --git a/docs/contribute/create-pull-request.md b/docs/contribute/create-pull-request.md index 833b4abf08..e79fe22c96 100644 --- a/docs/contribute/create-pull-request.md +++ b/docs/contribute/create-pull-request.md @@ -1,6 +1,4 @@ --- -redirect_from: - - /editdocs/ --- {% capture overview %} @@ -46,7 +44,7 @@ choose the [page type](/docs/contribute/page-templates/) that is the best fit for your content. -### Submitting a pull request to the master branch +### Submitting a pull request to the master branch (Current Release) If you want your change to be published in the released version Kubernetes docs, create a pull request against the master branch of the Kubernetes @@ -64,7 +62,7 @@ site where you can verify that your changes have rendered correctly. If needed, revise your pull request by committing changes to your new branch in your fork. -### Submitting a pull request to the <vnext> branch +### Submitting a pull request to the <vnext> branch (Upcoming Release) If your documentation change should not be released until the next release of the Kubernetes product, create a pull request against the <vnext> branch diff --git a/docs/contribute/style-guide.md b/docs/contribute/style-guide.md new file mode 100644 index 0000000000..219d62560d --- /dev/null +++ b/docs/contribute/style-guide.md @@ -0,0 +1,203 @@ +--- +--- + +{% capture overview %} +This page gives writing style guidelines for the Kubernetes documentation. +These are guidelines, not rules. Use your best judgment, and feel free to +propose changes to this document in a pull request. + +For additional information on creating new content for the Kubernetes +docs, follow the instructions on +[using page templates](/docs/contribute/page-templates/) and +[creating a documentation pull request](/docs/contribute/create-pull-request/). +{% endcapture %} + +{% capture body %} + +## Documentation formatting standards + +### Capitalize API objects + +Capitalize the names of API objects. Refer to API objects without saying +"object." + + + + + +
DoDon't
The Pod has two Containers.The pod has two containers.
The Deployment is responsible for ...The Deployment object is responsible for ...
+ +### Use angle brackets for placeholders + +Use angle brackets for placeholders. Tell the reader what a placeholder +represents. + +1. Display information about a pod: + + kubectl describe pod + + where `` is the name of one of your pods. + +### Use bold for user interface elements + + + + + +
DoDon't
Click Fork.Click "Fork".
Select Other.Select 'Other'.
+ +### Use italics to define or introduce new terms + + + + + +
DoDon't
A cluster is a set of nodes ...A "cluster" is a set of nodes ...
These components form the control plane.These components form the control plane.
+ +### Use code style for filenames, directories, and paths + + + + + + +
DoDon't
Open the envars.yaml file.Open the envars.yaml file.
Go to the /docs/tutorials directory.Go to the /docs/tutorials directory.
Open the /_data/concepts.yaml file.Open the /_data/concepts.yaml file.
+ +## Code snippet formatting + +### Use code style for inline code and commands + +For inline code in an HTML document, use the `` tag. In a Markdown +document, use the backtick (`). + + + + + +
DoDon't
Set the value of the replicas field in the configuration file.Set the value of the "replicas" field in the configuration file.
The kubectl run command creates a Deployment.The "kubectl run" command creates a Deployment.
+ +### Don't include the command prompt + + + + +
DoDon't
kubectl get pods$ kubectl get pods
+ +### Separate commands from output + +Verify that the pod is running on your chosen node: + + kubectl get pods --output=wide + +The output is similar to this: + + NAME READY STATUS RESTARTS AGE IP NODE + nginx 1/1 Running 0 13s 10.200.0.4 worker0 + + +{% comment %}## Kubernetes.io word list + +A list of Kubernetes-specific terms and words to be used consistently across the site. + + + + +
TermUseage
TBDTBD
{% endcomment %} + + +## Content best practices + +This section contains suggested best practices for clear, concise, and consistent content. + +### Use present tense + + + + +
DoDon't
This command starts a proxy.This command will start a proxy.
+ +Exception: Use future or past tense if it is required to convey the correct +meaning. + +### Use active voice + + + + + +
DoDon't
You can explore the API using a browser.The API can be explored using a browser.
The YAML file specifies the replica count.The replica count is specified in the YAML file.
+ +Exception: Use passive voice if active voice leads to an awkward construction. + +### Use simple and direct language + +Use simple and direct language. Avoid using unnecessary phrases, such as saying "please." + + + + + + + +
DoDon't
To create a ReplicaSet, ...In order to create a ReplicaSet, ...
See the configuration file.Please see the configuration file.
View the Pods.With this next command, we'll view the Pods.
+ +### Address the reader as "you" + + + + + +
DoDon't
You can create a Deployment by ...We'll create a Deployment by ...
In the preceding output, you can see...In the preceding output, we can see ...
+ +## Patterns to avoid + +### Avoid using "we" + +Using "we" in a sentence can be confusing, because the reader might not know +whether they're part of the "we" you're describing. + + + + + + +
DoDon't
Version 1.4 includes ...In version 1.4, we have added ...
Kubernetes provides a new feature for ...We provide a new feature ...
This page teaches you how to use pods.In this page, we are going to learn about pods.
+ +### Avoid jargon and idioms + +Some readers speak English as a second language. Avoid jargon and idioms to help make their understanding easier. + + + + + +
DoDon't
Internally, ...Under the hood, ...
Create a new cluster.Turn up a new cluster.
+ +### Avoid statements about the future + +Avoid making promises or giving hints about the future. If you need to talk about +an alpha feature, put the text under a heading that identifies it as alpha +information. + +### Avoid statements that will soon be out of date + +Avoid words like "currently" and "new." A feature that is new today might not be +considered new in a few months. + + + + + +
DoDon't
In version 1.4, ...In the current version, ...
The Federation feature provides ...The new Federation feature provides ...
+ +{% endcapture %} + + +{% capture whatsnext %} +* Learn about [writing a new topic](/docs/contribute/write-new-topic/). +* Learn about [using page templates](/docs/contribute/page-templates/). +* Learn about [staging your changes](/docs/contribute/stage-documentation-changes/) +* Learn about [creating a pull request](/docs/contribute/create-pull-request/). +{% endcapture %} + +{% include templates/concept.md %} diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index 8f4a3db26c..bf40b9c283 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -13,7 +13,7 @@ li>.highlighter-rouge {position:relative; top:3px;} ## Overview -This quickstart shows you how to easily install a secure Kubernetes cluster on machines running Ubuntu 16.04 or CentOS 7. +This quickstart shows you how to easily install a secure Kubernetes cluster on machines running Ubuntu 16.04, CentOS 7 or HypriotOS v1.0.1+. The installation uses a tool called `kubeadm` which is part of Kubernetes 1.4. This process works with local VMs, physical servers and/or cloud servers. @@ -23,7 +23,7 @@ See the full [`kubeadm` reference](/docs/admin/kubeadm) for information on all ` **The `kubeadm` tool is currently in alpha but please try it out and give us [feedback](/docs/getting-started-guides/kubeadm/#feedback)! Be sure to read the [limitations](#limitations); in particular note that kubeadm doesn't have great support for -automatically configuring cloud providers. Please refer to the specific cloud provider documentation or +automatically configuring cloud providers. Please refer to the specific cloud provider documentation or use another provisioning system.** kubeadm assumes you have a set of machines (virtual or real) that are up and running. It is designed @@ -38,7 +38,7 @@ If you are not constrained, other tools build on kubeadm to give you complete cl ## Prerequisites -1. One or more machines running Ubuntu 16.04, CentOS 7 or HypriotOS v1.0.1 +1. One or more machines running Ubuntu 16.04, CentOS 7 or HypriotOS v1.0.1+ 1. 1GB or more of RAM per machine (any less will leave little room for your apps) 1. Full network connectivity between all machines in the cluster (public or private network is fine) @@ -61,6 +61,9 @@ You will install the following packages on all the machines: You will only need this on the master, but it can be useful to have on the other nodes as well. * `kubeadm`: the command to bootstrap the cluster. +NOTE: If you already have kubeadm installed, you should do a `apt-get update && apt-get upgrade` or `yum update` to get the latest version of kubeadm. +See the reference doc if you want to read about the different [kubeadm releases](/docs/admin/kubeadm) + For each host in turn: * SSH into the machine and become `root` if you are not already (for example, run `sudo su -`). @@ -94,7 +97,7 @@ For each host in turn: The kubelet is now restarting every few seconds, as it waits in a crashloop for `kubeadm` to tell it what to do. -Note: `setenforce 0` will no longer be necessary on CentOS once [#33555](https://github.com/kubernetes/kubernetes/pull/33555) is included in a released version of `kubeadm`. +Note: To disable SELinux by running `setenforce 0` is required in order to allow containers to access the host filesystem, which is required by pod networks for example. You have to do this until kubelet can handle SELinux better. ### (2/4) Initializing your master @@ -103,6 +106,8 @@ All of these components run in pods started by `kubelet`. Right now you can't run `kubeadm init` twice without tearing down the cluster in between, see [Tear down](#tear-down). +If you try to run `kubeadm init` and your machine is in a state that is incompatible with starting a Kubernetes cluster, `kubeadm` will warn you about things that might not work or it will error out for unsatisfied mandatory requirements. + To initialize the master, pick one of the machines you previously installed `kubelet` and `kubeadm` on, and run: # kubeadm init @@ -110,7 +115,7 @@ To initialize the master, pick one of the machines you previously installed `kub **Note:** this will autodetect the network interface to advertise the master on as the interface with the default gateway. If you want to use a different interface, specify `--api-advertise-addresses=` argument to `kubeadm init`. -If you want to use [flannel](https://github.com/coreos/flannel) as the pod network; specify `--pod-network-cidr=10.244.0.0/16` if you're using the daemonset manifest below. _However, please note that this is not required for any other networks, including Weave, which is the recommended pod network._ +If you want to use [flannel](https://github.com/coreos/flannel) as the pod network, specify `--pod-network-cidr=10.244.0.0/16` if you're using the daemonset manifest below. _However, please note that this is not required for any other networks besides Flannel._ Please refer to the [kubeadm reference doc](/docs/admin/kubeadm/) if you want to read more about the flags `kubeadm init` provides. @@ -201,16 +206,27 @@ For example: A few seconds later, you should notice that running `kubectl get nodes` on the master shows a cluster with as many machines as you created. -### (Optional) Control your cluster from machines other than the master +Note that there currently isn't a out-of-the-box way of connecting to the Master's API Server via `kubectl` from a node. Read issue [#35729](https://github.com/kubernetes/kubernetes/issues/35729) for more details. + +### (Optional) Controlling your cluster from machines other than the master In order to get a kubectl on your laptop for example to talk to your cluster, you need to copy the `KubeConfig` file from your master to your laptop like this: # scp root@:/etc/kubernetes/admin.conf . # kubectl --kubeconfig ./admin.conf get nodes +### (Optional) Connecting to the API Server + +If you want to connect to the API Server for viewing the dashboard (note: not deployed by default) from outside the cluster for example, you can use `kubectl proxy`: + + # scp root@:/etc/kubernetes/admin.conf . + # kubectl --kubeconfig ./admin.conf proxy + +You can now access the API Server locally at `http://localhost:8001/api/v1` + ### (Optional) Installing a sample application -As an example, install a sample microservices application, a socks shop, to put your cluster through its paces. +As an example, install a sample microservices application, a socks shop, to put your cluster through its paces. Note that this demo does only work on `amd64`. To learn more about the sample microservices app, see the [GitHub README](https://github.com/microservices-demo/microservices-demo). # kubectl create namespace sock-shop @@ -242,17 +258,11 @@ If there is a firewall, make sure it exposes this port to the internet before yo * To uninstall the socks shop, run `kubectl delete namespace sock-shop` on the master. -* To undo what `kubeadm` did, simply delete the machines you created for this tutorial, or run the script below and then start over or uninstall the packages. +* To undo what `kubeadm` did, simply run: + + # kubeadm reset -
- Reset local state: - 
systemctl stop kubelet;
-  docker rm -f -v $(docker ps -q);
-  find /var/lib/kubelet | xargs -n 1 findmnt -n -t tmpfs -o TARGET -T | uniq | xargs -r umount -v;
-  rm -r -f /etc/kubernetes /var/lib/kubelet /var/lib/etcd;
-
If you wish to start over, run `systemctl start kubelet` followed by `kubeadm init` or `kubeadm join`. - ## Explore other add-ons @@ -275,19 +285,22 @@ kubeadm deb packages and binaries are built for amd64, arm and arm64, following deb-packages are released for ARM and ARM 64-bit, but not RPMs (yet, reach out if there's interest). -Anyway, ARM had some issues when making v1.4, see [#32517](https://github.com/kubernetes/kubernetes/pull/32517) [#33485](https://github.com/kubernetes/kubernetes/pull/33485), [#33117](https://github.com/kubernetes/kubernetes/pull/33117) and [#33376](https://github.com/kubernetes/kubernetes/pull/33376). +ARM had some issues when making v1.4, see [#32517](https://github.com/kubernetes/kubernetes/pull/32517) [#33485](https://github.com/kubernetes/kubernetes/pull/33485), [#33117](https://github.com/kubernetes/kubernetes/pull/33117) and [#33376](https://github.com/kubernetes/kubernetes/pull/33376). However, thanks to the PRs above, `kube-apiserver` works on ARM from the `v1.4.1` release, so make sure you're at least using `v1.4.1` when running on ARM 32-bit -The multiarch flannel daemonset can be installed this way. Make sure you replace `ARCH=amd64` with `ARCH=arm` or `ARCH=arm64` if necessary. +The multiarch flannel daemonset can be installed this way. - # ARCH=amd64 curl -sSL https://raw.githubusercontent.com/luxas/flannel/update-daemonset/Documentation/kube-flannel.yml | sed "s/amd64/${ARCH}/g" | kubectl create -f - + # export ARCH=amd64 + # curl -sSL "https://github.com/coreos/flannel/blob/master/Documentation/kube-flannel.yml?raw=true" | sed "s/amd64/${ARCH}/g" | kubectl create -f - -And obviously replace `ARCH=amd64` with `ARCH=arm` or `ARCH=arm64` depending on the platform you're running on. +Replace `ARCH=amd64` with `ARCH=arm` or `ARCH=arm64` depending on the platform you're running on. +Note that the Raspberry Pi 3 is in ARM 32-bit mode, so for RPi 3 you should set `ARCH` to `arm`, not `arm64`. ## Limitations Please note: `kubeadm` is a work in progress and these limitations will be addressed in due course. +Also you can take a look at the troubleshooting section in the [reference document](/docs/admin/kubeadm/#troubleshooting) 1. The cluster created here doesn't have cloud-provider integrations by default, so for example it doesn't work automatically with (for example) [Load Balancers](/docs/user-guide/load-balancer/) (LBs) or [Persistent Volumes](/docs/user-guide/persistent-volumes/walkthrough/) (PVs). To set up kubeadm with CloudProvider integrations (it's experimental, but try), refer to the [kubeadm reference](/docs/admin/kubeadm/) document. @@ -302,6 +315,15 @@ Please note: `kubeadm` is a work in progress and these limitations will be addre 1. `kubectl logs` is broken with `kubeadm` clusters due to [#22770](https://github.com/kubernetes/kubernetes/issues/22770). Workaround: use `docker logs` on the nodes where the containers are running as a workaround. +1. The HostPort functionality does not work with kubeadm due to that CNI networking is used, see issue [#31307](https://github.com/kubernetes/kubernetes/issues/31307). + + Workaround: use the [NodePort feature of services](/docs/user-guide/services/#type-nodeport) instead, or use HostNetwork. +1. A running `firewalld` service may conflict with kubeadm, so if you want to run `kubeadm`, you should disable `firewalld` until issue [#35535](https://github.com/kubernetes/kubernetes/issues/35535) is resolved. + + Workaround: Disable `firewalld` or configure it to allow Kubernetes the pod and service cidrs. +1. If you see errors like `etcd cluster unavailable or misconfigured`, it's because of high load on the machine which makes the `etcd` container a bit unresponsive (it might miss some requests) and therefore kubelet will restart it. This will get better with `etcd3`. + + Workaround: Set `failureThreshold` in `/etc/kubernetes/manifests/etcd.json` to a larger value. 1. If you are using VirtualBox (directly or via Vagrant), you will need to ensure that `hostname -i` returns a routable IP address (i.e. one on the second network interface, not the first one). By default, it doesn't do this and kubelet ends-up using first non-loopback network interface, which is usually NATed. diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index 72a9ee3125..84b0ffb5af 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -381,7 +381,7 @@ The minimum version required is [v0.5.6](https://github.com/coreos/rkt/releases/ minimum version required to match rkt v0.5.6 is [systemd 215](http://lists.freedesktop.org/archives/systemd-devel/2014-July/020903.html). -[rkt metadata service](https://github.com/coreos/rkt/blob/master/Documentation/networking.md) is also required +[rkt metadata service](https://github.com/coreos/rkt/blob/master/Documentation/networking/overview.md) is also required for rkt networking support. You can start rkt metadata service by using command like `sudo systemd-run rkt metadata-service` diff --git a/docs/getting-started-guides/vsphere.md b/docs/getting-started-guides/vsphere.md index b3679c56e8..a1e59b0cd0 100644 --- a/docs/getting-started-guides/vsphere.md +++ b/docs/getting-started-guides/vsphere.md @@ -65,6 +65,7 @@ export GOVC_DATACENTER='ha-datacenter' # The datacenter to be used by vSphere cl ``` Sample environment + ```shell export GOVC_URL='10.161.236.217' export GOVC_USERNAME='administrator' @@ -79,6 +80,7 @@ export GOVC_DATACENTER='Datacenter' ``` Import this VMDK into your vSphere datastore: + ```shell govc import.vmdk kube.vmdk ./kube/ ``` diff --git a/docs/hellonode.md b/docs/hellonode.md index a36f9b5770..b5b67a195d 100755 --- a/docs/hellonode.md +++ b/docs/hellonode.md @@ -129,7 +129,7 @@ Let’s now stop the container. You can list the docker containers with: docker ps ``` -You should something like see: +You should see something like this: ```shell CONTAINER ID IMAGE COMMAND NAMES diff --git a/docs/index.md b/docs/index.md index 5501491e7a..0bdaa33b5c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,130 +4,40 @@ assignees: - thockin --- - -
-
-

What is Kubernetes?

-

Kubernetes is an open-source platform for automating deployment, scaling, and operations of application containers across clusters of hosts. Learn more about what this means for your app.

- Read the Overview -
-
-

Kubernetes Basics Interactive Tutorial

-

The Kubernetes Basics interactive tutorials let you try out Kubernetes features using Minikube right out of your web browser in a virtual terminal. Learn about the Kubernetes system and deploy, expose, scale, and upgrade a containerized application in just a few minutes.

- Try the Interactive Tutorials -
-
-

Installing Kubernetes on Linux with kubeadm

-

This quickstart will show you how to install a secure Kubernetes cluster on any computers running Linux, using a tool called kubeadm. It'll work with local VMs, physical servers and/or cloud servers, either manually or as a part of your own automation. It is currently in alpha but please try it out and give us feedback!

-

If you are looking for a fully automated solution, note that kubeadm is intended as a building block. Tools such as GKE and kops build on kubeadm to provision a complete cluster.

- Install Kubernetes with kubeadm -
-
-

Installing Kubernetes on AWS with kops

-

This quickstart will show you how to bring up a complete Kubernetes cluster on AWS, using a tool called kops.

- Install Kubernetes with kops -
-
-

Guided Tutorial

-

If you’ve completed one of the quickstarts, a great next step is Kubernetes 101. You will follow a path through the various features of Kubernetes, with code examples along the way, learning all of the core concepts. There's also a Kubernetes 201!

- Kubernetes 101 -
-
-## Samples +

The Kubernetes documentation can help you set up Kubernetes, learn about the system, or get your applications and workloads running on Kubernetes.

- +

Read the Kubernetes Overview

-

 

-

 

+

Interactive Tutorial

-
-
-

Contribute to Our Docs

-

The docs for Kubernetes are open-source, just like the code for Kubernetes itself. The docs are on GitHub Pages, so you can fork it and it will auto-stage on username.github.io, previewing your changes!

- Write Docs for K8s -
-
-

Need Help?

-

Try consulting our troubleshooting guides, or our FAQ. Kubernetes is also supported by a great community of contributors and experts who hang out in our Slack channel, our Google Group and Stack Overflow.

- Get Support -
-
+

The Kubernetes Basics interactive tutorial lets you try out Kubernetes right out of your web browser, using a virtual terminal. Learn about the Kubernetes system and deploy, expose, scale, and upgrade a containerized application in just a few minutes.

+ +

Installing/Setting Up Kubernetes

+ +

Picking the Right Solution can help you get a Kubernetes cluster up and running, either for local development, or on your cloud provider of choice.

+ +

Other/newer ways to set up a Kubernetes cluster include:

+ + +

Guides, Tutorials, Tasks, and Concepts

+ +

The Kubernetes documentation contains a number of resources to help you understand and work with Kubernetes.

+
    +
  • Guides provides documentation for Kubernetes features as well as administering and spinning up clusters, including usage examples.
    • +
  • Tutorials contain detailed walkthroughs of the Kubernetes workflow.
    • +
  • Tasks contain step-by-step instructions for common Kubernetes tasks.
    • +
  • Concepts provide a deep understanding of how Kubernetes works.
    • +
+ +

API and Command References

+ +

The reference documentation provides complete information on the Kubernetes APIs and the kubectl command-line interface.

+ +

Tools

+ +

The tools page contains a list of native and third-party tools for Kubernetes.

\ No newline at end of file diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 14530ca25e..60aab6a8fb 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -15,6 +15,10 @@ The Tutorials section of the Kubernetes documentation is a work in progress. * [Exposing an External IP Address to Access an Application in a Cluster](/docs/tutorials/stateless-application/expose-external-ip-address/) +#### Stateful Applications + +* [Running a Single-Instance Stateful Application](/docs/tutorials/stateful-application/run-stateful-application/) + ### What's next If you would like to write a tutorial, see diff --git a/docs/tutorials/stateful-application/gce-volume.yaml b/docs/tutorials/stateful-application/gce-volume.yaml new file mode 100644 index 0000000000..ddb9ecc3ce --- /dev/null +++ b/docs/tutorials/stateful-application/gce-volume.yaml @@ -0,0 +1,12 @@ +apiVersion: v1 +kind: PersistentVolume +metadata: + name: mysql-pv +spec: + capacity: + storage: 20Gi + accessModes: + - ReadWriteOnce + gcePersistentDisk: + pdName: mysql-disk + fsType: ext4 diff --git a/docs/tutorials/stateful-application/mysql-deployment.yaml b/docs/tutorials/stateful-application/mysql-deployment.yaml new file mode 100644 index 0000000000..3b2aa22f6c --- /dev/null +++ b/docs/tutorials/stateful-application/mysql-deployment.yaml @@ -0,0 +1,51 @@ +apiVersion: v1 +kind: Service +metadata: + name: mysql +spec: + ports: + - port: 3306 + selector: + app: mysql + clusterIP: None +--- +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: mysql-pv-claim +spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 20Gi +--- +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: mysql +spec: + strategy: + type: Recreate + template: + metadata: + labels: + app: mysql + spec: + containers: + - image: mysql:5.6 + name: mysql + env: + # Use secret in real usage + - name: MYSQL_ROOT_PASSWORD + value: password + ports: + - containerPort: 3306 + name: mysql + volumeMounts: + - name: mysql-persistent-storage + mountPath: /var/lib/mysql + volumes: + - name: mysql-persistent-storage + persistentVolumeClaim: + claimName: mysql-pv-claim diff --git a/docs/tutorials/stateful-application/run-stateful-application.md b/docs/tutorials/stateful-application/run-stateful-application.md new file mode 100644 index 0000000000..443d9cdea5 --- /dev/null +++ b/docs/tutorials/stateful-application/run-stateful-application.md @@ -0,0 +1,220 @@ +--- +--- + +{% capture overview %} + +This page shows you how to run a single-instance stateful application +in Kubernetes using a PersistentVolume and a Deployment. The +application is MySQL. + +{% endcapture %} + + +{% capture objectives %} + +* Create a PersistentVolume referencing a disk in your environment. +* Create a MySQL Deployment. +* Expose MySQL to other pods in the cluster at a known DNS name. + +{% endcapture %} + + +{% capture prerequisites %} + +* {% include task-tutorial-prereqs.md %} + +* For data persistence we will create a Persistent Volume that + references a disk in your + environment. See + [here](/docs/user-guide/persistent-volumes/#types-of-persistent-volumes) for + the types of environments supported. This Tutorial will demonstrate + `GCEPersistentDisk` but any type will work. `GCEPersistentDisk` + volumes only work on Google Compute Engine. + +{% endcapture %} + + +{% capture lessoncontent %} + +### Set up a disk in your environment + +You can use any type of persistent volume for your stateful app. See +[Types of Persistent Volumes](/docs/user-guide/persistent-volumes/#types-of-persistent-volumes) +for a list of supported environment disks. For Google Compute Engine, run: + +``` +gcloud compute disks create --size=20GB mysql-disk +``` + +Next create a PersistentVolume that points to the `mysql-disk` +disk just created. Here is a configuration file for a PersistentVolume +that points to the Compute Engine disk above: + +{% include code.html language="yaml" file="gce-volume.yaml" ghlink="/docs/tutorials/stateful-application/gce-volume.yaml" %} + +Notice that the `pdName: mysql-disk` line matches the name of the disk +in the Compute Engine environment. See the +[Persistent Volumes](/docs/user-guide/persistent-volumes/) +for details on writing a PersistentVolume configuration file for other +environments. + +Create the persistent volume: + +``` +kubectl create -f http://k8s.io/docs/tutorials/stateful-application/gce-volume.yaml +``` + + +### Deploy MySQL + +You can run a stateful application by creating a Kubernetes Deployment +and connecting it to an existing PersistentVolume using a +PersistentVolumeClaim. For example, this YAML file describes a +Deployment that runs MySQL and references the PersistentVolumeClaim. The file +defines a volume mount for /var/lib/mysql, and then creates a +PersistentVolumeClaim that looks for a 20G volume. This claim is +satisfied by any volume that meets the requirements, in this case, the +volume created above. + +Note: The password is defined in the config yaml, and this is insecure. See +[Kubernetes Secrets](/docs/user-guide/secrets/) +for a secure solution. + +{% include code.html language="yaml" file="mysql-deployment.yaml" ghlink="/docs/tutorials/stateful-application/mysql-deployment.yaml" %} + +1. Deploy the contents of the YAML file: + + kubectl create -f http://k8s.io/docs/tutorials/stateful-application/mysql-deployment.yaml + +1. Display information about the Deployment: + + kubectl describe deployment mysql + + Name: mysql + Namespace: default + CreationTimestamp: Tue, 01 Nov 2016 11:18:45 -0700 + Labels: app=mysql + Selector: app=mysql + Replicas: 1 updated | 1 total | 0 available | 1 unavailable + StrategyType: Recreate + MinReadySeconds: 0 + OldReplicaSets: + NewReplicaSet: mysql-63082529 (1/1 replicas created) + Events: + FirstSeen LastSeen Count From SubobjectPath Type Reason Message + --------- -------- ----- ---- ------------- -------- ------ ------- + 33s 33s 1 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set mysql-63082529 to 1 + +1. List the pods created by the Deployment: + + kubectl get pods -l app=mysql + + NAME READY STATUS RESTARTS AGE + mysql-63082529-2z3ki 1/1 Running 0 3m + +1. Inspect the Persistent Volume: + + kubectl describe pv mysql-pv + + Name: mysql-pv + Labels: + Status: Bound + Claim: default/mysql-pv-claim + Reclaim Policy: Retain + Access Modes: RWO + Capacity: 20Gi + Message: + Source: + Type: GCEPersistentDisk (a Persistent Disk resource in Google Compute Engine) + PDName: mysql-disk + FSType: ext4 + Partition: 0 + ReadOnly: false + No events. + +1. Inspect the PersistentVolumeClaim: + + kubectl describe pvc mysql-pv-claim + + Name: mysql-pv-claim + Namespace: default + Status: Bound + Volume: mysql-pv + Labels: + Capacity: 20Gi + Access Modes: RWO + No events. + +### Accessing the MySQL instance + +The preceding YAML file creates a service that +allows other Pods in the cluster to access the database. The Service option +`clusterIP: None` lets the Service DNS name resolve directly to the +Pod's IP address. This is optimal when you have only one Pod +behind a Service and you don't intend to increase the number of Pods. + +Run a MySQL client to connect to the server: + +``` +kubectl run -it --rm --image=mysql:5.6 mysql-client -- mysql -h mysql -ppassword +``` + +This command creates a new Pod in the cluster running a mysql client +and connects it to the server through the Service. If it connects, you +know your stateful MySQL database is up and running. + +``` +Waiting for pod default/mysql-client-274442439-zyp6i to be running, status is Pending, pod ready: false +If you don't see a command prompt, try pressing enter. + +mysql> +``` + +### Updating + +The image or any other part of the Deployment can be updated as usual +with the `kubectl apply` command. Here are some precautions that are +specific to stateful apps: + +* Don't scale the app. This setup is for single-instance apps + only. The underlying PersistentVolume can only be mounted to one + Pod. For clustered stateful apps, see the + [StatefulSet documentation](/docs/user-guide/petset/). +* Use `strategy:` `type: Recreate` in the Deployment configuration + YAML file. This instructs Kubernetes to _not_ use rolling + updates. Rolling updates will not work, as you cannot have more than + one Pod running at a time. The `Recreate` strategy will stop the + first pod before creating a new one with the updated configuration. + +### Deleting a deployment + +Delete the deployed objects by name: + +``` +kubectl delete deployment,svc mysql +kubectl delete pvc mysql-pv-claim +kubectl delete pv mysql-pv +``` + +Also, if you are using Compute Engine disks: + +``` +gcloud compute disks delete mysql-disk +``` + +{% endcapture %} + + +{% capture whatsnext %} + +* Learn more about [Deployment objects](/docs/user-guide/deployments/). + +* Learn more about [Deploying applications](/docs/user-guide/deploying-applications/) + +* [kubectl run documentation](/docs/user-guide/kubectl/kubectl_run/) + +* [Volumes](/docs/user-guide/volumes/) and [Persistent Volumes](/docs/user-guide/persistent-volumes/) + +{% endcapture %} + +{% include templates/tutorial.md %} diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md index 70bcb5be6d..4a4eb3ab54 100644 --- a/docs/user-guide/index.md +++ b/docs/user-guide/index.md @@ -4,22 +4,15 @@ assignees: --- -* TOC -{:toc} +The Kubernetes **Guides** can help you work with various aspects of the Kubernetes system. +* The Kubernetes [User Guide](#user-guide-internal) can help you run programs and services on an existing Kubernetes cluster. +* The [Cluster Admin Guide](/docs/admin/) can help you set up and administrate your own Kubernetes cluster. +* The [Developer Guide](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel) can help you either write code to directly access the Kubernetes API, or to contribute directly to the Kubernetes project. -The user guide is intended for anyone who wants to run programs and services on an existing Kubernetes cluster. Setup and administration of a Kubernetes cluster is described in the [Cluster Admin Guide](/docs/admin/). The [Developer Guide](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel) is for anyone wanting to either write code which directly accesses the Kubernetes API, or to contribute directly to the Kubernetes project. +## Kubernetes User Guide -Please ensure you have completed the [prerequisites for running examples from the user guide](/docs/user-guide/prereqs/). - -## Quick walkthrough - -1. [Kubernetes 101](/docs/user-guide/walkthrough/) -1. [Kubernetes 201](/docs/user-guide/walkthrough/k8s201/) - -## Thorough walkthrough - -If you don't have any familiarity with Kubernetes, we recommend you read the following sections in order: +The following topics in the Kubernetes User Guide can help you run applications and services on a Kubernetes cluster: 1. [Quick start: launch and expose an application](/docs/user-guide/quick-start/) 1. [Configuring and launching containers: configuring common container parameters](/docs/user-guide/configuring-containers/) @@ -35,7 +28,9 @@ If you don't have any familiarity with Kubernetes, we recommend you read the fol 1. [Connecting to containers via proxies](/docs/user-guide/connecting-to-applications-proxy/) 1. [Connecting to containers via port forwarding](/docs/user-guide/connecting-to-applications-port-forward/) -## Concept guide +Before running examples in the user guides, please ensure you have completed the [prerequisites](/docs/user-guide/prereqs/). + +## Kubernetes Concepts [**Cluster**](/docs/admin/) : A cluster is a set of physical or virtual machines and other infrastructure resources used by Kubernetes to run your applications. diff --git a/docs/user-guide/nginx-init-containers.yaml b/docs/user-guide/nginx-init-containers.yaml index 34c20fa66a..24124c7459 100644 --- a/docs/user-guide/nginx-init-containers.yaml +++ b/docs/user-guide/nginx-init-containers.yaml @@ -3,7 +3,7 @@ kind: Pod metadata: name: nginx annotations: - pod.alpha.kubernetes.io/init-containers: '[ + pod.beta.kubernetes.io/init-containers: '[ { "name": "install", "image": "busybox", diff --git a/docs/user-guide/node-selection/index.md b/docs/user-guide/node-selection/index.md index 49d30b51c9..725848b544 100644 --- a/docs/user-guide/node-selection/index.md +++ b/docs/user-guide/node-selection/index.md @@ -173,7 +173,7 @@ on node N if node N has a label with key `failure-domain.beta.kubernetes.io/zone such that there is at least one node in the cluster with key `failure-domain.beta.kubernetes.io/zone` and value V that is running a pod that has a label with key "security" and value "S1".) The pod anti-affinity rule says that the pod cannot schedule onto a node if that node is already running a pod with label -having key "security" and value "S2". (If the `topologyKey` were `failure-domain.beta.kuberntes.io/zone` then +having key "security" and value "S2". (If the `topologyKey` were `failure-domain.beta.kubernetes.io/zone` then it would mean that the pod cannot schedule onto a node if that node is in the same zone as a pod with label having key "security" and value "S2".) See the [design doc](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/podaffinity.md). for many more examples of pod affinity and anti-affinity, both the `requiredDuringSchedulingIgnoredDuringExecution` diff --git a/docs/user-guide/pod-states.md b/docs/user-guide/pod-states.md index b29270e5f8..8f745e9f56 100644 --- a/docs/user-guide/pod-states.md +++ b/docs/user-guide/pod-states.md @@ -66,8 +66,8 @@ The possible values for RestartPolicy are `Always`, `OnFailure`, or `Never`. If Three types of controllers are currently available: - Use a [`Job`](/docs/user-guide/jobs/) for pods which are expected to terminate (e.g. batch computations). -- Use a [`ReplicationController`](/docs/user-guide/replication-controller/) for pods which are not expected to - terminate (e.g. web servers). +- Use a [`ReplicationController`](/docs/user-guide/replication-controller/) or [`Deployment`](/docs/user-guide/deployments/) + for pods which are not expected to terminate (e.g. web servers). - Use a [`DaemonSet`](/docs/admin/daemons/): Use for pods which need to run 1 per machine because they provide a machine-specific system service. If you are unsure whether to use ReplicationController or Daemon, then see [Daemon Set versus diff --git a/docs/user-guide/replicasets.md b/docs/user-guide/replicasets.md index d06be55328..cd7f620b15 100644 --- a/docs/user-guide/replicasets.md +++ b/docs/user-guide/replicasets.md @@ -94,7 +94,7 @@ of the replicated pods. kubectl create -f hpa-rs.yaml ``` -Alternatively, you can just use the `kubectl autoscale` command to acommplish the same +Alternatively, you can just use the `kubectl autoscale` command to acomplish the same (and it's easier!) ```shell diff --git a/docs/user-guide/working-with-resources.md b/docs/user-guide/working-with-resources.md index 5b300ee6bd..d2aeeb621e 100644 --- a/docs/user-guide/working-with-resources.md +++ b/docs/user-guide/working-with-resources.md @@ -46,7 +46,7 @@ The system adds fields in several ways: - Some fields are added synchronously with creation of the resource and some are set asynchronously. - For example: `metadata.uid` is set synchronously. (Read more about [metadata](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#metadata)). - - For example, `status.hostIP` is set only after the pod has been scheduled. This often happens fast, but you may notice pods which do not have this set yet. This is called Late Initialization. (Read mode about [status](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status) and [late initialization](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#late-initialization) ). + - For example, `status.hostIP` is set only after the pod has been scheduled. This often happens fast, but you may notice pods which do not have this set yet. This is called Late Initialization. (Read more about [status](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status) and [late initialization](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#late-initialization)). - Some fields are set to default values. Some defaults vary by cluster and some are fixed for the API at a certain version. (Read more about [defaulting](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#defaulting)). - For example, `spec.containers[0].imagePullPolicy` always defaults to `IfNotPresent` in api v1. - For example, `spec.containers[0].resources.limits.cpu` may be defaulted to `100m` on some clusters, to some other value on others, and not defaulted at all on others. diff --git a/editdocs.md b/editdocs.md new file mode 100644 index 0000000000..0291912aca --- /dev/null +++ b/editdocs.md @@ -0,0 +1,42 @@ +--- +layout: docwithnav +--- + + +

 

+ +
+ +

Continue your edit

+ +

Click the below link to edit the page you were just on. When you are done, press "Commit Changes" at the bottom of the screen. This will create a copy of our site on your GitHub account called a "fork." You can make other changes in your fork after it is created, if you want. When you are ready to send us all your changes, go to the index page for your fork and click "New Pull Request" to let us know about it.

+ +

+ +
+
+ +

Edit our site in the cloud

+ +

Click the below button to visit the repo for our site. You can then click the "Fork" button in the upper-right area of the screen to create a copy of our site on your GitHub account called a "fork." Make any changes you want in your fork, and when you are ready to send those changes to us, go to the index page for your fork and click "New Pull Request" to let us know about it.

+ +

Browse this site's source code

+ +
+ + + +{% include_relative README.md %} diff --git a/images/square-logos/aporeto.png b/images/square-logos/aporeto.png new file mode 100644 index 0000000000..94e16c7e2a Binary files /dev/null and b/images/square-logos/aporeto.png differ diff --git a/images/square-logos/cockroach_labs.png b/images/square-logos/cockroach_labs.png new file mode 100644 index 0000000000..85750b1d7f Binary files /dev/null and b/images/square-logos/cockroach_labs.png differ diff --git a/images/square-logos/datadog.png b/images/square-logos/datadog.png index 82d6d11aaf..aeab0f227f 100644 Binary files a/images/square-logos/datadog.png and b/images/square-logos/datadog.png differ diff --git a/images/square-logos/endocode.png b/images/square-logos/endocode.png new file mode 100644 index 0000000000..a90189d6f9 Binary files /dev/null and b/images/square-logos/endocode.png differ diff --git a/images/square-logos/giant_swarm.png b/images/square-logos/giant_swarm.png new file mode 100644 index 0000000000..6434f98735 Binary files /dev/null and b/images/square-logos/giant_swarm.png differ diff --git a/images/square-logos/mirantis.png b/images/square-logos/mirantis.png new file mode 100644 index 0000000000..9dc83103d9 Binary files /dev/null and b/images/square-logos/mirantis.png differ diff --git a/images/square-logos/skippbox.png b/images/square-logos/skippbox.png new file mode 100644 index 0000000000..2ec4fa46e0 Binary files /dev/null and b/images/square-logos/skippbox.png differ diff --git a/images/square-logos/weave_works.png b/images/square-logos/weave_works.png new file mode 100644 index 0000000000..8c05c4ba6d Binary files /dev/null and b/images/square-logos/weave_works.png differ diff --git a/test/examples_test.go b/test/examples_test.go index 1853cdaf0a..7e5660c4f9 100644 --- a/test/examples_test.go +++ b/test/examples_test.go @@ -127,11 +127,11 @@ func validateObject(obj runtime.Object) (errors field.ErrorList) { t.Namespace = api.NamespaceDefault } errors = expvalidation.ValidateDaemonSet(t) - case *batch.ScheduledJob: + case *batch.CronJob: if t.Namespace == "" { t.Namespace = api.NamespaceDefault } - errors = batch_validation.ValidateScheduledJob(t) + errors = batch_validation.ValidateCronJob(t) default: errors = field.ErrorList{} errors = append(errors, field.InternalError(field.NewPath(""), fmt.Errorf("no validation defined for %#v", obj))) @@ -242,7 +242,7 @@ func TestExampleObjectSchemas(t *testing.T) { "redis-resource-deployment": &extensions.Deployment{}, "redis-secret-deployment": &extensions.Deployment{}, "run-my-nginx": &extensions.Deployment{}, - "sj": &batch.ScheduledJob{}, + "sj": &batch.CronJob{}, }, "../docs/admin": { "daemon": &extensions.DaemonSet{}, @@ -272,7 +272,7 @@ func TestExampleObjectSchemas(t *testing.T) { "../docs/user-guide/node-selection": { "pod": &api.Pod{}, "pod-with-node-affinity": &api.Pod{}, - "pod-with-pod-affinity": &api.Pod{}, + "pod-with-pod-affinity": &api.Pod{}, }, "../docs/admin/resourcequota": { "best-effort": &api.ResourceQuota{},