Welcome @zikhan!

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

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

The integration failure looks to be a flaky test. I'm thinking it's related to #103512. Someone should correct me if I'm wrong. Just gonna rerun and see if it magically doesn't timeout.

/retest

/retest

/retest

/priority important-longterm
/triage accepted
/assign @eddiezane

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: eddiezane, knight42, zikhan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

/label tide/merge-method-squash

/retest

/lgtm

/hold cancel

Hi all,

Maybe this would be better served as a new issue, but I was wondering how this can be used with PowerShell aliases.

I've downloaded kubectl v1.23 and run kubectl completion powershell | Out-String | Invoke-Expression. Autocomplete works great for kubectl but does not work for any aliases. For example, I am setting the following alias in my PowerShell profile.

sal k kubectl

I see on this documentation page that you can add autocomplete aliases in Bash with complete -F __start_kubectl k, but that is a Bash-specific command.

P.S. This third-party PowerShell module does handle aliases correctly: https://github.com/mziyabo/PSKubectlCompletion

Thanks for any help!

@micahmo Looks like the cobra library is not registering the alias's for the command in the generated script, that can be found here: https://github.com/mziyabo/PSKubectlCompletion/blob/f6f28153a616e14789a3a7fbcb493ff7f1f1ae85/PSKubectlCompletion.psm1#L16-L20

    $aliases = (get-alias).Where( { $_.Definition -in $rootCommands }).Name;
    if ($aliases) {
        $rootCommands += $aliases
    }
    Register-ArgumentCompleter -CommandName $rootCommands -ScriptBlock $ArgumentCompleter -Native

There is a bit of a workaround that I tried. If you take the output from the kubectl completion powershell and change the CommandName input to include the alias. It may worth creating an issue/PR on https://github.com/spf13/cobra to include it.

I was able to get the workaround to a single line command that you can use.

(kubectl completion powershell | Out-String) -replace "CommandName 'kubectl'","CommandName 'kubectl','k'" | iex

Thanks for the response @zikhan! Your workaround works perfectly for me.

Do you think it would be worth adding it to the documentation? There's already precedent for documenting additional alias-related commands, and this isn't that much more hacky than in Bash. :-)

@zikhan Should supporting aliases for powershell take a similar approach to what kubectl documents for bash aliasing and have the user run the following command?

Register-ArgumentCompleter -CommandName <myalias> -ScriptBlock $CobraScriptBlock

If that is the right solution for powershell, then Cobra needs to put the script block in a variable, like you have done in your scripts. I can take care of that if that is the proper solution (I'm not familiar with powershell much).

I like how you automated detecting aliases. However I worry it may not always work and that it would be simpler to teach the user what to do. For example, sal k /tmp/kubectl is not detected by using .Definition on get-alias.

I haven't had much time to play around get-alias to clean up the scripts, but I did notice it allowed for wildcard ala * in the -Description parameter. I'm also not sure about PowerShell version compatibility with wildcard description search. I was hoping to produce a less specific script for updating the docs so it could be a bit more usable for people who may have multiple aliases.