Skip to content

Commit 116b6bc

Browse files
authored
Merge pull request #34382 from tengqm/fix-links-4
Batch fix links (4)
2 parents 38ccc33 + 2f4a067 commit 116b6bc

File tree

8 files changed

+204
-113
lines changed

8 files changed

+204
-113
lines changed

content/en/docs/concepts/architecture/nodes.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -479,29 +479,24 @@ these pods will be stuck in terminating status on the shutdown node forever.
479479
To mitigate the above situation, a user can manually add the taint `node
480480
kubernetes.io/out-of-service` with either `NoExecute` or `NoSchedule` effect to
481481
a Node marking it out-of-service.
482-
If the `NodeOutOfServiceVolumeDetach` [feature gate](/docs/reference/
483-
command-line-tools-reference/feature-gates/) is enabled on
484-
`kube-controller-manager`, and a Node is marked out-of-service with this taint, the
485-
pods on the node will be forcefully deleted if there are no matching tolerations on
486-
it and volume detach operations for the pods terminating on the node will happen
487-
immediately. This allows the Pods on the out-of-service node to recover quickly on a
488-
different node.
482+
If the `NodeOutOfServiceVolumeDetach`[feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
483+
is enabled on `kube-controller-manager`, and a Node is marked out-of-service with this taint, the
484+
pods on the node will be forcefully deleted if there are no matching tolerations on it and volume
485+
detach operations for the pods terminating on the node will happen immediately. This allows the
486+
Pods on the out-of-service node to recover quickly on a different node.
489487

490488
During a non-graceful shutdown, Pods are terminated in the two phases:
491489

492490
1. Force delete the Pods that do not have matching `out-of-service` tolerations.
493491
2. Immediately perform detach volume operation for such pods.
494492

495-
496493
{{< note >}}
497494
- Before adding the taint `node.kubernetes.io/out-of-service` , it should be verified
498-
that the node is already in shutdown or power off state (not in the middle of
499-
restarting).
495+
that the node is already in shutdown or power off state (not in the middle of
496+
restarting).
500497
- The user is required to manually remove the out-of-service taint after the pods are
501-
moved to a new node and the user has checked that the shutdown node has been
502-
recovered since the user was the one who originally added the taint.
503-
504-
498+
moved to a new node and the user has checked that the shutdown node has been
499+
recovered since the user was the one who originally added the taint.
505500
{{< /note >}}
506501

507502
### Pod Priority based graceful node shutdown {#pod-priority-graceful-node-shutdown}

content/en/docs/concepts/cluster-administration/_index.md

Lines changed: 48 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,37 @@ no_list: true
1111
---
1212

1313
<!-- overview -->
14+
1415
The cluster administration overview is for anyone creating or administering a Kubernetes cluster.
1516
It assumes some familiarity with core Kubernetes [concepts](/docs/concepts/).
1617

17-
1818
<!-- body -->
19+
1920
## Planning a cluster
2021

21-
See the guides in [Setup](/docs/setup/) for examples of how to plan, set up, and configure Kubernetes clusters. The solutions listed in this article are called *distros*.
22+
See the guides in [Setup](/docs/setup/) for examples of how to plan, set up, and configure
23+
Kubernetes clusters. The solutions listed in this article are called *distros*.
2224

23-
{{< note >}}
24-
Not all distros are actively maintained. Choose distros which have been tested with a recent version of Kubernetes.
25-
{{< /note >}}
25+
{{< note >}}
26+
Not all distros are actively maintained. Choose distros which have been tested with a recent
27+
version of Kubernetes.
28+
{{< /note >}}
2629

2730
Before choosing a guide, here are some considerations:
2831

29-
- Do you want to try out Kubernetes on your computer, or do you want to build a high-availability, multi-node cluster? Choose distros best suited for your needs.
30-
- Will you be using **a hosted Kubernetes cluster**, such as [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/), or **hosting your own cluster**?
31-
- Will your cluster be **on-premises**, or **in the cloud (IaaS)**? Kubernetes does not directly support hybrid clusters. Instead, you can set up multiple clusters.
32-
- **If you are configuring Kubernetes on-premises**, consider which [networking model](/docs/concepts/cluster-administration/networking/) fits best.
33-
- Will you be running Kubernetes on **"bare metal" hardware** or on **virtual machines (VMs)**?
34-
- Do you **want to run a cluster**, or do you expect to do **active development of Kubernetes project code**? If the
35-
latter, choose an actively-developed distro. Some distros only use binary releases, but
36-
offer a greater variety of choices.
37-
- Familiarize yourself with the [components](/docs/concepts/overview/components/) needed to run a cluster.
38-
32+
- Do you want to try out Kubernetes on your computer, or do you want to build a high-availability,
33+
multi-node cluster? Choose distros best suited for your needs.
34+
- Will you be using **a hosted Kubernetes cluster**, such as
35+
[Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/), or **hosting your own cluster**?
36+
- Will your cluster be **on-premises**, or **in the cloud (IaaS)**? Kubernetes does not directly
37+
support hybrid clusters. Instead, you can set up multiple clusters.
38+
- **If you are configuring Kubernetes on-premises**, consider which
39+
[networking model](/docs/concepts/cluster-administration/networking/) fits best.
40+
- Will you be running Kubernetes on **"bare metal" hardware** or on **virtual machines (VMs)**?
41+
- Do you **want to run a cluster**, or do you expect to do **active development of Kubernetes project code**?
42+
If the latter, choose an actively-developed distro. Some distros only use binary releases, but
43+
offer a greater variety of choices.
44+
- Familiarize yourself with the [components](/docs/concepts/overview/components/) needed to run a cluster.
3945

4046
## Managing a cluster
4147

@@ -45,29 +51,43 @@ Before choosing a guide, here are some considerations:
4551

4652
## Securing a cluster
4753

48-
* [Generate Certificates](/docs/tasks/administer-cluster/certificates/) describes the steps to generate certificates using different tool chains.
54+
* [Generate Certificates](/docs/tasks/administer-cluster/certificates/) describes the steps to
55+
generate certificates using different tool chains.
4956

50-
* [Kubernetes Container Environment](/docs/concepts/containers/container-environment/) describes the environment for Kubelet managed containers on a Kubernetes node.
57+
* [Kubernetes Container Environment](/docs/concepts/containers/container-environment/) describes
58+
the environment for Kubelet managed containers on a Kubernetes node.
5159

52-
* [Controlling Access to the Kubernetes API](/docs/concepts/security/controlling-access) describes how Kubernetes implements access control for its own API.
60+
* [Controlling Access to the Kubernetes API](/docs/concepts/security/controlling-access) describes
61+
how Kubernetes implements access control for its own API.
5362

54-
* [Authenticating](/docs/reference/access-authn-authz/authentication/) explains authentication in Kubernetes, including the various authentication options.
63+
* [Authenticating](/docs/reference/access-authn-authz/authentication/) explains authentication in
64+
Kubernetes, including the various authentication options.
5565

56-
* [Authorization](/docs/reference/access-authn-authz/authorization/) is separate from authentication, and controls how HTTP calls are handled.
66+
* [Authorization](/docs/reference/access-authn-authz/authorization/) is separate from
67+
authentication, and controls how HTTP calls are handled.
5768

58-
* [Using Admission Controllers](/docs/reference/access-authn-authz/admission-controllers/) explains plug-ins which intercepts requests to the Kubernetes API server after authentication and authorization.
69+
* [Using Admission Controllers](/docs/reference/access-authn-authz/admission-controllers/)
70+
explains plug-ins which intercepts requests to the Kubernetes API server after authentication
71+
and authorization.
5972

60-
* [Using Sysctls in a Kubernetes Cluster](/docs/tasks/administer-cluster/sysctl-cluster/) describes to an administrator how to use the `sysctl` command-line tool to set kernel parameters .
73+
* [Using Sysctls in a Kubernetes Cluster](/docs/tasks/administer-cluster/sysctl-cluster/)
74+
describes to an administrator how to use the `sysctl` command-line tool to set kernel parameters
75+
.
6176

62-
* [Auditing](/docs/tasks/debug/debug-cluster/audit/) describes how to interact with Kubernetes' audit logs.
77+
* [Auditing](/docs/tasks/debug/debug-cluster/audit/) describes how to interact with Kubernetes'
78+
audit logs.
6379

6480
### Securing the kubelet
65-
* [Control Plane-Node communication](/docs/concepts/architecture/control-plane-node-communication/)
66-
* [TLS bootstrapping](/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/)
67-
* [Kubelet authentication/authorization](/docs/reference/acess-authn-authz/kubelet-authn-authz/)
81+
82+
* [Control Plane-Node communication](/docs/concepts/architecture/control-plane-node-communication/)
83+
* [TLS bootstrapping](/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/)
84+
* [Kubelet authentication/authorization](/docs/reference/access-authn-authz/kubelet-authn-authz/)
6885

6986
## Optional Cluster Services
7087

71-
* [DNS Integration](/docs/concepts/services-networking/dns-pod-service/) describes how to resolve a DNS name directly to a Kubernetes service.
88+
* [DNS Integration](/docs/concepts/services-networking/dns-pod-service/) describes how to resolve
89+
a DNS name directly to a Kubernetes service.
90+
91+
* [Logging and Monitoring Cluster Activity](/docs/concepts/cluster-administration/logging/)
92+
explains how logging in Kubernetes works and how to implement it.
7293

73-
* [Logging and Monitoring Cluster Activity](/docs/concepts/cluster-administration/logging/) explains how logging in Kubernetes works and how to implement it.

content/en/docs/concepts/overview/working-with-objects/kubernetes-objects.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,29 @@ card:
88
---
99

1010
<!-- overview -->
11-
This page explains how Kubernetes objects are represented in the Kubernetes API, and how you can express them in `.yaml` format.
12-
11+
This page explains how Kubernetes objects are represented in the Kubernetes API, and how you can
12+
express them in `.yaml` format.
1313

1414
<!-- body -->
1515
## Understanding Kubernetes objects {#kubernetes-objects}
1616

17-
*Kubernetes objects* are persistent entities in the Kubernetes system. Kubernetes uses these entities to represent the state of your cluster. Specifically, they can describe:
17+
*Kubernetes objects* are persistent entities in the Kubernetes system. Kubernetes uses these
18+
entities to represent the state of your cluster. Specifically, they can describe:
1819

1920
* What containerized applications are running (and on which nodes)
2021
* The resources available to those applications
2122
* The policies around how those applications behave, such as restart policies, upgrades, and fault-tolerance
2223

23-
A Kubernetes object is a "record of intent"--once you create the object, the Kubernetes system will constantly work to ensure that object exists. By creating an object, you're effectively telling the Kubernetes system what you want your cluster's workload to look like; this is your cluster's *desired state*.
24+
A Kubernetes object is a "record of intent"--once you create the object, the Kubernetes system
25+
will constantly work to ensure that object exists. By creating an object, you're effectively
26+
telling the Kubernetes system what you want your cluster's workload to look like; this is your
27+
cluster's *desired state*.
2428

25-
To work with Kubernetes objects--whether to create, modify, or delete them--you'll need to use the [Kubernetes API](/docs/concepts/overview/kubernetes-api/). When you use the `kubectl` command-line interface, for example, the CLI makes the necessary Kubernetes API calls for you. You can also use the Kubernetes API directly in your own programs using one of the [Client Libraries](/docs/reference/using-api/client-libraries/).
29+
To work with Kubernetes objects--whether to create, modify, or delete them--you'll need to use the
30+
[Kubernetes API](/docs/concepts/overview/kubernetes-api/). When you use the `kubectl` command-line
31+
interface, for example, the CLI makes the necessary Kubernetes API calls for you. You can also use
32+
the Kubernetes API directly in your own programs using one of the
33+
[Client Libraries](/docs/reference/using-api/client-libraries/).
2634

2735
### Object Spec and Status
2836

@@ -48,11 +56,17 @@ the status to match your spec. If any of those instances should fail
4856
between spec and status by making a correction--in this case, starting
4957
a replacement instance.
5058

51-
For more information on the object spec, status, and metadata, see the [Kubernetes API Conventions](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md).
59+
For more information on the object spec, status, and metadata, see the
60+
[Kubernetes API Conventions](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md).
5261

5362
### Describing a Kubernetes object
5463

55-
When you create an object in Kubernetes, you must provide the object spec that describes its desired state, as well as some basic information about the object (such as a name). When you use the Kubernetes API to create the object (either directly or via `kubectl`), that API request must include that information as JSON in the request body. **Most often, you provide the information to `kubectl` in a .yaml file.** `kubectl` converts the information to JSON when making the API request.
64+
When you create an object in Kubernetes, you must provide the object spec that describes its
65+
desired state, as well as some basic information about the object (such as a name). When you use
66+
the Kubernetes API to create the object (either directly or via `kubectl`), that API request must
67+
include that information as JSON in the request body. **Most often, you provide the information to
68+
`kubectl` in a .yaml file.** `kubectl` converts the information to JSON when making the API
69+
request.
5670

5771
Here's an example `.yaml` file that shows the required fields and object spec for a Kubernetes Deployment:
5872

@@ -81,7 +95,9 @@ In the `.yaml` file for the Kubernetes object you want to create, you'll need to
8195
* `metadata` - Data that helps uniquely identify the object, including a `name` string, `UID`, and optional `namespace`
8296
* `spec` - What state you desire for the object
8397

84-
The precise format of the object `spec` is different for every Kubernetes object, and contains nested fields specific to that object. The [Kubernetes API Reference](/docs/reference/kubernetes-api/) can help you find the spec format for all of the objects you can create using Kubernetes.
98+
The precise format of the object `spec` is different for every Kubernetes object, and contains
99+
nested fields specific to that object. The [Kubernetes API Reference](/docs/reference/kubernetes-api/)
100+
can help you find the spec format for all of the objects you can create using Kubernetes.
85101

86102
For example, see the [`spec` field](/docs/reference/kubernetes-api/workload-resources/pod-v1/#PodSpec)
87103
for the Pod API reference.
@@ -103,5 +119,3 @@ detail the structure of that `.status` field, and its content for each different
103119
* Learn about [controllers](/docs/concepts/architecture/controller/) in Kubernetes.
104120
* [Using the Kubernetes API](/docs/reference/using-api/) explains some more API concepts.
105121

106-
107-

0 commit comments

Comments
 (0)