Skip to content
Permalink
Browse files

Restructure the left navigation pane of setup (#14826)

* restructure left nav

* Restructure setup left navigation

* Update _redirects

* Incorporated all the changes suggested

* removed the Thumbs.db file
  • Loading branch information...
Rajakavitha1 authored and k8s-ci-robot committed Jun 12, 2019
1 parent f60947b commit 55ac801bc447ae185b6d0dd22ac5793e91f329fe
Showing with 250 additions and 244 deletions.
  1. +1 −1 content/en/docs/concepts/cluster-administration/federation.md
  2. +1 −1 content/en/docs/concepts/containers/runtime-class.md
  3. +3 −3 content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md
  4. +4 −4 content/en/docs/reference/tools.md
  5. +22 −22 content/en/docs/reference/using-api/deprecation-policy.md
  6. +3 −3 content/en/docs/setup/_index.md
  7. +4 −0 content/en/docs/setup/best-practices/_index.md
  8. +6 −5 content/en/docs/setup/{ → best-practices}/certificates.md
  9. +2 −2 content/en/docs/setup/{ → best-practices}/cluster-large.md
  10. +2 −2 content/en/docs/setup/{ → best-practices}/multiple-zones.md
  11. +2 −1 content/en/docs/setup/{ → best-practices}/node-conformance.md
  12. +0 −4 content/en/docs/setup/custom-cloud/_index.md
  13. +0 −5 content/en/docs/setup/independent/_index.md
  14. +4 −0 content/en/docs/setup/learning-environment/_index.md
  15. +5 −5 content/en/docs/setup/{ → learning-environment}/minikube.md
  16. +4 −0 content/en/docs/setup/production-environment/_index.md
  17. +3 −4 content/en/docs/setup/{cri.md → production-environment/container-runtimes.md}
  18. +1 −1 content/en/docs/setup/{ → production-environment}/on-premises-vm/_index.md
  19. +1 −1 content/en/docs/setup/{ → production-environment}/on-premises-vm/cloudstack.md
  20. 0 content/en/docs/setup/{ → production-environment}/on-premises-vm/dcos.md
  21. +1 −1 content/en/docs/setup/{ → production-environment}/on-premises-vm/ovirt.md
  22. +4 −0 content/en/docs/setup/production-environment/tools/_index.md
  23. +2 −1 content/en/docs/setup/{custom-cloud → production-environment/tools}/kops.md
  24. +4 −3 content/en/docs/setup/{on-premises-metal → production-environment/tools}/krib.md
  25. +4 −0 content/en/docs/setup/production-environment/tools/kubeadm/_index.md
  26. +1 −1 content/en/docs/setup/{independent → production-environment/tools/kubeadm}/control-plane-flags.md
  27. +23 −24 content/en/docs/setup/{independent → production-environment/tools/kubeadm}/create-cluster-kubeadm.md
  28. +4 −4 content/en/docs/setup/{independent → production-environment/tools/kubeadm}/ha-topology.md
  29. +9 −17 content/en/docs/setup/{independent → production-environment/tools/kubeadm}/high-availability.md
  30. +9 −7 content/en/docs/setup/{independent → production-environment/tools/kubeadm}/install-kubeadm.md
  31. 0 content/en/docs/setup/{independent → production-environment/tools/kubeadm}/kubelet-integration.md
  32. +2 −4 .../en/docs/setup/{independent → production-environment/tools/kubeadm}/setup-ha-etcd-with-kubeadm.md
  33. +7 −7 ...ent/en/docs/setup/{independent → production-environment/tools/kubeadm}/troubleshooting-kubeadm.md
  34. +2 −1 content/en/docs/setup/{custom-cloud → production-environment/tools}/kubespray.md
  35. +1 −1 content/en/docs/setup/{ → production-environment}/turnkey/_index.md
  36. +1 −1 content/en/docs/setup/{ → production-environment}/turnkey/alibaba-cloud.md
  37. 0 content/en/docs/setup/{ → production-environment}/turnkey/aws.md
  38. 0 content/en/docs/setup/{ → production-environment}/turnkey/azure.md
  39. 0 content/en/docs/setup/{ → production-environment}/turnkey/clc.md
  40. +2 −2 content/en/docs/setup/{ → production-environment}/turnkey/gce.md
  41. 0 content/en/docs/setup/{ → production-environment}/turnkey/icp.md
  42. 0 content/en/docs/setup/{ → production-environment}/turnkey/stackpoint.md
  43. +1 −1 content/en/docs/setup/{ → production-environment}/windows/_index.md
  44. BIN content/en/docs/setup/{ → production-environment}/windows/flannel-master-kubeclt-get-pods.png
  45. BIN content/en/docs/setup/{ → production-environment}/windows/flannel-master-kubectl-get-ds.png
  46. +21 −21 content/en/docs/setup/{ → production-environment}/windows/intro-windows-in-kubernetes.md
  47. 0 content/en/docs/setup/{ → production-environment}/windows/user-guide-windows-containers.md
  48. +5 −4 content/en/docs/setup/{ → production-environment}/windows/user-guide-windows-nodes.md
  49. BIN content/en/docs/setup/{ → production-environment}/windows/windows-docker-error.png
  50. +2 −3 content/en/docs/setup/release/_index.md
  51. +0 −33 content/en/docs/setup/release/building-from-source.md
  52. +8 −7 content/en/docs/setup/release/notes.md
  53. +7 −7 content/en/docs/setup/{ → release}/version-skew-policy.md
  54. +1 −1 content/en/docs/tasks/administer-cluster/highly-available-master.md
  55. +15 −15 content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-certs.md
  56. +1 −1 content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-ha-1-12.md
  57. +1 −1 content/en/docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade-ha-1-13.md
  58. +1 −1 content/en/docs/tasks/debug-application-cluster/monitor-node-health.md
  59. +2 −2 content/en/docs/tasks/run-application/horizontal-pod-autoscale-walkthrough.md
  60. +1 −1 content/en/docs/tasks/tools/install-minikube.md
  61. +1 −1 content/en/docs/user-journeys/users/application-developer/foundational.md
  62. +3 −5 content/en/docs/user-journeys/users/cluster-operator/foundational.md
  63. +1 −1 content/en/includes/partner-script.js
  64. +1 −1 data/setup.yml
  65. +34 −0 static/_redirects
@@ -170,7 +170,7 @@ users in the event of a cluster failure), then you need to have `R * (U + 1)` cl

Finally, if any of your clusters would need more than the maximum recommended number of nodes for a Kubernetes cluster, then
you may need even more clusters. Kubernetes v1.3 supports clusters up to 1000 nodes in size. Kubernetes v1.8 supports
clusters up to 5000 nodes. See [Building Large Clusters](/docs/setup/cluster-large/) for more guidance.
clusters up to 5000 nodes. See [Building Large Clusters](/docs/setup/best-practices/cluster-large/) for more guidance.

{{% /capture %}}

@@ -115,7 +115,7 @@ to the behavior when the RuntimeClass feature is disabled.

### CRI Configuration

For more details on setting up CRI runtimes, see [CRI installation](/docs/setup/cri/).
For more details on setting up CRI runtimes, see [CRI installation](/docs/setup/production-environment/container-runtimes/).

#### dockershim

@@ -136,7 +136,7 @@ For information about enabling IPVS mode with kubeadm see:
### Passing custom flags to control plane components {#control-plane-flags}

For information about passing flags to control plane components see:
- [control-plane-flags](/docs/setup/independent/control-plane-flags/)
- [control-plane-flags](/docs/setup/production-environment/tools/kubeadm/control-plane-flags/)

### Using custom images {#custom-images}

@@ -231,7 +231,7 @@ using an external CRI implementation.
### Setting the node name

By default, `kubeadm` assigns a node name based on a machine's host address. You can override this setting with the `--node-name`flag.
The flag passes the appropriate [`--hostname-override`](/docs/reference/command-line-tools-reference/kubelet/#options)
The flag passes the appropriate [`--hostname-override`](/docs/reference/command-line-tools-reference/kubelet/#options)
to the kubelet.

Be aware that overriding the hostname can [interfere with cloud providers](https://github.com/kubernetes/website/pull/8873).
@@ -304,7 +304,7 @@ don't require an `-${ARCH}` suffix.
### Automating kubeadm

Rather than copying the token you obtained from `kubeadm init` to each node, as
in the [basic kubeadm tutorial](/docs/setup/independent/create-cluster-kubeadm/), you can parallelize the
in the [basic kubeadm tutorial](/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/), you can parallelize the
token distribution for easier automation. To implement this automation, you must
know the IP address that the control-plane node will have after it is started.

@@ -14,9 +14,9 @@ Kubernetes contains several built-in tools to help you work with the Kubernetes

[`kubectl`](/docs/tasks/tools/install-kubectl/) is the command line tool for Kubernetes. It controls the Kubernetes cluster manager.

## Kubeadm
## Kubeadm

[`kubeadm`](/docs/setup/independent/install-kubeadm/) is the command line tool for easily provisioning a secure Kubernetes cluster on top of physical or cloud servers or virtual machines (currently in alpha).
[`kubeadm`](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/) is the command line tool for easily provisioning a secure Kubernetes cluster on top of physical or cloud servers or virtual machines (currently in alpha).

## Kubefed

@@ -29,10 +29,10 @@ to help you administrate your federated clusters.
easy to run a single-node Kubernetes cluster locally on your workstation for
development and testing purposes.

## Dashboard
## Dashboard

[`Dashboard`](/docs/tasks/access-application-cluster/web-ui-dashboard/), the web-based user interface of Kubernetes, allows you to deploy containerized applications
to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself.
to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself.

## Helm

@@ -87,13 +87,13 @@ no less than:**
* **Beta: 9 months or 3 releases (whichever is longer)**
* **Alpha: 0 releases**

This covers the [maximum supported version skew of 2 releases](/docs/setup/version-skew-policy/).
This covers the [maximum supported version skew of 2 releases](/docs/setup/release/version-skew-policy/).

{{< note >}}
Until [#52185](https://github.com/kubernetes/kubernetes/issues/52185) is
resolved, no API versions that have been persisted to storage may be removed.
Serving REST endpoints for those versions may be disabled (subject to the
deprecation timelines in this document), but the API server must remain capable
resolved, no API versions that have been persisted to storage may be removed.
Serving REST endpoints for those versions may be disabled (subject to the
deprecation timelines in this document), but the API server must remain capable
of decoding/converting previously persisted data from storage.
{{< /note >}}

@@ -365,54 +365,54 @@ This applies only to significant, user-visible behaviors which impact the
correctness of applications running on Kubernetes or that impact the
administration of Kubernetes clusters, and which are being removed entirely.

An exception to the above rule is _feature gates_. Feature gates are key=value
An exception to the above rule is _feature gates_. Feature gates are key=value
pairs that allow for users to enable/disable experimental features.

Feature gates are intended to cover the development life cycle of a feature - they
are not intended to be long-term APIs. As such, they are expected to be deprecated
and removed after a feature becomes GA or is dropped.
Feature gates are intended to cover the development life cycle of a feature - they
are not intended to be long-term APIs. As such, they are expected to be deprecated
and removed after a feature becomes GA or is dropped.

As a feature moves through the stages, the associated feature gate evolves.
As a feature moves through the stages, the associated feature gate evolves.
The feature life cycle matched to its corresponding feature gate is:

* Alpha: the feature gate is disabled by default and can be enabled by the user.
* Beta: the feature gate is enabled by default and can be disabled by the user.
* GA: the feature gate is deprecated (see ["Deprecation"](#deprecation)) and becomes
* GA: the feature gate is deprecated (see ["Deprecation"](#deprecation)) and becomes
non-operational.
* GA, deprecation window complete: the feature gate is removed and calls to it are
* GA, deprecation window complete: the feature gate is removed and calls to it are
no longer accepted.

### Deprecation

Features can be removed at any point in the life cycle prior to GA. When features are
Features can be removed at any point in the life cycle prior to GA. When features are
removed prior to GA, their associated feature gates are also deprecated.

When an invocation tries to disable a non-operational feature gate, the call fails in order
When an invocation tries to disable a non-operational feature gate, the call fails in order
to avoid unsupported scenarios that might otherwise run silently.

In some cases, removing pre-GA features requires considerable time. Feature gates can remain
operational until their associated feature is fully removed, at which point the feature gate
itself can be deprecated.
In some cases, removing pre-GA features requires considerable time. Feature gates can remain
operational until their associated feature is fully removed, at which point the feature gate
itself can be deprecated.

When removing a feature gate for a GA feature also requires considerable time, calls to
feature gates may remain operational if the feature gate has no effect on the feature,
When removing a feature gate for a GA feature also requires considerable time, calls to
feature gates may remain operational if the feature gate has no effect on the feature,
and if the feature gate causes no errors.

Features intended to be disabled by users should include a mechanism for disabling the
Features intended to be disabled by users should include a mechanism for disabling the
feature in the associated feature gate.

Versioning for feature gates is different from the previously discussed components,
therefore the rules for deprecation are as follows:

**Rule #8: Feature gates must be deprecated when the corresponding feature they control
**Rule #8: Feature gates must be deprecated when the corresponding feature they control
transitions a lifecycle stage as follows. Feature gates must function for no less than:**

* **Beta feature to GA: 6 months or 2 releases (whichever is longer)**
* **Beta feature to EOL: 3 months or 1 release (whichever is longer)**
* **Alpha feature to EOL: 0 releases**

**Rule #9: Deprecated feature gates must respond with a warning when used. When a feature gate
is deprecated it must be documented in both in the release notes and the corresponding CLI help.
**Rule #9: Deprecated feature gates must respond with a warning when used. When a feature gate
is deprecated it must be documented in both in the release notes and the corresponding CLI help.
Both warnings and documentation must indicate whether a feature gate is non-operational.**

## Exceptions
@@ -4,9 +4,9 @@ reviewers:
- erictune
- mikedanese
no_issue: true
title: Setup
title: Getting started
main_menu: true
weight: 30
weight: 20
content_template: templates/concept
card:
name: setup
@@ -40,7 +40,7 @@ If you're learning Kubernetes, use the Docker-based solutions: tools supported b

|Community |Ecosystem |
| ------------ | -------- |
| [Minikube](/docs/setup/minikube/) | [CDK on LXD](https://www.ubuntu.com/kubernetes/docs/install-local) |
| [Minikube](/docs/setup/learning-environment/minikube/) | [CDK on LXD](https://www.ubuntu.com/kubernetes/docs/install-local) |
| [Kubeadm-dind](https://github.com/kubernetes-sigs/kubeadm-dind-cluster) | [Docker Desktop](https://www.docker.com/products/docker-desktop)|
| [Kubernetes IN Docker](https://github.com/kubernetes-sigs/kind) | [Minishift](https://docs.okd.io/latest/minishift/)|
| | [MicroK8s](https://microk8s.io/)|
@@ -0,0 +1,4 @@
---
title: Best practices
weight: 40
---
@@ -1,8 +1,9 @@
---
title: PKI Certificates and Requirements
title: PKI certificates and requirements
reviewers:
- sig-cluster-lifecycle
- sig-cluster-lifecycle
content_template: templates/concept
weight: 40
---

{{% capture overview %}}
@@ -45,7 +46,7 @@ If you don't want kubeadm to generate the required certificates, you can create

### Single root CA

You can create a single root CA, controlled by an administrator. This root CA can then create multiple intermediate CAs, and delegate all further creation to Kubernetes itself.
You can create a single root CA, controlled by an administrator. This root CA can then create multiple intermediate CAs, and delegate all further creation to Kubernetes itself.

Required CAs:

@@ -57,7 +58,7 @@ Required CAs:

### All certificates

If you don't wish to copy these private keys to your API servers, you can generate all certificates yourself.
If you don't wish to copy these private keys to your API servers, you can generate all certificates yourself.

Required certificates:

@@ -104,7 +105,7 @@ Certificates should be placed in a recommended path (as used by [kubeadm][kubead

## Configure certificates for user accounts

You must manually configure these administrator account and service accounts:
You must manually configure these administrator account and service accounts:

| filename | credential name | Default CN | O (in Subject) |
|-------------------------|----------------------------|--------------------------------|----------------|
@@ -2,8 +2,8 @@
reviewers:
- davidopp
- lavalamp
title: Building Large Clusters
weight: 80
title: Building large clusters
weight: 20
---

## Support
@@ -3,8 +3,8 @@ reviewers:
- jlowdermilk
- justinsb
- quinton-hoole
title: Running in Multiple Zones
weight: 90
title: Running in multiple zones
weight: 10
content_template: templates/concept
---

@@ -1,7 +1,8 @@
---
reviewers:
- Random-Liu
title: Validate Node Setup
title: Validate node setup
weight: 30
---

{{< toc >}}

This file was deleted.

This file was deleted.

@@ -0,0 +1,4 @@
---
title: Learning environment
weight: 20
---
@@ -3,7 +3,7 @@ reviewers:
- dlorenc
- balopat
- aaron-prindle
title: Running Kubernetes Locally via Minikube
title: Installing Kubernetes with Minikube
content_template: templates/concept
---

@@ -50,7 +50,7 @@ This brief demo guides you on how to start, use, and delete Minikube locally. Fo
For more information on starting your cluster on a specific Kubernetes version, VM, or container runtime, see [Starting a Cluster](#starting-a-cluster).

2. Now, you can interact with your cluster using kubectl. For more information, see [Interacting with Your Cluster](#interacting-with-your-cluster).

Let’s create a Kubernetes Deployment using an existing image named `echoserver`, which is a simple HTTP server and expose it on port 8080 using `--port`.
```shell
kubectl run hello-minikube --image=k8s.gcr.io/echoserver:1.10 --port=8080
@@ -64,7 +64,7 @@ This brief demo guides you on how to start, use, and delete Minikube locally. Fo
kubectl expose deployment hello-minikube --type=NodePort
```
The option `--type=NodePort` specifies the type of the Service.

The output is similar to this:
```
service/hello-minikube exposed
@@ -90,7 +90,7 @@ This brief demo guides you on how to start, use, and delete Minikube locally. Fo
minikube service hello-minikube --url
```
6. To view the details of your local cluster, copy and paste the URL you got as the output, on your browser.

The output is similar to this:
```
Hostname: hello-minikube-7c77b68cff-8wdzq
@@ -155,7 +155,7 @@ This brief demo guides you on how to start, use, and delete Minikube locally. Fo
The "minikube" cluster has been deleted.
```
For more information, see [Deleting a cluster](#deleting-a-cluster).

## Managing your Cluster

### Starting a Cluster
@@ -0,0 +1,4 @@
---
title: Production environment
weight: 30
---
@@ -2,9 +2,9 @@
reviewers:
- vincepri
- bart0sh
title: CRI installation
title: Container runtimes
content_template: templates/concept
weight: 100
weight: 10
---
{{% capture overview %}}
{{< feature-state for_k8s_version="v1.6" state="stable" >}}
@@ -283,8 +283,7 @@ systemctl restart containerd

To use the `systemd` cgroup driver, set `plugins.cri.systemd_cgroup = true` in `/etc/containerd/config.toml`.
When using kubeadm, manually configure the
[cgroup driver for kubelet](/docs/setup/independent/install-kubeadm/#configure-cgroup-driver-used-by-kubelet-on-master-node)
as well.
[cgroup driver for kubelet](/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#configure-cgroup-driver-used-by-kubelet-on-master-node)

## Other CRI runtimes: frakti

@@ -1,4 +1,4 @@
---
title: On-Premises VMs
weight: 60
weight: 40
---
@@ -115,7 +115,7 @@ e9af8293... <node #2 IP> role=node

IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level
-------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ----------------------------
CloudStack | Ansible | CoreOS | flannel | [docs](/docs/setup/on-premises-vm/cloudstack/) | | Community ([@Guiques](https://github.com/ltupin/))
CloudStack | Ansible | CoreOS | flannel | [docs](/docs/setup/production-environment/on-premises-vm/cloudstack/) | | Community ([@Guiques](https://github.com/ltupin/))


{{% /capture %}}
@@ -66,7 +66,7 @@ This short screencast demonstrates how the oVirt Cloud Provider can be used to d

IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level
-------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ----------------------------
oVirt | | | | [docs](/docs/setup/on-premises-vm/ovirt/) | | Community ([@simon3z](https://github.com/simon3z))
oVirt | | | | [docs](/docs/setup/production-environment/on-premises-vm/ovirt/) | | Community ([@simon3z](https://github.com/simon3z))


{{% /capture %}}
@@ -0,0 +1,4 @@
---
title: Installing Kubernetes with deployment tools
weight: 30
---
@@ -1,6 +1,7 @@
---
title: Installing Kubernetes on AWS with kops
title: Installing Kubernetes with kops
content_template: templates/concept
weight: 20
---

{{% capture overview %}}

0 comments on commit 55ac801

Please sign in to comment.
You can’t perform that action at this time.