Tweak task for Indexed completion Job example #27103
Conversation
Tidying for changes in commit 552566f
|
Deploy preview for kubernetes-io-vnext-staging processing. Building with commit 09cf80c https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/605246ce40b45e000869e98b |
k8s-ci-robot
added
kind/cleanup
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 20b75d9254f3b83b0a382780c5c8e96fedb01bd4
|
| 1. **Define a Job manifest using indexed completion**. | ||
| The downward API allows you to pass the pod index annotation as an | ||
| environment variable or file to the container. | ||
| 2. **Start an `Indexed` Job based on that manifest**. |
There was a problem hiding this comment.
👋 @sftim ,
Is there a reason to use bold and code formatting in the instructions?
An indexed Job is a Job?
There was a problem hiding this comment.
The formatting here is as per the original.
There was a problem hiding this comment.
An Indexed Job is a Job with .spec.completionMode=Indexed. Bold could be omitted. I just think it makes it easier to get the gist of the steps.
| @@ -66,13 +66,21 @@ program accepts a file as an argument and prints its content reversed. | |||
| rev data.txt | |||
| ``` | |||
|
|
|||
| For this example, you'll use the `rev` tool from the | |||
| You'll use the `rev` tool from the | |||
There was a problem hiding this comment.
Line 69 seems confusing. Could you combine that sentence with lines 61-63?
There was a problem hiding this comment.
We could omit this paragraph - @alculquicondor is that OK?
| [`busybox`](https://hub.docker.com/_/busybox) container image. | ||
|
|
||
| As this is only an example, each Pod only does a tiny piece of work (reversing a short | ||
| string). In a real workload you might, for example, create a Job that represents | ||
| the |
There was a problem hiding this comment.
nit: remove the empty spaces in line 74
| string). In a real workload you might, for example, create a Job that represents | ||
| the | ||
| task of producing 60 seconds of video based on scene data. | ||
| Each work item in the video rendering Job would be to render a particular |
There was a problem hiding this comment.
nit: reword
Each work item in the video rendering Job renders a particular frame ...
| ## Define an Indexed Job | ||
|
|
||
| Here is a job definition. You'll need to edit the container image to match your | ||
| preferred registry. | ||
| Here is a sample Job manifest that uses `Indexed` completion mode: |
There was a problem hiding this comment.
nit: What is "Indexed" completion mode? Should this be capitalized and use code formatting?
There was a problem hiding this comment.
The page prerequisites direct the reader to read up about Job first, which (in the v1.21 docs) explains that mode. We could link directly to that part of the page to emphasize this?
There was a problem hiding this comment.
I don't think it's necessary. The following paragraph is the example, which shows how the completion mode is set in the spec.
| ``` | ||
|
|
||
| Wait a bit, then check on the job: | ||
| When you create this Job, the control plane creates a series of Pods, one for each index you specified. The value of `.spec.parallelism` determines how many can run at once whereas `.spec.completions` determines how many Pods the Job creates in total. |
There was a problem hiding this comment.
nit: The value of ... determines how many Pods (?) can run [immediately or at the same time]?
|
Since this is for 1.21, |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kbhawkey The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
A few changes to round off the new task added in PR #26958
/kind cleanup
/sig apps
/milestone 1.21
/priority backlog
/cc alculquicondor