Skip to content

Commit 55ac801

Browse files
Rajakavitha1k8s-ci-robot
authored andcommitted
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
1 parent f60947b commit 55ac801

Some content is hidden

Large Commits have some content hidden by default. Use the searcx below for content that may be hidden.

65 files changed

+250
-244
lines changed

‎content/en/docs/concepts/cluster-administration/federation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ users in the event of a cluster failure), then you need to have `R * (U + 1)` cl
170170

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

175175
{{% /capture %}}
176176

‎content/en/docs/concepts/containers/runtime-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ to the behavior when the RuntimeClass feature is disabled.
115115

116116
### CRI Configuration
117117

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

120120
#### dockershim
121121

‎content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ For information about enabling IPVS mode with kubeadm see:
136136
### Passing custom flags to control plane components {#control-plane-flags}
137137

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

141141
### Using custom images {#custom-images}
142142

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

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

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

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

‎content/en/docs/reference/tools.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Kubernetes contains several built-in tools to help you work with the Kubernetes
1414

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

17-
## Kubeadm
17+
## Kubeadm
1818

19-
[`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).
19+
[`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).
2020

2121
## Kubefed
2222

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

32-
## Dasard
32+
## Dasard
3333

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

3737
## Helm
3838

‎content/en/docs/reference/using-api/deprecation-policy.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ no less than:**
8787
* **Beta: 9 months or 3 releases (whichever is longer)**
8888
* **Alpha: 0 releases**
8989

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

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

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

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

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

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

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

385385
### Deprecation
386386

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

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

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

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

401-
Features intended to be disabled by users should include a mechanism for disabling the
401+
Features intended to be disabled by users should include a mechanism for disabling the
402402
feature in the associated feature gate.
403403

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

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

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

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

418418
## Exceptions

‎content/en/docs/setup/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ reviewers:
44
- erictune
55
- mikedanese
66
no_issue: true
7-
title: Setup
7+
title: Getting started
88
main_menu: true
9-
weight: 30
9+
weight: 20
1010
content_template: templates/concept
1111
card:
1212
name: setup
@@ -40,7 +40,7 @@ If you're learning Kubernetes, use the Docker-based solutions: tools supported b
4040

4141
|Community |Ecosystem |
4242
| ------------ | -------- |
43-
| [Minikube](/docs/setup/minikube/) | [CDK on LXD](https://www.ubuntu.com/kubernetes/docs/install-local) |
43+
| [Minikube](/docs/setup/learning-environment/minikube/) | [CDK on LXD](https://www.ubuntu.com/kubernetes/docs/install-local) |
4444
| [Kubeadm-dind](https://.com/kubernetes-sigs/kubeadm-dind-cluster) | [Docker Desktop](https://www.docker.com/products/docker-desktop)|
4545
| [Kubernetes IN Docker](https://.com/kubernetes-sigs/kind) | [Minishift](https://docs.okd.io/latest/minishift/)|
4646
| | [MicroK8s](https://microk8s.io/)|
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Best practices
3+
weight: 40
4+
---

‎content/en/docs/setup/certificates.md renamed to ‎content/en/docs/setup/best-practices/certificates.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: PKI Certificates and Requirements
2+
title: PKI certificates and requirements
33
reviewers:
4-
- sig-cluster-lifecycle
4+
- sig-cluster-lifecycle
55
content_template: templates/concept
6+
weight: 40
67
---
78

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

4647
### Single root CA
4748

48-
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.
49+
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.
4950

5051
Required CAs:
5152

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

5859
### All certificates
5960

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

6263
Required certificates:
6364

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

105106
## Configure certificates for user accounts
106107

107-
You must manually configure these administrator account and service accounts:
108+
You must manually configure these administrator account and service accounts:
108109

109110
| filename | credential name | Default CN | O (in Subject) |
110111
|-------------------------|----------------------------|--------------------------------|----------------|

‎content/en/docs/setup/cluster-large.md renamed to ‎content/en/docs/setup/best-practices/cluster-large.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
reviewers:
33
- davidopp
44
- lavalamp
5-
title: Building Large Clusters
6-
weight: 80
5+
title: Building large clusters
6+
weight: 20
77
---
88

99
## Support

‎content/en/docs/setup/multiple-zones.md renamed to ‎content/en/docs/setup/best-practices/multiple-zones.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ reviewers:
33
- jlowdermilk
44
- justinsb
55
- quinton-hoole
6-
title: Running in Multiple Zones
7-
weight: 90
6+
title: Running in multiple zones
7+
weight: 10
88
content_template: templates/concept
99
---
1010

‎content/en/docs/setup/node-conformance.md renamed to ‎content/en/docs/setup/best-practices/node-conformance.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
reviewers:
33
- Random-Liu
4-
title: Validate Node Setup
4+
title: Validate node setup
5+
weight: 30
56
---
67

78
{{< toc >}}

‎content/en/docs/setup/custom-cloud/_index.md

-4
This file was deleted.

‎content/en/docs/setup/independent/_index.md

-5
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Learning environment
3+
weight: 20
4+
---

‎content/en/docs/setup/minikube.md renamed to ‎content/en/docs/setup/learning-environment/minikube.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ reviewers:
33
- dlorenc
44
- balopat
55
- aaron-prindle
6-
title: Running Kubernetes Locally via Minikube
6+
title: Installing Kubernetes with Minikube
77
content_template: templates/concept
88
---
99

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

5252
2. Now, you can interact with your cluster using kubectl. For more information, see [Interacting with Your Cluster](#interacting-with-your-cluster).
53-
53+
5454
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`.
5555
```shell
5656
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
6464
kubectl expose deployment hello-minikube --type=NodePort
6565
```
6666
The option `--type=NodePort` specifies the type of the Service.
67-
67+
6868
The output is similar to this:
6969
```
7070
service/hello-minikube exposed
@@ -90,7 +90,7 @@ This brief demo guides you on how to start, use, and delete Minikube locally. Fo
9090
minikube service hello-minikube --url
9191
```
9292
6. To view the details of your local cluster, copy and paste the URL you got as the output, on your browser.
93-
93+
9494
The output is similar to this:
9595
```
9696
Hostname: hello-minikube-7c77b68cff-8wdzq
@@ -155,7 +155,7 @@ This brief demo guides you on how to start, use, and delete Minikube locally. Fo
155155
The "minikube" cluster has been deleted.
156156
```
157157
For more information, see [Deleting a cluster](#deleting-a-cluster).
158-
158+
159159
## Managing your Cluster
160160

161161
### Starting a Cluster
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Production environment
3+
weight: 30
4+
---

‎content/en/docs/setup/cri.md renamed to ‎content/en/docs/setup/production-environment/container-runtimes.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
reviewers:
33
- vincepri
44
- bart0sh
5-
title: CRI installation
5+
title: Container runtimes
66
content_template: templates/concept
7-
weight: 100
7+
weight: 10
88
---
99
{{% capture overview %}}
1010
{{< feature-state for_k8s_version="v1.6" state="stable" >}}
@@ -283,8 +283,7 @@ systemctl restart containerd
283283

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

289288
## Other CRI runtimes: frakti
290289

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
title: On-Premises VMs
3-
weight: 60
3+
weight: 40
44
---

‎content/en/docs/setup/on-premises-vm/cloudstack.md renamed to ‎content/en/docs/setup/production-environment/on-premises-vm/cloudstack.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ e9af8293... <node #2 IP> role=node
115115

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

120120

121121
{{% /capture %}}

‎content/en/docs/setup/on-premises-vm/ovirt.md renamed to ‎content/en/docs/setup/production-environment/on-premises-vm/ovirt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ This short screencast demonstrates how the oVirt Cloud Provider can be used to d
6666

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

7171

7272
{{% /capture %}}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Installing Kubernetes with deployment tools
3+
weight: 30
4+
---

‎content/en/docs/setup/custom-cloud/kops.md renamed to ‎content/en/docs/setup/production-environment/tools/kops.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
title: Installing Kubernetes on AWS with kops
2+
title: Installing Kubernetes with kops
33
content_template: templates/concept
4+
weight: 20
45
---
56

67
{{% capture overview %}}

0 commit comments

Comments
 (0)