Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add field of override for component extraArgs #1180

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

liangyuanpeng
Copy link
Contributor

@liangyuanpeng liangyuanpeng commented Jul 17, 2024

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

I'm using componentsPatches to rewrite the args of kube-apiserver for etcd-servers and etcd-prefix, it's working for me but i found the arg etcd-servers and etcd-prefix is repeated. This PR is working for cleanup the repeate.

config.yaml

kind: KwokctlConfiguration
apiVersion: config.kwok.x-k8s.io/v1alpha1
componentsPatches:
- name: kube-apiserver
  extraArgs:
  - key: etcd-servers
    value: http://192.168.66.2:3379
  - key: etcd-prefix
    value: /test

cmd of container kube-apiserver

                "--etcd-prefix=/registry",
                "--allow-privileged=true",
                "--etcd-servers=http://kwok-kwok-etcd:2379",
...
                "--etcd-servers=http://192.168.66.2:3379",
                "--etcd-prefix=/test"

/assign @wzshiming

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

support override filed for extraArg.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 17, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @liangyuanpeng!

It looks like this is your first PR to kubernetes-sigs/kwok 🎉. 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/kwok 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
Copy link
Contributor

Hi @liangyuanpeng. 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.

@k8s-ci-robot 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 Jul 17, 2024
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 17, 2024
Copy link

netlify bot commented Jul 17, 2024

Deploy Preview for k8s-kwok canceled.

Name Link
🔨 Latest commit 43df963
🔍 Latest deploy log https://app.netlify.com/sites/k8s-kwok/deploys/66bede2023b9070008cf6d14

@liangyuanpeng
Copy link
Contributor Author

/release-note none

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Jul 17, 2024
Copy link
Member

@wzshiming wzshiming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can add an override field to ExtraArgs to override hardcode args.

pkg/kwokctl/runtime/util.go Outdated Show resolved Hide resolved
@liangyuanpeng
Copy link
Contributor Author

I think we can add an override field to ExtraArgs to override hardcode args.

@wzshiming
Do you mean add a arg like override=true into ExtraArgs? and for user, they need write something like :

componentsPatches:
- name: kube-apiserver
  extraArgs:
  - key: etcd-servers
    value: http://192.168.66.2:3379
  - key: etcd-prefix
    value: /test
  - key: override 
    value:  true

and do not override args by default.

@wzshiming
Copy link
Member

I think it looks like this.

When the override is true, the same key arguments that already exist are removed.

componentsPatches:
- name: kube-apiserver
  extraArgs:
  - key: etcd-servers
    value: http://192.168.66.2:3379
    override: true
  - key: etcd-prefix
    value: /test
    override: true

or another way to remove existing arguments

componentsPatches:
- name: kube-apiserver
  extraArgs:
  - key: etcd-servers
    remove: true
  - key: etcd-prefix
    remove: true
  - key: etcd-servers
    value: http://192.168.66.2:3379
  - key: etcd-prefix
    value: /test

@k8s-ci-robot k8s-ci-robot added kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 22, 2024
@liangyuanpeng liangyuanpeng marked this pull request as draft July 22, 2024 15:19
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 22, 2024
@liangyuanpeng liangyuanpeng marked this pull request as ready for review July 23, 2024 04:43
@k8s-ci-robot 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 Jul 23, 2024
@liangyuanpeng liangyuanpeng changed the title delete duplicate args for components. Add field of override for component extraArgs Jul 23, 2024
"sigs.k8s.io/kwok/pkg/apis/internalversion"
)

func TestApplyComponentPatch(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be better to have hard-coded expectation output.

Copy link
Contributor Author

@liangyuanpeng liangyuanpeng Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should, let me update it for test data for want later

pkg/kwokctl/runtime/util.go Outdated Show resolved Hide resolved
pkg/kwokctl/runtime/util.go Outdated Show resolved Hide resolved
@wzshiming
Copy link
Member

wzshiming commented Jul 24, 2024

@liangyuanpeng

I think the override may need to be used in a different way without sort args,
I worry sort args will lead to unexpected patch args in the future.
WDYT?

@liangyuanpeng liangyuanpeng force-pushed the args_unique branch 3 times, most recently from 73fd35a to 4eae31a Compare August 14, 2024 04:57
@liangyuanpeng liangyuanpeng marked this pull request as ready for review August 14, 2024 05:39
@k8s-ci-robot 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 Aug 14, 2024
@liangyuanpeng
Copy link
Contributor Author

@wzshiming ready to go!

pkg/apis/config/v1alpha1/kwokctl_configuration_types.go Outdated Show resolved Hide resolved
pkg/kwokctl/runtime/util_test.go Outdated Show resolved Hide resolved
pkg/kwokctl/runtime/util_test.go Outdated Show resolved Hide resolved
pkg/kwokctl/runtime/util.go Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Aug 14, 2024
pkg/kwokctl/runtime/util.go Outdated Show resolved Hide resolved
pkg/kwokctl/runtime/util_test.go Outdated Show resolved Hide resolved
pkg/kwokctl/runtime/util_test.go Outdated Show resolved Hide resolved
pkg/kwokctl/runtime/util.go Outdated Show resolved Hide resolved
@liangyuanpeng liangyuanpeng force-pushed the args_unique branch 3 times, most recently from 0e384d2 to 8896fc0 Compare August 15, 2024 14:04
@liangyuanpeng
Copy link
Contributor Author

/remove-kind cleanup
/kind feature

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. and removed kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. labels Aug 15, 2024
Copy link
Member

@wzshiming wzshiming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

pkg/kwokctl/runtime/util.go Outdated Show resolved Hide resolved
@k8s-ci-robot 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 Aug 16, 2024
@wzshiming
Copy link
Member

/approve
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 16, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: liangyuanpeng, wzshiming

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 16, 2024
@wzshiming
Copy link
Member

/override pull-kwok-e2e-test-main

@k8s-ci-robot
Copy link
Contributor

@wzshiming: Overrode contexts on behalf of wzshiming: pull-kwok-e2e-test-main

In response to this:

/override pull-kwok-e2e-test-main

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.

@k8s-ci-robot k8s-ci-robot merged commit e4552e6 into kubernetes-sigs:main Aug 16, 2024
26 checks passed
@liangyuanpeng liangyuanpeng deleted the args_unique branch August 16, 2024 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants