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.

Sign up for GitHub

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

Jump to bottom

kubeadm/kubeconfig:validate flag --config to make sure it is not empty #105649

Merged
merged 1 commit into from Oct 14, 2021
Merged

kubeadm/kubeconfig:validate flag --config to make sure it is not empty #105649

merged 1 commit into from Oct 14, 2021

Conversation

navist2020
Copy link
Contributor

@navist2020 navist2020 commented Oct 13, 2021 •
edited by k8s-ci-robot

What type of PR is this?

/kind bug

What this PR does / why we need it:

Command kubeadm kubeconfig user.
Falgs client-name and config are set to required.

kubernetes/cmd/kubeadm/app/cmd/kubeconfig.go

Lines 113 to 114 in e054181

cmd.MarkFlagRequired(options.CfgPath)
cmd.MarkFlagRequired("client-name")

But when I use this command like this:

kubeadm kubeconfig user --client-name=me --config=

It still works properly. If we want the user to pass this flag correctly, we should not allow it to be empty.
Or we can set it as not required.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

kubeadm: do not allow empty "--config" paths to be passed to "kubeadm kubeconfig user"

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

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 13, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @navist2020. Thanks for your PR.

I'm waiting for a kubernetes 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Oct 13, 2021
@k8s-ci-robot k8s-ci-robot added area/kubeadm sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Oct 13, 2021
neolit123
neolit123 reviewed Oct 13, 2021
View reviewed changes
Copy link
Member

@neolit123 neolit123 left a comment •
edited

Choose a reason for hiding this comment

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

given flag is required the change seems fine.
added a couple of minor suggestions.

what about client-name - does it error out on empty? it should, if not.

cmd/kubeadm/app/cmd/kubeconfig.go Outdated
@@ -17,6 +17,7 @@ limitations under the License.
package cmd

import (
"errors"
Copy link
Member

Choose a reason for hiding this comment

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

instead, please import github.com/pkg/errors bellow the cobra import.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Run ./hack/update-gofmt.sh
Maybe github.com/pkg/errors should import before "github.com/spf13/cobra.

cmd/kubeadm/app/cmd/kubeconfig.go Outdated
Comment on lines 82 to 84
if cfgPath == "" {
return errors.New("Kubeadm configuration path cannot be empty.")
}
Copy link
Member

@neolit123 neolit123 Oct 13, 2021 •
edited

Choose a reason for hiding this comment

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

Suggested change
if cfgPath == "" {
return errors.New("Kubeadm configuration path cannot be empty.")
}
if len(cfgPath) == 0 {
return errors.New("the kubeadm configuration path cannot be empty")
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.
And if client-name is empty, it can return an error

failure while creating  client certificate: unable to sign certificate: must specify a CommonName
To see the stack trace of this error execute with --v=5 or higher

@neolit123
Copy link
Member

/ok-to-test
/priority backlog
/triage accepted

@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. priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 13, 2021
@navist2020
Copy link
Contributor Author

/retest

neolit123
neolit123 reviewed Oct 14, 2021
View reviewed changes
Copy link
Member

@neolit123 neolit123 left a comment

Choose a reason for hiding this comment

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

thanks
/lgtm
/approve

@neolit123
Copy link
Member

/release-note-edit

kubeadm: do not allow empty "--config" paths to be passed to "kubeadm kubeconfig user"

@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 Oct 14, 2021
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 14, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: navist2020, neolit123

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 Oct 14, 2021
@k8s-ci-robot k8s-ci-robot merged commit 3f85ed4 into kubernetes:master Oct 14, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.23 milestone Oct 14, 2021
@navist2020 navist2020 deleted the kubeadm/kubeconfig/cfgPath branch October 29, 2021 01:29
@SataQiu SataQiu mentioned this pull request Feb 27, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@neolit123 neolit123 neolit123 left review comments

@fabriziopandini fabriziopandini Awaiting requested review from fabriziopandini

@RA489 RA489 Awaiting requested review from RA489

Assignees

@neolit123 neolit123

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubeadm cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. 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. priority/backlog Higher priority than priority/awaiting-more-evidence. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.23
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@navist2020 @k8s-ci-robot @neolit123