Documentation for Indexed completion mode #26958

I wonder if there's a way to use a ready-made and reasonably trusted) public container image for the work task, something that can take an index in argv. If so, a bunch of my concerns disappear.

content/en/docs/tasks/job/indexed-parallel-processing-static.md

content/en/examples/application/job/indexed-job-args.yaml

content/en/examples/application/job/indexed-job-env.yaml

content/en/examples/application/job/indexed-job.yaml

alculquicondor

I wonder if there's a way to use a ready-made and reasonably trusted) public container image for the work task, something that can take an index in argv. If so, a bunch of my concerns disappear.

I also don't quite like providing a program and dockerfile. I just followed the way of the existing job patterns tasks. I could just use busybox echo. WDYT?

content/en/docs/tasks/job/indexed-parallel-processing-static.md

reylejano · 2021-03-11T06:07:38Z

/assign @PI-Victor

reylejano · 2021-03-11T06:18:37Z

@kubernetes/sig-apps-pr-reviews Can you provide a tech review?

sftim · 2021-03-11T12:32:59Z

I could just use busybox echo.

How about:

init container 1: write task input to path in volume based on index
init container 2: sleep
app container: do work (rev from Busybox, perhaps)

Another approach is also OK. Could run a script in a Linux OS-type container for example, providing the code via the command line.

sftim · 2021-03-16T19:24:52Z

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

@@ -185,6 +184,33 @@ parallelism, for a variety of reasons:
 - The Job controller may throttle new Pod creation due to excessive previous pod failures in the same Job.
 - When a Pod is gracefully shut down, it takes time to stop.

+#### Completion Mode


BTW, this would work better as a level 3 heading so that it's part of in-page navigation.

Suggested change

#### Completion Mode

### Completion mode

sftim · 2021-03-16T19:26:15Z

content/en/docs/tasks/job/indexed-parallel-processing-static.md

+
+<!-- steps -->
+
+## Create a container image


Suggested change

## Create a container image

## Choose an approach

sftim · 2021-03-16T19:27:40Z

content/en/docs/tasks/job/indexed-parallel-processing-static.md

+This program is available in the [busybox container image](https://hub.docker.com/_/busybox):
+
+{{< tabs name="busybox container image" >}}
+{{{< tab name="Docker Hub" >}}
+docker.io/library/busybox
+{{< /tab >}}
+{{< tab name="Google Container Registry" >}}
+mirror.gcr.io/library/busybox
+{{< /tab >}}}
+{{< /tabs >}}


As we're not pushing images, my earlier feedback doesn't apply and this can simplify to:

Suggested change

This program is available in the [busybox container image](https://hub.docker.com/_/busybox):

{{< tabs name="busybox container image" >}}

{{{< tab name="Docker Hub" >}}

docker.io/library/busybox

{{< /tab >}}

{{< tab name="Google Container Registry" >}}

mirror.gcr.io/library/busybox

{{< /tab >}}}

{{< /tabs >}}

For this example, you'll use the `rev` tool from the [`busybox`](https://hub.docker.com/_/busybox) container image.

sftim

/lgtm

Thanks, this is a good docs improvement @alculquicondor !

k8s-ci-robot · 2021-03-16T20:49:27Z

LGTM label has been added.

Git tree hash: c61bd02b8ed9b91d7c8341203947011f96bab663

content/en/examples/application/job/indexed-job-vol.yaml

reylejano · 2021-03-16T20:52:39Z

/approve

reylejano · 2021-03-16T20:53:39Z

/approve cancel
Tim's question came in a minute before my initial approve

BTW is batch.alpha.kubernetes.io still correct?

Signed-off-by: Aldo Culquicondor <acondor@google.com>

alculquicondor · 2021-03-16T20:55:35Z

/hold cancel

reylejano · 2021-03-16T20:58:45Z

/approve

k8s-ci-robot · 2021-03-16T20:58:55Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano, soltysh

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:

~~content/en/OWNERS~~ [reylejano]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sftim · 2021-03-17T13:22:37Z

/lgtm

k8s-ci-robot · 2021-03-17T13:23:41Z

LGTM label has been added.

Git tree hash: 8b70b23feb526919ee8b5a009b01e38bf66a0d82

k8s-ci-robot added this to the 1.21 milestone Mar 8, 2021

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. sig/apps Categorizes an issue or PR as relevant to SIG Apps. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 8, 2021

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. language/en Issues or PRs related to English language labels Mar 8, 2021

k8s-ci-robot requested review from soltysh and tengqm March 8, 2021 20:33

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 8, 2021

k8s-ci-robot assigned reylejano Mar 8, 2021

sftim reviewed Mar 8, 2021

View reviewed changes

content/en/docs/concepts/workloads/controllers/job.md Outdated Show resolved Hide resolved

alculquicondor force-pushed the indexed-job branch from 321db67 to ce052a4 Compare March 10, 2021 19:12

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 10, 2021

alculquicondor changed the title ~~WIP Documentation for Indexed completion mode~~ Documentation for Indexed completion mode Mar 10, 2021

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 10, 2021

k8s-ci-robot assigned erictune Mar 10, 2021

sftim reviewed Mar 10, 2021

View reviewed changes

alculquicondor force-pushed the indexed-job branch from ce052a4 to 49d165d Compare March 10, 2021 22:39

alculquicondor commented Mar 10, 2021

View reviewed changes

reylejano removed their assignment Mar 11, 2021

k8s-ci-robot assigned PI-Victor Mar 11, 2021

alculquicondor force-pushed the indexed-job branch from 89c8696 to 0af3ede Compare March 16, 2021 18:48

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2021

alculquicondor force-pushed the indexed-job branch from 0af3ede to 6624e0f Compare March 16, 2021 18:49

sftim reviewed Mar 16, 2021

View reviewed changes

alculquicondor force-pushed the indexed-job branch from 6624e0f to 7923b74 Compare March 16, 2021 20:35

sftim reviewed Mar 16, 2021

View reviewed changes

k8s-ci-robot assigned sftim Mar 16, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2021

sftim reviewed Mar 16, 2021

View reviewed changes

content/en/examples/application/job/indexed-job-vol.yaml Outdated Show resolved Hide resolved

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 16, 2021

k8s-ci-robot removed the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 16, 2021

Documentation for Indexed completion mode

552566f

Signed-off-by: Aldo Culquicondor <acondor@google.com>

alculquicondor force-pushed the indexed-job branch from 7923b74 to 552566f Compare March 16, 2021 20:54

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 16, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 16, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 17, 2021

k8s-ci-robot merged commit bfb10f4 into kubernetes:dev-1.21 Mar 17, 2021

sftim mentioned this pull request Mar 17, 2021

Tweak task for Indexed completion Job example #27103

Merged

This was referenced Mar 17, 2021

Add well-known annotation for job-completion-index #27106

Merged

Blog: Introducing Indexed Jobs #27169

Merged

alculquicondor mentioned this pull request Apr 13, 2021

Indexed Job semantics in Job API kubernetes/enhancements#2214

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation for Indexed completion mode #26958

Documentation for Indexed completion mode #26958

alculquicondor commented Mar 8, 2021 •

edited

k8sio-netlify-preview-bot commented Mar 8, 2021 •

edited

annajung commented Mar 8, 2021

reylejano commented Mar 8, 2021

alculquicondor commented Mar 10, 2021

alculquicondor commented Mar 10, 2021

sftim left a comment

alculquicondor left a comment

reylejano commented Mar 11, 2021

reylejano commented Mar 11, 2021

sftim commented Mar 11, 2021

sftim Mar 16, 2021

alculquicondor Mar 16, 2021

sftim Mar 16, 2021

alculquicondor Mar 16, 2021

sftim Mar 16, 2021

alculquicondor Mar 16, 2021

sftim left a comment

k8s-ci-robot commented Mar 16, 2021

reylejano commented Mar 16, 2021

reylejano commented Mar 16, 2021 •

edited

alculquicondor commented Mar 16, 2021

reylejano commented Mar 16, 2021

k8s-ci-robot commented Mar 16, 2021

sftim commented Mar 17, 2021

k8s-ci-robot commented Mar 17, 2021

Documentation for Indexed completion mode #26958

Documentation for Indexed completion mode #26958

Conversation

alculquicondor commented Mar 8, 2021 • edited

k8sio-netlify-preview-bot commented Mar 8, 2021 • edited

annajung commented Mar 8, 2021

reylejano commented Mar 8, 2021

alculquicondor commented Mar 10, 2021

alculquicondor commented Mar 10, 2021

sftim left a comment

Choose a reason for hiding this comment

alculquicondor left a comment

Choose a reason for hiding this comment

reylejano commented Mar 11, 2021

reylejano commented Mar 11, 2021

sftim commented Mar 11, 2021

sftim Mar 16, 2021

Choose a reason for hiding this comment

alculquicondor Mar 16, 2021

Choose a reason for hiding this comment

sftim Mar 16, 2021

Choose a reason for hiding this comment

alculquicondor Mar 16, 2021

Choose a reason for hiding this comment

sftim Mar 16, 2021

Choose a reason for hiding this comment

alculquicondor Mar 16, 2021

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Mar 16, 2021

reylejano commented Mar 16, 2021

reylejano commented Mar 16, 2021 • edited

alculquicondor commented Mar 16, 2021

reylejano commented Mar 16, 2021

k8s-ci-robot commented Mar 16, 2021

sftim commented Mar 17, 2021

k8s-ci-robot commented Mar 17, 2021

alculquicondor commented Mar 8, 2021 •

edited

k8sio-netlify-preview-bot commented Mar 8, 2021 •

edited

reylejano commented Mar 16, 2021 •

edited