Skip to content

Commit 49eee8f

Browse files
Tim Bannistercelestehorgan
andauthored
Revise Pod concept (#22603)
* Revise Pod concept Adapt the existing Pod documentation to suit the Docsy theme, by promoting the Pod concept itself to /docs/concepts/workloads/pods/ Following on from this, update the Pod Lifecycle page to cover the lifecycle of a Pod and follow on directly from the Pod concept, for readers keen to understand things in detail. This change also removes the automatic contents list from the Pod overview page. Instead, the new page links to all the pages inside the Pod section. * Update links to Pod concept Link to updated content * Incorporate Pod concept suggestions Co-authored-by: Celeste Horgan <[email protected]> * Revise StatefulSet suggestion for Pod concept Co-authored-by: Celeste Horgan <[email protected]> Co-authored-by: Celeste Horgan <[email protected]>
1 parent c80c9c4 commit 49eee8f

File tree

31 files changed

+684
-716
lines changed

31 files changed

+684
-716
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ understand exactly how it is expected to work. There are 4 distinct networking
1212
problems to address:
1313

1414
1. Highly-coupled container-to-container communications: this is solved by
15-
[pods](/docs/concepts/workloads/pods/pod/) and `localhost` communications.
15+
{{< glossary_tooltip text="Pods" term_id="pod" >}} and `localhost` communications.
1616
2. Pod-to-Pod communications: this is the primary focus of this document.
1717
3. Pod-to-Service communications: this is covered by [services](/docs/concepts/services-networking/service/).
1818
4. External-to-Service communications: this is covered by [services](/docs/concepts/services-networking/service/).

content/en/docs/concepts/configuration/pod-priority-preemption.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ makes Pod P eligible to preempt Pods on another Node.
255255
#### Graceful termination of preemption victims
256256

257257
When Pods are preempted, the victims get their
258-
[graceful termination period](/docs/concepts/workloads/pods/pod/#termination-of-pods).
258+
[graceful termination period](/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination).
259259
They have that much time to finish their work and exit. If they don't, they are
260260
killed. This graceful termination period creates a time gap between the point
261261
that the scheduler preempts Pods and the time when the pending Pod (P) can be
@@ -268,7 +268,7 @@ priority Pods to zero or a small number.
268268

269269
#### PodDisruptionBudget is supported, but not guaranteed
270270

271-
A [Pod Disruption Budget (PDB)](/docs/concepts/workloads/pods/disruptions/)
271+
A [PodDisruptionBudget](/docs/concepts/workloads/pods/disruptions/) (PDB)
272272
allows application owners to limit the number of Pods of a replicated application
273273
that are down simultaneously from voluntary disruptions. Kubernetes supports
274274
PDB when preempting Pods, but respecting PDB is best effort. The scheduler tries

content/en/docs/concepts/containers/container-lifecycle-hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ so it must complete before the call to delete the container can be sent.
4242
No parameters are passed to the handler.
4343

4444
A more detailed description of the termination behavior can be found in
45-
[Termination of Pods](/docs/concepts/workloads/pods/pod/#termination-of-pods).
45+
[Termination of Pods](/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination).
4646

4747
### Hook handler implementations
4848

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ and the `spec` format for a Deployment can be found in
9292
## {{% heading "whatsnext" %}}
9393

9494
* [Kubernetes API overview](/docs/reference/using-api/api-overview/) explains some more API concepts
95-
* Learn about the most important basic Kubernetes objects, such as [Pod](/docs/concepts/workloads/pods/pod-overview/).
95+
* Learn about the most important basic Kubernetes objects, such as [Pod](/docs/concepts/workloads/pods/).
9696
* Learn about [controllers](/docs/concepts/architecture/controller/) in Kubernetes
9797

9898

content/en/docs/concepts/workloads/controllers/daemonset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ A DaemonSet also needs a [`.spec`](https://git.k8s.io/community/contributors/dev
6060

6161
The `.spec.template` is one of the required fields in `.spec`.
6262

63-
The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/pod-overview/#pod-templates). It has exactly the same schema as a [Pod](/docs/concepts/workloads/pods/pod/), except it is nested and does not have an `apiVersion` or `kind`.
63+
The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/#pod-templates). It has exactly the same schema as a {{< glossary_tooltip text="Pod" term_id="pod" >}}, except it is nested and does not have an `apiVersion` or `kind`.
6464

6565
In addition to required fields for a Pod, a Pod template in a DaemonSet has to specify appropriate
6666
labels (see [pod selector](#pod-selector)).

content/en/docs/concepts/workloads/controllers/deployment.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ weight: 30
1313

1414
<!-- overview -->
1515

16-
A _Deployment_ provides declarative updates for [Pods](/docs/concepts/workloads/pods/pod/) and
17-
[ReplicaSets](/docs/concepts/workloads/controllers/replicaset/).
16+
A _Deployment_ provides declarative updates for {{< glossary_tooltip text="Pods" term_id="pod" >}}
17+
{{< glossary_tooltip term_id="replica-set" text="ReplicaSets" >}}.
1818

1919
You describe a _desired state_ in a Deployment, and the Deployment {{< glossary_tooltip term_id="controller" >}} changes the actual state to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments.
2020

@@ -23,8 +23,6 @@ Do not manage ReplicaSets owned by a Deployment. Consider opening an issue in th
2323
{{< /note >}}
2424

2525

26-
27-
2826
<!-- body -->
2927

3028
## Use Case
@@ -1053,8 +1051,7 @@ A Deployment also needs a [`.spec` section](https://git.k8s.io/community/contrib
10531051

10541052
The `.spec.template` and `.spec.selector` are the only required field of the `.spec`.
10551053

1056-
The `.spec.template` is a [Pod template](/docs/concepts/workloads/pods/pod-overview/#pod-templates). It has exactly the same schema as a [Pod](/docs/concepts/workloads/pods/pod/), except it is nested and does not have an
1057-
`apiVersion` or `kind`.
1054+
The `.spec.template` is a [Pod template](/docs/concepts/workloads/pods/#pod-templates). It has exactly the same schema as a {{< glossary_tooltip text="Pod" term_id="pod" >}}, except it is nested and does not have an `apiVersion` or `kind`.
10581055

10591056
In addition to required fields for a Pod, a Pod template in a Deployment must specify appropriate
10601057
labels and an appropriate restart policy. For labels, make sure not to overlap with other controllers. See [selector](#selector)).

content/en/docs/concepts/workloads/controllers/job.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ A Job also needs a [`.spec` section](https://git.k8s.io/community/contributors/d
122122

123123
The `.spec.template` is the only required field of the `.spec`.
124124

125-
The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/pod-overview/#pod-templates). It has exactly the same schema as a [pod](/docs/user-guide/pods), except it is nested and does not have an `apiVersion` or `kind`.
125+
The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/#pod-templates). It has exactly the same schema as a {{< glossary_tooltip text="Pod" term_id="pod" >}}, except it is nested and does not have an `apiVersion` or `kind`.
126126

127127
In addition to required fields for a Pod, a pod template in a Job must specify appropriate
128128
labels (see [pod selector](#pod-selector)) and an appropriate restart policy.

content/en/docs/concepts/workloads/controllers/replicationcontroller.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ A ReplicationController also needs a [`.spec` section](https://git.k8s.io/commun
126126

127127
The `.spec.template` is the only required field of the `.spec`.
128128

129-
The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/pod-overview/#pod-templates). It has exactly the same schema as a [pod](/docs/concepts/workloads/pods/pod/), except it is nested and does not have an `apiVersion` or `kind`.
129+
The `.spec.template` is a [pod template](/docs/concepts/workloads/pods/#pod-templates). It has exactly the same schema as a {{< glossary_tooltip text="Pod" term_id="pod" >}}, except it is nested and does not have an `apiVersion` or `kind`.
130130

131131
In addition to required fields for a Pod, a pod template in a ReplicationController must specify appropriate
132132
labels and an appropriate restart policy. For labels, make sure not to overlap with other controllers. See [pod selector](#pod-selector).

0 commit comments

Comments
 (0)