Generating the shell autocompletion files reqires a valid kubeconfig

[kastl-ars]

Dear maintainers,

I found kubectl-rook-ceph and wanted to package it for openSUSE. Unfortunately creating the shell completion using the kubectl-rook-ceph completion xyz commands errors out due to a missing kubeconfig:

[   30s] Executing(%install): /usr/bin/bash -e /var/tmp/rpm-tmp.iKAS6L
[   30s] + umask 022
[   30s] + cd /home/abuild/rpmbuild/BUILD
[   30s] + /usr/bin/rm -rf /home/abuild/rpmbuild/BUILDROOT/kubectl-rook-ceph-0.9.3-0.x86_64
[   30s] + /usr/bin/mkdir -p /home/abuild/rpmbuild/BUILDROOT
[   30s] + /usr/bin/mkdir /home/abuild/rpmbuild/BUILDROOT/kubectl-rook-ceph-0.9.3-0.x86_64
[   30s] + cd kubectl-rook-ceph-0.9.3
[   30s] + install -D -m 0755 bin/kubectl-rook_ceph /home/abuild/rpmbuild/BUILDROOT/kubectl-rook-ceph-0.9.3-0.x86_64//usr/bin/kubectl-rook_ceph
[   30s] + mkdir -p /home/abuild/rpmbuild/BUILDROOT/kubectl-rook-ceph-0.9.3-0.x86_64/usr/share/bash-completion/completions/
[   30s] + /home/abuild/rpmbuild/BUILDROOT/kubectl-rook-ceph-0.9.3-0.x86_64//usr/bin/kubectl-rook_ceph completion bash
[   30s] Error: invalid configuration: no configuration has been provided, try setting KUBERNETES_MASTER environment variable
[   30s] error: Bad exit status from /var/tmp/rpm-tmp.iKAS6L (%install)

Creating an empyt ~/.kube/config file does not work.

Most of the tools that provide generation of shell completions do not require a kubeconfig for that, similar to being able to call -help or help or --help subcommands without requiring a configuration file.

Could this be changed in kubectl-rook-ceph, too?

Thanks in advance,
Johannes

[subhamkrai]

@kastl-ars sometime back tried command completion for krew plugin it was not available at that time. But I think it's been long time I can give it try again

[kastl-ars]

That would be great. Just to be clear, there is an existing completion subcommand. I think that those completions only work when the executable is called directly, not via kubectl rook-ceph.

[nirs]

That would be great. Just to be clear, there is an existing completion subcommand. I think that those completions only work when the executable is called directly, not via kubectl rook-ceph.

Completion should work also for kubectl rook-ceph see this example from kubectl-gather plugin:

https://github.com/nirs/kubectl-gather?tab=readme-ov-file#shell-completion

[subhamkrai]

That would be great. Just to be clear, there is an existing completion subcommand. I think that those completions only work when the executable is called directly, not via kubectl rook-ceph.

Completion should work also for kubectl rook-ceph see this example from kubectl-gather plugin:

https://github.com/nirs/kubectl-gather?tab=readme-ov-file#shell-completion

will it work as official kubectl plugin also ?

[nirs]

will it work as official kubectl plugin also ?

What is "official" plugin? do you mean when installed via krew?

I'm using this for kubectl-gather installed manually from github on Linux and macOS and completion works. I did not try with krew since I did not packaged it as krew plugin, but it should work since krew is just a way to locate and deliver the plugin. During runtime it behaves just like any other plugin installed manually. kubectl or oc do the work of locating plugins and completion scripts and running them.

[4censord]

It also doesnt work if rook is not installed

$ kubectl-rook-ceph completion fish
Error: operator namespace 'rook-ceph' does not exist. namespaces "rook-ceph" not found

[subhamkrai]

It also doesnt work if rook is not installed

$ kubectl-rook-ceph completion fish
Error: operator namespace 'rook-ceph' does not exist. namespaces "rook-ceph" not found

@4censord tool expect there is rook-ceph cluster installed. Are you trying for autocompletion?

[4censord]

i was just trying to generate the completions, so I can use them later.
I did have a valid kubeconfig, but no rook installed on the respective cluster. IMHO generating the completions should work without that.

(basically what the nix packaging tries, I also wanted to package the plugin with the completions)

[nirs]

I think we need to change the way the clusters are validated. This is relevant only to running some commands so it should not be done in a pre-run function.

[subhamkrai]

I can do the cahnges when I get some time in couple of week but meantime if @4censord you want to contribute feel free to raise a pr

[ismxilxrif]

do we really need to validate if a cluster is working before generating completions? i'm running an eval statement in .bashrc so if i'm not in the corporate network, my shell startup would be affected.

[subhamkrai]

@ismxilxrif shell completions should be required to validate if cluster is working or not.

[ismxilxrif]

odd enough, but kubectl doesn't require that, and i ran an eval statement for that too. could you explain why tho? does the completions embed the cluster name or something? if so, i think that might not be the best design choice for constructing a completion script, then again, i may not know better here.