Update Job docs to include info about enabling pod-to-pod communication within a job using pod hostnames #37771

danielvegamyhre · 2022-11-07T23:41:47Z

The purpose of these changes is to update the Job docs to include information about how to enable pod communication within a Job using pod hostnames. This requires setting up a headless service, and setting the Job template spec to specify the headless service name as a subdomain. Doing so will trigger kube-dns to cache the pod hostnames, and enable pod-to-pod communication via <podHostname>.<headlessServiceName> format.

This is currently undocumented, so these changes outline the steps to set this up, as well as a working example.

…ble pod communication via pod hostnames

linux-foundation-easycla · 2022-11-07T23:41:50Z

The committers listed above are authorized under a signed CLA.

✅ login: danielvegamyhre / name: Daniel Vega-Myhre (7a17b9f, 79be50e)

k8s-ci-robot · 2022-11-07T23:41:55Z

Welcome @danielvegamyhre!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

netlify · 2022-11-07T23:55:45Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`1bd542e`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6386c5d3a9ba6e000837e3ac
😎 Deploy Preview	https://deploy-preview-37771--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Arhell

Please sign CLA

danielvegamyhre · 2022-11-08T00:45:08Z

/check-cla

danielvegamyhre · 2022-11-08T00:49:33Z

Signed CLA

Arhell · 2022-11-08T00:58:40Z

/assign @sftim

ahg-g · 2022-11-16T17:17:18Z

/assign @alculquicondor

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

k8s-ci-robot · 2022-11-22T19:26:16Z

LGTM label has been added.

Git tree hash: 1c607dc3aa8270b66d40d86873c12c0a3902b402

danielvegamyhre · 2022-11-22T20:28:07Z

@alculquicondor I made one final small change to make and this accidentally removed your LGTM, sorry!

alculquicondor · 2022-11-22T20:51:18Z

That's ok, you still need editorial approval for sig-docs. They will add the LGTM back, once they review, based on my comment.

danielvegamyhre · 2022-11-29T22:54:53Z

@sftim this is ready for sig-docs to take a look, see LGTM from job-controller approver above

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

tengqm · 2022-11-30T00:27:46Z

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


 [Queue with Pod Per Work Item]: /docs/tasks/job/coarse-parallel-processing-work-queue/
 [Queue with Variable Pod Count]: /docs/tasks/job/fine-parallel-processing-work-queue/
 [Indexed Job with Static Work Assignment]: /docs/tasks/job/indexed-parallel-processing-static/
 [Job Template Expansion]: /docs/tasks/job/parallel-processing-expansion/
+[Job with Pod-to-Pod Communication]: /docs/tasks/job/job-with-pod-to-pod-communication/


Remove this line

If I remove this line, the references to "Job with Pod-to-Pod Communication" will show up as string literals, rather than as links. Can you clarify why you want to remove it?

Line 267 is already a complete link.

I guess the solution is rather the opposite: remove the complete link from line 267

Em... both are valid markdown syntax. The full link syntax is preferred over the out-of-band link syntax because we have scripts to scan bad links and that script is not good at handling the out-of-band syntax.

content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

Co-authored-by: Qiming Teng <tengqm@outlook.com>

tengqm · 2022-11-30T03:00:08Z

This one is ready to go, given tech/doc review history.
/lgtm
/approve

k8s-ci-robot · 2022-11-30T03:00:14Z

LGTM label has been added.

Git tree hash: 8a840338865c699b0b577ee5013ca8f580b11a65

k8s-ci-robot · 2022-11-30T03:00:18Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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~~ [tengqm]

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

alculquicondor · 2022-11-30T14:08:30Z

There is a format error, PTAL at fix #38195

danielvegamyhre added 2 commits November 7, 2022 15:31

Update Job docs to include info about using a headless service to ena…

7a17b9f

…ble pod communication via pod hostnames

Change section title

79be50e

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. language/en Issues or PRs related to English language labels Nov 7, 2022

k8s-ci-robot requested review from onlydole and soltysh November 7, 2022 23:41

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Nov 7, 2022

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 7, 2022

Arhell reviewed Nov 8, 2022

View reviewed changes

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 8, 2022

danielvegamyhre requested review from Arhell and removed request for onlydole and soltysh November 8, 2022 00:49

danielvegamyhre changed the title ~~Update Job docs to include info about enabling pod communication with a job using pod hostnames~~ Update Job docs to include info about enabling pod-to-pod communication within a job using pod hostnames Nov 8, 2022

fix phrasing

0cfbc3b

k8s-ci-robot assigned sftim Nov 8, 2022

update yaml example

477fd2d

k8s-ci-robot assigned alculquicondor Nov 16, 2022

danielvegamyhre added 2 commits November 16, 2022 09:30

update label selector

6c88a52

more specific phrasing

c6e7857

alculquicondor reviewed Nov 16, 2022

View reviewed changes

address comments and add new example

00abb8b

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 22, 2022

update phrasing

7575e90

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 22, 2022

k8s-ci-robot requested review from alculquicondor and sftim November 22, 2022 19:34

tengqm reviewed Nov 30, 2022

View reviewed changes

danielvegamyhre and others added 9 commits November 29, 2022 18:50

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

52349df

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

fbc586d

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

5a8b396

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

4d5b1b1

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

67950c4

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

ae413dd

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

6c2f31c

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

60a65e7

Co-authored-by: Qiming Teng <tengqm@outlook.com>

Update content/en/docs/tasks/job/job-with-pod-to-pod-communication.md

1bd542e

Co-authored-by: Qiming Teng <tengqm@outlook.com>

k8s-ci-robot assigned tengqm Nov 30, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 30, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 30, 2022

k8s-ci-robot merged commit 43a8d5d into kubernetes:main Nov 30, 2022

danielvegamyhre mentioned this pull request Nov 30, 2022

Fix shell block on Job task page #38180

Merged

alculquicondor mentioned this pull request Nov 30, 2022

Fix format by removing erroneous ticks #38195

Merged

danielvegamyhre mentioned this pull request Feb 2, 2023

REQUEST: New membership for @danielvegamyhre kubernetes/org#4000

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Job docs to include info about enabling pod-to-pod communication within a job using pod hostnames #37771

Update Job docs to include info about enabling pod-to-pod communication within a job using pod hostnames #37771

danielvegamyhre commented Nov 7, 2022

linux-foundation-easycla bot commented Nov 7, 2022 •

edited

Loading

k8s-ci-robot commented Nov 7, 2022

netlify bot commented Nov 7, 2022 •

edited

Loading

Arhell left a comment

danielvegamyhre commented Nov 8, 2022

danielvegamyhre commented Nov 8, 2022

Arhell commented Nov 8, 2022

ahg-g commented Nov 16, 2022

k8s-ci-robot commented Nov 22, 2022

danielvegamyhre commented Nov 22, 2022

alculquicondor commented Nov 22, 2022

danielvegamyhre commented Nov 29, 2022

tengqm Nov 30, 2022

danielvegamyhre Nov 30, 2022

tengqm Nov 30, 2022

alculquicondor Nov 30, 2022

tengqm Dec 1, 2022

tengqm commented Nov 30, 2022

k8s-ci-robot commented Nov 30, 2022

k8s-ci-robot commented Nov 30, 2022

alculquicondor commented Nov 30, 2022

Update Job docs to include info about enabling pod-to-pod communication within a job using pod hostnames #37771

Update Job docs to include info about enabling pod-to-pod communication within a job using pod hostnames #37771

Conversation

danielvegamyhre commented Nov 7, 2022

linux-foundation-easycla bot commented Nov 7, 2022 • edited Loading

k8s-ci-robot commented Nov 7, 2022

netlify bot commented Nov 7, 2022 • edited Loading

✅ Pull request preview available for checking

Arhell left a comment

Choose a reason for hiding this comment

danielvegamyhre commented Nov 8, 2022

danielvegamyhre commented Nov 8, 2022

Arhell commented Nov 8, 2022

ahg-g commented Nov 16, 2022

k8s-ci-robot commented Nov 22, 2022

danielvegamyhre commented Nov 22, 2022

alculquicondor commented Nov 22, 2022

danielvegamyhre commented Nov 29, 2022

tengqm Nov 30, 2022

Choose a reason for hiding this comment

danielvegamyhre Nov 30, 2022

Choose a reason for hiding this comment

tengqm Nov 30, 2022

Choose a reason for hiding this comment

alculquicondor Nov 30, 2022

Choose a reason for hiding this comment

tengqm Dec 1, 2022

Choose a reason for hiding this comment

tengqm commented Nov 30, 2022

k8s-ci-robot commented Nov 30, 2022

k8s-ci-robot commented Nov 30, 2022

alculquicondor commented Nov 30, 2022

linux-foundation-easycla bot commented Nov 7, 2022 •

edited

Loading

netlify bot commented Nov 7, 2022 •

edited

Loading