Merge branch 'master' into release-1.12
This commit is contained in:
Zach Arnold
@@ -19,4 +19,3 @@ install:
|
||||
|
||||
script:
|
||||
- go test -v k8s.io/website/content/en/examples
|
||||
#- ./verify-docs-format.sh
|
||||
|
||||
+1
-1
@@ -71,7 +71,7 @@ githubbranch = "master"
|
||||
docsbranch = "master"
|
||||
deprecated = false
|
||||
currentUrl = "https://kubernetes.io/docs/home/"
|
||||
nextUrl = "http://kubernetes-io-vnext-staging.netlify.com/"
|
||||
nextUrl = "https://kubernetes-io-vnext-staging.netlify.com/"
|
||||
githubWebsiteRepo = "github.com/kubernetes/website"
|
||||
githubWebsiteRaw = "raw.githubusercontent.com/kubernetes/website"
|
||||
|
||||
|
||||
@@ -178,7 +178,7 @@ in the section [Interlude: built-in node labels](#interlude-built-in-node-labels
|
||||
processing which can slow down scheduling in large clusters significantly. We do
|
||||
not recommend using them in clusters larger than several hundred nodes.
|
||||
|
||||
**Note:** Pod anti-affinity requires nodes to be consistently labelled, i.e. every node in the cluster must have an appropriate label matching `topologyKey`. If some or all nodes are missing the speficied `topologyKey` label, it can lead to unintended behavior.
|
||||
**Note:** Pod anti-affinity requires nodes to be consistently labelled, i.e. every node in the cluster must have an appropriate label matching `topologyKey`. If some or all nodes are missing the specified `topologyKey` label, it can lead to unintended behavior.
|
||||
|
||||
As with node affinity, there are currently two types of pod affinity and anti-affinity, called `requiredDuringSchedulingIgnoredDuringExecution` and
|
||||
`preferredDuringSchedulingIgnoredDuringExecution` which denote "hard" vs. "soft" requirements.
|
||||
|
||||
@@ -53,8 +53,6 @@ To write a new concept page, create a Markdown file in a subdirectory of the
|
||||
need):
|
||||
|
||||
```
|
||||
{% raw %}
|
||||
|
||||
{{%/* capture overview */%}}
|
||||
|
||||
{{%/* /capture */%}}
|
||||
@@ -66,8 +64,6 @@ To write a new concept page, create a Markdown file in a subdirectory of the
|
||||
{{%/* capture whatsnext */%}}
|
||||
|
||||
{{%/* /capture */%}}
|
||||
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
- Within each section, write your content. Use the following guidelines:
|
||||
@@ -107,8 +103,6 @@ To write a new task page, create a Markdown file in a subdirectory of the
|
||||
need):
|
||||
|
||||
```
|
||||
{% raw %}
|
||||
|
||||
{{%/* capture overview */%}}
|
||||
|
||||
{{%/* /capture */%}}
|
||||
@@ -130,8 +124,6 @@ To write a new task page, create a Markdown file in a subdirectory of the
|
||||
{{%/* capture whatsnext */%}}
|
||||
|
||||
{{%/* /capture */%}}
|
||||
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
- Within each section, write your content. Use the following guidelines:
|
||||
@@ -177,8 +169,6 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
|
||||
need):
|
||||
|
||||
```
|
||||
{% raw %}
|
||||
|
||||
{{%/* capture overview */%}}
|
||||
|
||||
{{%/* /capture */%}}
|
||||
@@ -204,7 +194,6 @@ To write a new tutorial page, create a Markdown file in a subdirectory of the
|
||||
{{%/* capture whatsnext */%}}
|
||||
|
||||
{{%/* /capture */%}}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
- Within each section, write your content. Use the following guidelines:
|
||||
|
||||
@@ -4,11 +4,92 @@ reviewers:
|
||||
- erictune
|
||||
- mikedanese
|
||||
no_issue: true
|
||||
weight: 30
|
||||
title: Setup
|
||||
main_menu: true
|
||||
weight: 30
|
||||
content_template: templates/concept
|
||||
---
|
||||
|
||||
This section provides instructions for installing Kubernetes and setting
|
||||
up a Kubernetes cluster. For an overview of the different options, see
|
||||
[Picking the Right Solution](/docs/setup/pick-right-solution/).
|
||||
{{% capture overview %}}
|
||||
|
||||
Use this page to find the type of solution that best fits your needs.
|
||||
|
||||
Deciding where to run Kubernetes depends on what resources you have available
|
||||
and how much flexibility you need. You can run Kubernetes almost anywhere,
|
||||
from your laptop to VMs on a cloud provider to a rack of bare metal servers.
|
||||
You can also set up a fully-managed cluster by running a single command or craft
|
||||
your own customized cluster on your bare metal servers.
|
||||
|
||||
{{% /capture %}}
|
||||
|
||||
{{% capture body %}}
|
||||
|
||||
## Local-machine Solutions
|
||||
|
||||
A local-machine solution is an easy way to get started with Kubernetes. You
|
||||
can create and test Kubernetes clusters without worrying about consuming cloud
|
||||
resources and quotas.
|
||||
|
||||
You should pick a local solution if you want to:
|
||||
|
||||
* Try or start learning about Kubernetes
|
||||
* Develop and test clusters locally
|
||||
|
||||
Pick a [local-machine solution](/docs/setup/pick-right-solution/#local-machine-solutions).
|
||||
|
||||
## Hosted Solutions
|
||||
|
||||
Hosted solutions are a convenient way to create and maintain Kubernetes clusters. They
|
||||
manage and operate your clusters so you don’t have to.
|
||||
|
||||
You should pick a hosted solution if you:
|
||||
|
||||
* Want a fully-managed solution
|
||||
* Want to focus on developing your apps or services
|
||||
* Don’t have dedicated site reliability engineering (SRE) team but want high availability
|
||||
* Don't have resources to host and monitor your clusters
|
||||
|
||||
Pick a [hosted solution](/docs/setup/pick-right-solution/#hosted-solutions).
|
||||
|
||||
## Turnkey – Cloud Solutions
|
||||
|
||||
|
||||
These solutions allow you to create Kubernetes clusters with only a few commands and
|
||||
are actively developed and have active community support. They can also be hosted on
|
||||
a range of Cloud IaaS providers, but they offer more freedom and flexibility in
|
||||
exchange for effort.
|
||||
|
||||
You should pick a turnkey cloud solution if you:
|
||||
|
||||
* Want more control over your clusters than the hosted solutions allow
|
||||
* Want to take on more operations ownership
|
||||
|
||||
Pick a [turnkey cloud solution](/docs/setup/pick-right-solution/#turnkey-cloud-solutions)
|
||||
|
||||
## Turnkey – On-Premises Solutions
|
||||
|
||||
These solutions allow you to create Kubernetes clusters on your internal, secure,
|
||||
cloud network with only a few commands.
|
||||
|
||||
You should pick a on-prem turnkey cloud solution if you:
|
||||
|
||||
* Want to deploy clusters on your private cloud network
|
||||
* Have a dedicated SRE team
|
||||
* Have the the resources to host and monitor your clusters
|
||||
|
||||
Pick an [on-prem turnkey cloud solution](/docs/setup/pick-right-solution/#on-premises-turnkey-cloud-solutions).
|
||||
|
||||
## Custom Solutions
|
||||
|
||||
Custom solutions give you the most freedom over your clusters but require the
|
||||
most expertise. These solutions range from bare-metal to cloud providers on
|
||||
different operating systems.
|
||||
|
||||
Pick a [custom solution](/docs/setup/pick-right-solution/#custom-solutions).
|
||||
|
||||
{{% /capture %}}
|
||||
|
||||
{{% capture whatsnext %}}
|
||||
Go to [Picking the Right Solution](/docs/setup/pick-right-solution/) for a complete
|
||||
list of solutions.
|
||||
{{% /capture %}}
|
||||
|
||||
@@ -34,86 +34,85 @@ a Kubernetes cluster from scratch.
|
||||
|
||||
* [Minikube](/docs/setup/minikube/) is the recommended method for creating a local, single-node Kubernetes cluster for development and testing. Setup is completely automated and doesn't require a cloud provider account.
|
||||
|
||||
* [Kubeadm-dind](https://github.com/kubernetes-sigs/kubeadm-dind-cluster) is a multi-node (while minikube is single-node) Kubernetes cluster which only requires a docker daemon. It uses docker-in-docker technique to spawn the Kubernetes cluster.
|
||||
|
||||
* [Ubuntu on LXD](/docs/getting-started-guides/ubuntu/local/) supports a nine-instance deployment on localhost.
|
||||
|
||||
* [IBM Cloud Private-CE (Community Edition)](https://github.com/IBM/deploy-ibm-cloud-private) can use VirtualBox on your machine to deploy Kubernetes to one or more VMs for development and test scenarios. Scales to full multi-node cluster.
|
||||
|
||||
* [IBM Cloud Private-CE (Community Edition) on Linux Containers](https://github.com/HSBawa/icp-ce-on-linux-containers) is a Terraform/Packer/BASH based Infrastructure as Code (IaC) scripts to create a seven node (1 Boot, 1 Master, 1 Management, 1 Proxy and 3 Workers) LXD cluster on Linux Host.
|
||||
|
||||
* [Kubeadm-dind](https://github.com/kubernetes-sigs/kubeadm-dind-cluster) is a multi-node (while minikube is single-node) Kubernetes cluster which only requires a docker daemon. It uses docker-in-docker technique to spawn the Kubernetes cluster.
|
||||
|
||||
* [Ubuntu on LXD](/docs/getting-started-guides/ubuntu/local/) supports a nine-instance deployment on localhost.
|
||||
|
||||
## Hosted Solutions
|
||||
|
||||
* [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/) offers managed Kubernetes clusters.
|
||||
* [AppsCode.com](https://appscode.com/products/cloud-deployment/) provides managed Kubernetes clusters for various public clouds, including AWS and Google Cloud Platform.
|
||||
|
||||
* [APPUiO](https://appuio.ch) runs an OpenShift public cloud platform, supporting any Kubernetes workload. Additionally APPUiO offers Private Managed OpenShift Clusters, running on any public or private cloud.
|
||||
|
||||
* [Amazon Elastic Container Service for Kubernetes](https://aws.amazon.com/eks/) offers managed Kubernetes service.
|
||||
|
||||
* [Azure Kubernetes Service](https://azure.microsoft.com/services/container-service/) offers managed Kubernetes clusters.
|
||||
|
||||
* [Stackpoint.io](https://stackpoint.io) provides Kubernetes infrastructure automation and management for multiple public clouds.
|
||||
* [Giant Swarm](https://giantswarm.io/product/) offers managed Kubernetes clusters in their own datacenter, on-premises, or on public clouds.
|
||||
|
||||
* [AppsCode.com](https://appscode.com/products/cloud-deployment/) provides managed Kubernetes clusters for various public clouds, including AWS and Google Cloud Platform.
|
||||
* [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/) offers managed Kubernetes clusters.
|
||||
|
||||
* [IBM Cloud Kubernetes Service](https://console.bluemix.net/docs/containers/container_index.html) offers managed Kubernetes clusters with isolation choice, operational tools, integrated security insight into images and containers, and integration with Watson, IoT, and data.
|
||||
|
||||
* [Kubermatic](https://www.loodse.com) provides managed Kubernetes clusters for various public clouds, including AWS and Digital Ocean, as well as on-premises with OpenStack integration.
|
||||
|
||||
* [Kublr](https://kublr.com) offers enterprise-grade secure, scalable, highly reliable Kubernetes clusters on AWS, Azure, GCP, and on-premise. It includes out-of-the-box backup and disaster recovery, multi-cluster centralized logging and monitoring, and built-in alerting.
|
||||
|
||||
* [Madcore.Ai](https://madcore.ai) is devops-focused CLI tool for deploying Kubernetes infrastructure in AWS. Master, auto-scaling group nodes with spot-instances, ingress-ssl-lego, Heapster, and Grafana.
|
||||
|
||||
* [Platform9](https://platform9.com/products/kubernetes/) offers managed Kubernetes on-premises or on any public cloud, and provides 24/7 health monitoring and alerting. (Kube2go, a web-UI driven Kubernetes cluster deployment service Platform9 released, has been integrated to Platform9 Sandbox.)
|
||||
|
||||
* [OpenShift Dedicated](https://www.openshift.com/dedicated/) offers managed Kubernetes clusters powered by OpenShift.
|
||||
|
||||
* [OpenShift Online](https://www.openshift.com/features/) provides free hosted access for Kubernetes applications.
|
||||
|
||||
* [IBM Cloud Kubernetes Service](https://console.bluemix.net/docs/containers/container_index.html) offers managed Kubernetes clusters with isolation choice, operational tools, integrated security insight into images and containers, and integration with Watson, IoT, and data.
|
||||
|
||||
* [Giant Swarm](https://giantswarm.io/product/) offers managed Kubernetes clusters in their own datacenter, on-premises, or on public clouds.
|
||||
|
||||
* [Kubermatic](https://www.loodse.com) provides managed Kubernetes clusters for various public clouds, including AWS and Digital Ocean, as well as on-premises with OpenStack integration.
|
||||
|
||||
* [Oracle Container Engine for Kubernetes](https://docs.us-phoenix-1.oraclecloud.com/Content/ContEng/Concepts/contengoverview.htm) is a fully-managed, scalable, and highly available service that you can use to deploy your containerized applications to the cloud.
|
||||
|
||||
* [Kublr](https://kublr.com) offers enterprise-grade secure, scalable, highly reliable Kubernetes clusters on AWS, Azure, GCP, and on-premise. It includes out-of-the-box backup and disaster recovery, multi-cluster centralized logging and monitoring, and built-in alerting.
|
||||
* [Platform9](https://platform9.com/products/kubernetes/) offers managed Kubernetes on-premises or on any public cloud, and provides 24/7 health monitoring and alerting. (Kube2go, a web-UI driven Kubernetes cluster deployment service Platform9 released, has been integrated to Platform9 Sandbox.)
|
||||
|
||||
* [APPUiO](https://appuio.ch) runs an OpenShift public cloud platform, supporting any Kubernetes workload. Additionally APPUiO offers Private Managed OpenShift Clusters, running on any public or private cloud.
|
||||
* [Stackpoint.io](https://stackpoint.io) provides Kubernetes infrastructure automation and management for multiple public clouds.
|
||||
|
||||
# Turnkey Cloud Solutions
|
||||
## Turnkey Cloud Solutions
|
||||
|
||||
These solutions allow you to create Kubernetes clusters on a range of Cloud IaaS providers with only a
|
||||
few commands. These solutions are actively developed and have active community support.
|
||||
|
||||
* [Conjure-up Kubernetes with Ubuntu on AWS, Azure, Google Cloud, Oracle Cloud](/docs/getting-started-guides/ubuntu/)
|
||||
* [Google Compute Engine (GCE)](/docs/setup/turnkey/gce/)
|
||||
* [AWS](/docs/setup/turnkey/aws/)
|
||||
* [Azure](/docs/setup/turnkey/azure/)
|
||||
* [Tectonic by CoreOS](https://coreos.com/tectonic)
|
||||
* [CenturyLink Cloud](/docs/setup/turnkey/clc/)
|
||||
* [IBM Cloud](https://github.com/patrocinio/kubernetes-softlayer)
|
||||
* [IBM Cloud Private Running on Multiple Clouds](https://www.ibm.com/developerworks/community/wikis/home?lang=en-us#!/wiki/W1559b1be149d_43b0_881e_9783f38faaff/page/IBM%20Cloud%20Private%20running%20on%20multiple%20clouds)
|
||||
* [Stackpoint.io](/docs/setup/turnkey/stackpoint/)
|
||||
* [Madcore.Ai](https://madcore.ai/)
|
||||
* [Kubermatic](https://cloud.kubermatic.io)
|
||||
* [Rancher 2.0](https://rancher.com/docs/rancher/v2.x/en/)
|
||||
* [Oracle Container Engine for K8s](https://docs.us-phoenix-1.oraclecloud.com/Content/ContEng/Concepts/contengprerequisites.htm)
|
||||
* [Gardener](https://gardener.cloud/)
|
||||
* [Kontena Pharos](https://kontena.io/pharos/)
|
||||
* [Kublr](https://kublr.com/)
|
||||
* [Agile Stacks](https://www.agilestacks.com/products/kubernetes)
|
||||
* [Alibaba Cloud](/docs/setup/turnkey/alibaba-cloud/)
|
||||
* [APPUiO](https://appuio.ch)
|
||||
* [AWS](/docs/setup/turnkey/aws/)
|
||||
* [Azure](/docs/setup/turnkey/azure/)
|
||||
* [CenturyLink Cloud](/docs/setup/turnkey/clc/)
|
||||
* [Conjure-up Kubernetes with Ubuntu on AWS, Azure, Google Cloud, Oracle Cloud](/docs/getting-started-guides/ubuntu/)
|
||||
* [Gardener](https://gardener.cloud/)
|
||||
* [Google Compute Engine (GCE)](/docs/setup/turnkey/gce/)
|
||||
* [IBM Cloud](https://github.com/patrocinio/kubernetes-softlayer)
|
||||
* [Kontena Pharos](https://kontena.io/pharos/)
|
||||
* [Kubermatic](https://cloud.kubermatic.io)
|
||||
* [Kublr](https://kublr.com/)
|
||||
* [Madcore.Ai](https://madcore.ai/)
|
||||
* [Oracle Container Engine for K8s](https://docs.us-phoenix-1.oraclecloud.com/Content/ContEng/Concepts/contengprerequisites.htm)
|
||||
* [Pivotal Container Service](https://pivotal.io/platform/pivotal-container-service)
|
||||
* [Rancher 2.0](https://rancher.com/docs/rancher/v2.x/en/)
|
||||
* [Stackpoint.io](/docs/setup/turnkey/stackpoint/)
|
||||
* [Tectonic by CoreOS](https://coreos.com/tectonic)
|
||||
|
||||
## On-Premises turnkey cloud solutions
|
||||
These solutions allow you to create Kubernetes clusters on your internal, secure, cloud network with only a
|
||||
few commands.
|
||||
|
||||
* [IBM Cloud Private](https://www.ibm.com/cloud-computing/products/ibm-cloud-private/)
|
||||
* [Kubermatic](https://www.loodse.com)
|
||||
* [SUSE CaaS Platform](https://www.suse.com/products/caas-platform)
|
||||
* [SUSE Cloud Application Platform](https://www.suse.com/products/cloud-application-platform/)
|
||||
* [Rancher 2.0](https://rancher.com/docs/rancher/v2.x/en/)
|
||||
* [Kontena Pharos](https://kontena.io/pharos/)
|
||||
* [Kublr](https://kublr.com/)
|
||||
* [Agile Stacks](https://www.agilestacks.com/products/kubernetes)
|
||||
* [APPUiO](https://appuio.ch)
|
||||
* [IBM Cloud Private](https://www.ibm.com/cloud-computing/products/ibm-cloud-private/)
|
||||
* [Kontena Pharos](https://kontena.io/pharos/)
|
||||
* [Kubermatic](https://www.loodse.com)
|
||||
* [Kublr](https://kublr.com/)
|
||||
* [Pivotal Container Service](https://pivotal.io/platform/pivotal-container-service)
|
||||
* [Rancher 2.0](https://rancher.com/docs/rancher/v2.x/en/)
|
||||
* [SUSE CaaS Platform](https://www.suse.com/products/caas-platform)
|
||||
* [SUSE Cloud Application Platform](https://www.suse.com/products/cloud-application-platform/)
|
||||
|
||||
## Custom Solutions
|
||||
|
||||
@@ -139,28 +138,28 @@ with a single command per machine.
|
||||
These solutions are combinations of cloud providers and operating systems not covered by the above solutions.
|
||||
|
||||
* [CoreOS on AWS or GCE](/docs/setup/custom-cloud/coreos/)
|
||||
* [Gardener](https://gardener.cloud/)
|
||||
* [Kublr](https://kublr.com/)
|
||||
* [Kubernetes on Ubuntu](/docs/getting-started-guides/ubuntu/)
|
||||
* [Kubespray](/docs/setup/custom-cloud/kubespray/)
|
||||
* [Rancher Kubernetes Engine (RKE)](https://github.com/rancher/rke)
|
||||
* [Gardener](https://gardener.cloud/)
|
||||
* [Kublr](https://kublr.com/)
|
||||
|
||||
### On-Premises VMs
|
||||
|
||||
* [Vagrant](/docs/setup/custom-cloud/coreos/) (uses CoreOS and flannel)
|
||||
* [CloudStack](/docs/setup/on-premises-vm/cloudstack/) (uses Ansible, CoreOS and flannel)
|
||||
* [Fedora (Multi Node)](/docs/getting-started-guides/fedora/flannel_multi_node_cluster/) (uses Fedora and flannel)
|
||||
* [oVirt](/docs/setup/on-premises-vm/ovirt/)
|
||||
* [Vagrant](/docs/setup/custom-cloud/coreos/) (uses CoreOS and flannel)
|
||||
* [VMware](/docs/setup/custom-cloud/coreos/) (uses CoreOS and flannel)
|
||||
* [VMware vSphere](https://vmware.github.io/vsphere-storage-for-kubernetes/documentation/)
|
||||
* [VMware vSphere, OpenStack, or Bare Metal](/docs/getting-started-guides/ubuntu/) (uses Juju, Ubuntu and flannel)
|
||||
* [VMware](/docs/setup/custom-cloud/coreos/) (uses CoreOS and flannel)
|
||||
* [oVirt](/docs/setup/on-premises-vm/ovirt/)
|
||||
* [Fedora (Multi Node)](/docs/getting-started-guides/fedora/flannel_multi_node_cluster/) (uses Fedora and flannel)
|
||||
|
||||
### Bare Metal
|
||||
|
||||
* [CoreOS](/docs/setup/custom-cloud/coreos/)
|
||||
* [Fedora (Single Node)](/docs/getting-started-guides/fedora/fedora_manual_config/)
|
||||
* [Fedora (Multi Node)](/docs/getting-started-guides/fedora/flannel_multi_node_cluster/)
|
||||
* [Kubernetes on Ubuntu](/docs/getting-started-guides/ubuntu/)
|
||||
* [CoreOS](/docs/setup/custom-cloud/coreos/)
|
||||
|
||||
### Integrations
|
||||
|
||||
@@ -218,7 +217,7 @@ any | RKE | multi-support | flannel or canal
|
||||
any | [Gardener Cluster-Operator](https://kubernetes.io/blog/2018/05/17/gardener/) | multi-support | multi-support | [docs](https://gardener.cloud) | [Project/Community](https://github.com/gardener) and [Commercial]( https://cloudplatform.sap.com/)
|
||||
Alibaba Cloud Container Service For Kubernetes | ROS | CentOS | flannel/Terway | [docs](https://www.aliyun.com/product/containerservice) | Commercial
|
||||
Agile Stacks | Terraform | CoreOS | multi-support | [docs](https://www.agilestacks.com/products/kubernetes) | Commercial
|
||||
IBM Cloud Kubernetes Service | | Ubuntu | calico | [docs](https://console.bluemix.net/docs/containers/container_index.html) | Commercial
|
||||
IBM Cloud Kubernetes Service | | Ubuntu | calico | [docs](https://console.bluemix.net/docs/containers/container_index.html) | Commercial
|
||||
|
||||
|
||||
{{< note >}}
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
# Put files you want to skip "title:" check here:
|
||||
docs/reference/generated/README.md
|
||||
docs/reference/generated/federation/v1/operations.html
|
||||
docs/reference/generated/federation/v1/definitions.html
|
||||
docs/reference/generated/federation/extensions/v1beta1/operations.html
|
||||
docs/reference/generated/federation/extensions/v1beta1/definitions.html
|
||||
docs/sitemap.md
|
||||
docs/reference/setup-tools/kubeadm/generated/README.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md
|
||||
@@ -1,75 +0,0 @@
|
||||
# Put files you want to skip table of contents entry check here:
|
||||
docs/concepts/example-concept-template.md
|
||||
docs/reference/generated/README.md
|
||||
docs/search.md
|
||||
docs/sitemap.md
|
||||
docs/tasks/example-task-template.md
|
||||
docs/tutorials/example-tutorial-template.md
|
||||
docs/reference/setup-tools/kubeadm/generated/README.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md
|
||||
docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md
|
||||
docs/user-journeys/users/cluster-operator/_advanced.md
|
||||
@@ -1,62 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
no_entry=false
|
||||
no_entry_counter=0
|
||||
no_title=false
|
||||
no_title_counter=0
|
||||
|
||||
# Verify all docs/.../*.md files
|
||||
# Skip checking autogenerated files in some folders
|
||||
# (docs/api-reference/v1.5, docs/user-guide/kubectl/v1.5, and
|
||||
# docs/resources-reference/v1.5)
|
||||
for file in `find docs -name "*.md" -type f`; do
|
||||
# Skip checking all files in the following folders
|
||||
if [[ "${file}" == "docs/api-reference/v1."* ]] ||
|
||||
[[ "${file}" == "docs/user-guide/kubectl/v1."* ]] ||
|
||||
[[ "${file}" == "docs/resources-reference/v1."* ]]; then
|
||||
continue
|
||||
fi
|
||||
|
||||
# 1. TOC check:
|
||||
# Check they are referenced in at least one of _data/*.yml files.
|
||||
# Skip checking files in skip_toc_check.txt
|
||||
if ! grep -q "${file}" skip_toc_check.txt; then
|
||||
path=${file%.*}
|
||||
# abc/index.md should point to abc, not abc/index
|
||||
path=${path%%index}
|
||||
if ! grep -q "${path}" _data/*.yml; then
|
||||
echo "Error: ${file} doesn't have an entry in the table of contents under _data/*.yml"
|
||||
no_entry=true
|
||||
no_entry_counter=$[no_entry_counter+1]
|
||||
fi
|
||||
fi
|
||||
|
||||
# 2. Title check:
|
||||
# Check they have a proper title.
|
||||
# Skip checking files in skip_title_check.txt.
|
||||
# Title should start with "title:" and can have several spaces/tabs between
|
||||
# non-space/tab content. They should also be inside the markdown header.
|
||||
# For example, "title:", " title: abc", and "title:" aren't valid,
|
||||
# but "title: abc", "title:def" and "title: def ghi" are both valid.
|
||||
if [[ "${file}" == "docs/user-guide/kubectl/kubectl"* ]]; then
|
||||
# Skip checking auto-generated kubectl docs since its first heading matches title
|
||||
continue
|
||||
fi
|
||||
if ! grep -q "${file}" skip_title_check.txt; then
|
||||
if ! grep -q "^title:\s*[^\s]" ${file}; then
|
||||
echo "Error: ${file} doesn't have a proper title defined!"
|
||||
no_title=true
|
||||
no_title_counter=$[no_title_counter+1]
|
||||
fi
|
||||
fi
|
||||
done
|
||||
|
||||
if ${no_entry}; then
|
||||
echo "Found ${no_entry_counter} files without entries. For how to fix it, see http://kubernetes.io/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ${no_title}; then
|
||||
echo "Found ${no_title_counter} files without titles."
|
||||
exit 1
|
||||
fi
|
||||
Reference in New Issue
Block a user