Skip to content

Commit 5b373f5

Browse files
Tim Bannisterjihoon-seoRinkiyaKeDad
authored
Update “What's next” section of Workloads concept pages (#29730)
* Update “What's next” section of Workloads concept pages Co-authored-by: Jihoon Seo <[email protected]> * Add missing trailing / characters Co-authored-by: Jihoon Seo <[email protected]> Co-authored-by: Arsh Sharma <[email protected]> Co-authored-by: Jihoon Seo <[email protected]> Co-authored-by: Jihoon Seo <[email protected]> Co-authored-by: Arsh Sharma <[email protected]>
1 parent 23a158b commit 5b373f5

File tree

8 files changed

+89
-18
lines changed

8 files changed

+89
-18
lines changed

content/en/docs/concepts/workloads/controllers/cron-jobs.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,14 @@ and set this flag to `false`. For example:
136136

137137
## {{% heading "whatsnext" %}}
138138

139-
[Cron expression format](https://en.wikipedia.org/wiki/Cron)
140-
documents the format of CronJob `schedule` fields.
141-
142-
For instructions on creating and working with cron jobs, and for an example of CronJob
143-
manifest, see [Running automated tasks with cron jobs](/docs/tasks/job/automated-tasks-with-cron-jobs).
144-
139+
* Learn about [Pods](/docs/concepts/workloads/pods/) and
140+
[Jobs](/docs/concepts/workloads/controllers/job/), two concepts
141+
that CronJobs rely upon.
142+
* Read about the [format](https://pkg.go.dev/github.com/robfig/cron/v3#hdr-CRON_Expression_Format)
143+
of CronJob `.spec.schedule` fields.
144+
* For instructions on creating and working with CronJobs, and for an example
145+
of a CronJob manifest,
146+
see [Running automated tasks with CronJobs](/docs/tasks/job/automated-tasks-with-cron-jobs/).
147+
* `CronJob` is part of the Kubernetes REST API.
148+
Read the {{< api-reference page="workload-resources/cron-job-v1" >}}
149+
object definition to understand the API for Kubernetes cron jobs.

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,3 +235,18 @@ all or certain hosts, if the DaemonSet provides node-level functionality that al
235235
For example, [network plugins](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) often include a component that runs as a DaemonSet. The DaemonSet component makes sure that the node where it's running has working cluster networking.
236236

237237

238+
## {{% heading "whatsnext" %}}
239+
240+
* Learn about [Pods](/docs/concepts/workloads/pods).
241+
* Learn about [static Pods](#static-pods), which are useful for running Kubernetes
242+
{{< glossary_tooltip text="control plane" term_id="control-plane" >}} components.
243+
* Find out how to use DaemonSets
244+
* [Perform a rolling update on a DaemonSet](/docs/tasks/manage-daemon/update-daemon-set/)
245+
* [Perform a rollback on a DaemonSet](/docs/tasks/manage-daemon/rollback-daemon-set/)
246+
(for example, if a roll out didn't work how you expected).
247+
* Understand [how Kubernetes assigns Pods to Nodes](/docs/concepts/scheduling-eviction/assign-pod-node/).
248+
* Learn about [device plugins](/docs/concepts/extend-kubernetes/compute-storage-net/device-plugins/) and
249+
[add ons](/docs/concepts/cluster-administration/addons/), which often run as DaemonSets.
250+
* `DaemonSet` is a top-level resource in the Kubernetes REST API.
251+
Read the {{< api-reference page="workload-resources/daemon-set-v1" >}}
252+
object definition to understand the API for daemon sets.

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1176,4 +1176,12 @@ a paused Deployment and one that is not paused, is that any changes into the Pod
11761176
Deployment will not trigger new rollouts as long as it is paused. A Deployment is not paused by default when
11771177
it is created.
11781178

1179-
1179+
## {{% heading "whatsnext" %}}
1180+
1181+
* Learn about [Pods](/docs/concepts/workloads/pods).
1182+
* [Run a Stateless Application Using a Deployment](/docs/tasks/run-application/run-stateless-application-deployment/).
1183+
* `Deployment` is a top-level resource in the Kubernetes REST API.
1184+
Read the {{< api-reference page="workload-resources/deployment-v1" >}}
1185+
object definition to understand the API for deployments.
1186+
* Read about [PodDisruptionBudget](/docs/concepts/workloads/pods/disruptions/) and how
1187+
you can use it to manage application availability during disruptions.

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ due to a node hardware failure or a node reboot).
2525

2626
You can also use a Job to run multiple Pods in parallel.
2727

28+
If you want to run a Job (either a single task, or several in parallel) on a schedule,
29+
see [CronJob](/docs/concepts/workloads/controllers/cron-jobs/).
30+
2831
<!-- body -->
2932

3033
## Running an example Job
@@ -638,6 +641,19 @@ driver, and then cleans up.
638641
An advantage of this approach is that the overall process gets the completion guarantee of a Job
639642
object, but maintains complete control over what Pods are created and how work is assigned to them.
640643

641-
## Cron Jobs {#cron-jobs}
642-
643-
You can use a [`CronJob`](/docs/concepts/workloads/controllers/cron-jobs/) to create a Job that will run at specified times/dates, similar to the Unix tool `cron`.
644+
## {{% heading "whatsnext" %}}
645+
646+
* Learn about [Pods](/docs/concepts/workloads/pods).
647+
* Read about different ways of running Jobs:
648+
* [Coarse Parallel Processing Using a Work Queue](/docs/tasks/job/coarse-parallel-processing-work-queue/)
649+
* [Fine Parallel Processing Using a Work Queue](/docs/tasks/job/fine-parallel-processing-work-queue/)
650+
* Use an [indexed Job for parallel processing with static work assignment](/docs/tasks/job/indexed-parallel-processing-static/) (beta)
651+
* Create multiple Jobs based on a template: [Parallel Processing using Expansions](/docs/tasks/job/parallel-processing-expansion/)
652+
* Follow the links within [Clean up finished jobs automatically](#clean-up-finished-jobs-automatically)
653+
to learn more about how your cluster can clean up completed and / or failed tasks.
654+
* `Job` is part of the Kubernetes REST API.
655+
Read the {{< api-reference page="workload-resources/job-v1" >}}
656+
object definition to understand the API for jobs.
657+
* Read about [`CronJob`](/docs/concepts/workloads/controllers/cron-jobs/), which you
658+
can use to define a series of Jobs that will run based on a schedule, similar to
659+
the Unix tool `cron`.

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,3 +410,14 @@ selector requirements as described in the [labels user guide](/docs/concepts/ove
410410
As such, ReplicaSets are preferred over ReplicationControllers
411411

412412

413+
## {{% heading "whatsnext" %}}
414+
415+
* Learn about [Pods](/docs/concepts/workloads/pods).
416+
* Learn about [Deployments](/docs/concepts/workloads/controllers/deployment/).
417+
* [Run a Stateless Application Using a Deployment](/docs/tasks/run-application/run-stateless-application-deployment/),
418+
which relies on ReplicaSets to work.
419+
* `ReplicaSet` is a top-level resource in the Kubernetes REST API.
420+
Read the {{< api-reference page="workload-resources/replica-set-v1" >}}
421+
object definition to understand the API for replica sets.
422+
* Read about [PodDisruptionBudget](/docs/concepts/workloads/pods/disruptions/) and how
423+
you can use it to manage application availability during disruptions.

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,11 @@ machine-level function, such as machine monitoring or machine logging. These po
284284
to a machine lifetime: the pod needs to be running on the machine before other pods start, and are
285285
safe to terminate when the machine is otherwise ready to be rebooted/shutdown.
286286

287-
## For more information
288-
289-
Read [Run Stateless Application Deployment](/docs/tasks/run-application/run-stateless-application-deployment/).
287+
## {{% heading "whatsnext" %}}
288+
289+
* Learn about [Pods](/docs/concepts/workloads/pods).
290+
* Learn about [Deployment](/docs/concepts/workloads/controllers/deployment/), the replacement
291+
for ReplicationController.
292+
* `ReplicationController` is part of the Kubernetes REST API.
293+
Read the {{< api-reference page="workload-resources/replication-controller-v1" >}}
294+
object definition to understand the API for replication controllers.

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,18 @@ Please note that this field only works if you enable the `StatefulSetMinReadySec
297297

298298
## {{% heading "whatsnext" %}}
299299

300+
* Learn about [Pods](/docs/concepts/workloads/pods).
301+
* Find out how to use StatefulSets
302+
* Follow an example of [deploying a stateful application](/docs/tutorials/stateful-application/basic-stateful-set/).
303+
* Follow an example of [deploying Cassandra with Stateful Sets](/docs/tutorials/stateful-application/cassandra/).
304+
* Follow an example of [running a replicated stateful application](/docs/tasks/run-application/run-replicated-stateful-application/).
305+
* Learn how to [scale a StatefulSet](/docs/tasks/run-application/scale-stateful-set/).
306+
* Learn what's involved when you [delete a StatefulSet](/docs/tasks/run-application/delete-stateful-set/).
307+
* Learn how to [configure a Pod to use a volume for storage](/docs/tasks/configure-pod-container/configure-volume-storage/).
308+
* Learn how to [configure a Pod to use a PersistentVolume for storage](/docs/tasks/configure-pod-container/configure-persistent-volume-storage/).
309+
* `StatefulSet` is a top-level resource in the Kubernetes REST API.
310+
Read the {{< api-reference page="workload-resources/stateful-set-v1" >}}
311+
object definition to understand the API for stateful sets.
312+
* Read about [PodDisruptionBudget](/docs/concepts/workloads/pods/disruptions/) and how
313+
you can use it to manage application availability during disruptions.
300314

301-
* Follow an example of [deploying a stateful application](/docs/tutorials/stateful-application/basic-stateful-set/).
302-
* Follow an example of [deploying Cassandra with Stateful Sets](/docs/tutorials/stateful-application/cassandra/).
303-
* Follow an example of [running a replicated stateful application](/docs/tasks/run-application/run-replicated-stateful-application/).

content/en/docs/concepts/workloads/pods/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,9 +309,9 @@ in the Pod Lifecycle documentation.
309309
* Read about [Pod topology spread constraints](/docs/concepts/workloads/pods/pod-topology-spread-constraints/).
310310
* Read about [PodDisruptionBudget](/docs/concepts/workloads/pods/disruptions/) and how you can use it to manage application availability during disruptions.
311311
* Pod is a top-level resource in the Kubernetes REST API.
312-
The [Pod](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#pod-v1-core)
312+
The {{< api-reference page="workload-resources/pod-v1" >}}
313313
object definition describes the object in detail.
314-
* [The Distributed System Toolkit: Patterns for Composite Containers](https://kubernetes.io/blog/2015/06/the-distributed-system-toolkit-patterns) explains common layouts for Pods with more than one container.
314+
* [The Distributed System Toolkit: Patterns for Composite Containers](/blog/2015/06/the-distributed-system-toolkit-patterns/) explains common layouts for Pods with more than one container.
315315

316316
To understand the context for why Kubernetes wraps a common Pod API in other resources (such as {{< glossary_tooltip text="StatefulSets" term_id="statefulset" >}} or {{< glossary_tooltip text="Deployments" term_id="deployment" >}}), you can read about the prior art, including:
317317

0 commit comments

Comments
 (0)