Add leader address environment variable injection #144

jjk-g · 2024-05-14T19:49:59Z

This adds LWS_LEADER_ADDRESS environment variable injection constructed via related LWS pod labels. This avoids making the user specify in yaml via downward api.

What type of PR is this?

/kind feature

What this PR does / why we need it

Which issue(s) this PR fixes

Fixes #143

Special notes for your reviewer

Does this PR introduce a user-facing change?

Add LWS_LEADER_ADDRESS environment variable to all containers in a leaderworkerset.

linux-foundation-easycla · 2024-05-14T19:50:03Z

The committers listed above are authorized under a signed CLA.

✅ login: jasonkramberger (caafb85)

k8s-ci-robot · 2024-05-14T19:50:08Z

Welcome @jasonkramberger!

It looks like this is your first PR to kubernetes-sigs/lws 🎉. 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-sigs/lws 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. 😃

k8s-ci-robot · 2024-05-14T19:50:09Z

Hi @jasonkramberger. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

ahg-g · 2024-05-14T21:14:29Z

/ok-to-test

kerthcet

Glad to have this. Thanks @jasonkramberger

pkg/utils/pod/pod_utils.go

pkg/utils/pod/pod_utils_test.go

kerthcet · 2024-05-15T02:53:05Z

pkg/utils/pod/pod_utils_test.go

+ },
+ },
+ ObjectMeta: v1.ObjectMeta{
+ Name: fmt.Sprintf("%s-%s-%s", setName, groupIndex, workerIndex),


I think the name is not right if this is a leader pod.

So if this is a wrapper, let's make it more general like pass in the name and namespace to build a Pod spec.

kerthcet · 2024-05-15T02:55:16Z

pkg/webhooks/pod_webhook.go

@@ -139,6 +139,11 @@ func (p *PodWebhook) Default(ctx context.Context, obj runtime.Object) error {
 return err
 }
 }
+
+ if err := podutils.AddLWSVariables(pod); err != nil {


Only needed for workerPod I think, which also worths to test.

itt it may simplify some use cases (init scripts) to have this be available to the leader containers as well. I don't know if that is the most compelling use case, but imo it seems more convenient to have this standardized across all containers in the lws.

actually the opposite, we need to set this in the webook for the leader, but for the workers we can set it on the worker sts. But it is fine to set it here for all.

Why not localhost then? But I'm ok to keep it, it's not a big problem at this moment.

localhost is not relevant here :)

kerthcet · 2024-05-15T03:04:07Z

test/testutils/wrappers.go

@@ -146,6 +146,23 @@ func MakeWorkerPodSpec() corev1.PodSpec {
 }
 }

+func MakeWorkerPodSpecWithInitContainer() corev1.PodSpec {


Maybe make it a PodWrapper to avoid duplicate codes.

Can you link me an example? I think this may be something I tackle in the follow up PR mentioned above.

Yes, agree.

A sample of this is LeaderWorkerSetWrapper under /test/testutils/wrappers.go or https://github.com/kubernetes/kubernetes/blob/fd2d352d291bc4fb36d51e52b33a6f6849f20f35/pkg/scheduler/testing/wrappers.go#L216

Thanks, going to follow up with test code refactoring PR.

pkg/utils/pod/pod_utils.go

ahg-g · 2024-05-15T16:52:54Z

pkg/webhooks/pod_webhook.go

@@ -139,6 +139,11 @@ func (p *PodWebhook) Default(ctx context.Context, obj runtime.Object) error {
 return err
 }
 }
+
+ if err := podutils.AddLWSVariables(pod); err != nil {


actually the opposite, we need to set this in the webook for the leader, but for the workers we can set it on the worker sts. But it is fine to set it here for all.

test/testutils/util.go

kerthcet

General LGTM. One last comment. You can squash as well.

api/leaderworkerset/v1/leaderworkerset_types.go

Adds LWS_LEADER_ADDRESS environment variable injection constructed via related LWS pod labels. This avoids making the user specify in yaml via downward api.

liurupeng · 2024-05-20T22:38:13Z

/lgtm
/approve
/label tide/merge-method-squash

k8s-ci-robot · 2024-05-20T22:38:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jasonkramberger, liurupeng

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:

~~OWNERS~~ [liurupeng]

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

Adds LWS_LEADER_ADDRESS environment variable injection constructed via related LWS pod labels. This avoids making the user specify in yaml via downward api.

k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label May 14, 2024

k8s-ci-robot requested review from ahg-g and kerthcet May 14, 2024 19:50

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label May 14, 2024

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 14, 2024

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. 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 May 14, 2024

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 14, 2024

kerthcet reviewed May 15, 2024

View reviewed changes

ahg-g reviewed May 15, 2024

View reviewed changes

liurupeng reviewed May 15, 2024

View reviewed changes

test/testutils/util.go Outdated Show resolved Hide resolved

kerthcet reviewed May 17, 2024

View reviewed changes

api/leaderworkerset/v1/leaderworkerset_types.go Outdated Show resolved Hide resolved

Add leader address environment variable injection

caafb85

Adds LWS_LEADER_ADDRESS environment variable injection constructed via related LWS pod labels. This avoids making the user specify in yaml via downward api.

jjk-g force-pushed the lws-address-env branch from 6c205e6 to caafb85 Compare May 20, 2024 16:36

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 20, 2024

k8s-ci-robot assigned liurupeng May 20, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 20, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 20, 2024

k8s-ci-robot merged commit 1bc9e96 into kubernetes-sigs:main May 20, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add leader address environment variable injection #144

Add leader address environment variable injection #144

jjk-g commented May 14, 2024

linux-foundation-easycla bot commented May 14, 2024 •

edited

k8s-ci-robot commented May 14, 2024

k8s-ci-robot commented May 14, 2024

ahg-g commented May 14, 2024

kerthcet left a comment

kerthcet May 15, 2024

kerthcet May 15, 2024

kerthcet May 15, 2024

jjk-g May 15, 2024

ahg-g May 15, 2024

kerthcet May 16, 2024 •

edited

ahg-g May 16, 2024

kerthcet May 15, 2024

jjk-g May 15, 2024

kerthcet May 16, 2024

kerthcet May 16, 2024 •

edited

jjk-g May 16, 2024

ahg-g May 15, 2024

kerthcet left a comment •

edited

liurupeng commented May 20, 2024

k8s-ci-robot commented May 20, 2024

Add leader address environment variable injection #144

Add leader address environment variable injection #144

Conversation

jjk-g commented May 14, 2024

What type of PR is this?

What this PR does / why we need it

Which issue(s) this PR fixes

Special notes for your reviewer

Does this PR introduce a user-facing change?

linux-foundation-easycla bot commented May 14, 2024 • edited

k8s-ci-robot commented May 14, 2024

k8s-ci-robot commented May 14, 2024

ahg-g commented May 14, 2024

kerthcet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kerthcet May 16, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kerthcet May 16, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kerthcet left a comment • edited

Choose a reason for hiding this comment

liurupeng commented May 20, 2024

k8s-ci-robot commented May 20, 2024

linux-foundation-easycla bot commented May 14, 2024 •

edited

kerthcet May 16, 2024 •

edited

kerthcet May 16, 2024 •

edited

kerthcet left a comment •

edited