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

completion: add note that 'bash-completion' is required on Linux too #860

Closed
xlgao-zju opened this issue May 26, 2018 · 6 comments · Fixed by kubernetes/kubernetes#64361
Closed

completion: add note that 'bash-completion' is required on Linux too #860

xlgao-zju opened this issue May 26, 2018 · 6 comments · Fixed by kubernetes/kubernetes#64361
Assignees
@xlgao-zju
Labels
area/UX documentation/improvement help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@xlgao-zju
Copy link

Is this a BUG REPORT or FEATURE REQUEST?

BUG REPORT

Versions

kubeadm version (use kubeadm version):v1.9.3

Environment:

  • OS (e.g. from /etc/os-release): CentOS 7.4
  • Kernel (e.g. uname -a): Linux iZbp1h3apv3aahc08gsdbhZ 3.10.0-693.2.2.el7.x86_64 kubeadm join on slave node fails preflight checks #1 SMP Tue Sep 12 22:26:13 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
  • Others:I am using bash

What happened?

After I run source <(kubeadm completion bash), I type kubeadm u and the type the tab. I get

kubeadm u-bash: _get_comp_words_by_ref: not found

What you expected to happen?

Get

kubeadm upgrade
@neolit123 neolit123 added kind/bug Categorizes issue or PR as related to a bug. area/UX help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels May 26, 2018
@xlgao-zju
Copy link
Author

I just finger out I did not install the bash-completion, we can close it.
But should we tell the users that they should check the installation of bash-completion, since we only mention the Mac in the help...

Note: this requires the bash-completion framework, which is not installed
by default on Mac. This can be installed by using homebrew:

@neolit123
Copy link
Member

I just finger out I did not install the bash-completion, we can close it.
But should we tell the users that they should check the installation of bash-completion, since we only mention the Mac in the help...

yes, definitely.

https://github.com/kubernetes/kubernetes/blob/master/cmd/kubeadm/app/cmd/completion.go#L55

should be changed to something like:

Note: this requires the bash-completion framework.

To install it on Mac use homebrew:
    $ brew install bash-completion
Once installed, bash_completion must be evaluated. This can be done by adding the
following line to the .bash_profile
    $ source $(brew --prefix)/etc/bash_completion

If bash-completion is not installed on Linux, please install the 'bash-completion' package
via your distribution's package manager.

please, feel free to /assign if you want to make the change.

@neolit123 neolit123 changed the title kubeadm completion dose not work completion: add note that 'bash-completion' is required on Linux too May 26, 2018
@neolit123 neolit123 added documentation/improvement and removed kind/bug Categorizes issue or PR as related to a bug. labels May 26, 2018
@xlgao-zju
Copy link
Author

/assign

@xlgao-zju
Copy link
Author

@neolit123 I am very interested in kubeadm, I'd like to do some contribution. So feel free to ping me, if there is anything I can help(though I am a beginner of kubeadm). 😆

@neolit123
Copy link
Member

@xlgao-zju
sure, contributions are welcome!

@xlgao-zju xlgao-zju mentioned this issue May 26, 2018
Merged
k8s-github-robot pushed a commit to kubernetes/kubernetes that referenced this issue May 31, 2018
Merge pull request #64361 from xlgao-zju/patch-1
2b1bfc3 
Automatic merge from submit-queue (batch tested with PRs 61803, 64305, 64170, 64361, 64339). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

Improve the help of kubeadm completion

**What this PR does / why we need it**:
Add note that 'bash-completion' is required on Linux too.

**Which issue(s) this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*:
Fixes [kubernetes/kubeadm/#860](kubernetes/kubeadm#860)

**Special notes for your reviewer**:
cc @neolit123

**Release note**:
```release-note
NONE
```
@stealthybox
Copy link
Member

@xlgao-zju here's the help-wanted issue query 👍
Definitely feel free to /assign yourself to any open issues :)

Also, the development slack channel is kubernetes#sig-cluster-lifecycle, and we have office hours every wednesday. Feel welcome to join and ask questions. We'd love to help you become a better contributor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@xlgao-zju xlgao-zju

Labels
area/UX documentation/improvement help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve the help of kubeadm completion xlgao-zju/kubernetes
3 participants
@neolit123 @xlgao-zju @stealthybox