Update the kubectl plugin mechanism

[juanvallejo]

Release note:

The plugin mechanism functionality now closely follows the git plugin design

Replace the existing plugin mechanism with the design proposed in kubernetes/community#2437.

The full implementation of the plugin mechanism itself is entirely contained within the first commit.

Walkthrough

Under the new design, there is no plugin installation or loading required to use plugins.
A plugin is simply any executable file on a user's PATH whose name begins with kubectl-.

• Plugins receive the inherited environment from the kubectl binary. All environment variables
  accessible by kubectl become accessible by the plugin.
• Plugins decide which command path they wish to implement based on their name. For example, a plugin wanting to provide a new command foo, would simply be named kubectl-foo.

Creating a plugin

Below is an example plugin, that we will use for this walkthrough. Plugins may be written in any language, and handle arguments and flags in any way, optionally (as a convention) providing a way to retrieve their version via a version subcommand.

#!/bin/bash

# optional argument handling
if [[ "$1" == "version" ]]
then
    echo "1.0.0"
    exit 0
fi

# optional argument handling
if [[ "$1" == "config" ]]
then
    echo $KUBECONFIG
    exit 0
fi

echo "I am a plugin named kubectl-foo"

Using a plugin

To use a plugin, simply make it executable:

sudo chmod +x ./kubectl-foo

and place it anywhere in your PATH:

sudo mv ./kubectl-foo /usr/local/bin

You may now invoke your plugin as a kubectl command:

$ kubectl foo
I am a plugin named kubectl-foo

All args and flags are passed as-is to the executable:

$ kubectl foo version
1.0.0

All environment variables are also passed as-is to the executable:

$ export KUBECONFIG=~/.kube/config
$ kubectl foo config
/home/<user>/.kube/config

$ KUBECONFIG=/etc/kube/config kubectl foo config
/etc/kube/config

Additionally, the first argument that is passed to a plugin will always be the full path to the location where it was invoked ($0 would equal /usr/local/bin/kubectl-foo in our example above).

Plugin discoverability

Seeing as how the kubectl plugin command is left as a no-op with this PR (perhaps it could serve as an entrypoint towards additional plugin functionality in the future), a small subcommand has been included that lists all available plugin executables on a user's PATH, along with any warnings it finds.

Example usage of this new subcommand is included below:

$ kubectl plugin list
The following kubectl-compatible plugins are available:

test/fixtures/pkg/kubectl/plugins/kubectl-foo
plugins/kubectl-foo
  - warning: plugins/kubectl-foo is overshadowed by a similarly named plugin: test/fixtures/pkg/kubectl/plugins/kubectl-foo
plugins/kubectl-invalid
  - warning: plugins/kubectl-invalid identified as a kubectl plugin, but it is not executable
plugins/kubectl-bar

error: 2 plugin warnings were found

cc @kubernetes/kubectl-maintainers @kubernetes/sig-cli-pr-reviews @soltysh @seans3 @mengqiy

[soltysh]

Two nits, mostly looks good. Please squash your changes into single commit (or fix the current commits), since the current split is hard to justify and read. Also fix that remaining tests.
/approve

[soltysh]

Return error in this method and have that os.Exit(1) call in NewDefaultKubectlCommand, otherwise you're hiding this.

[soltysh]

Shouldn't you be also checking if the command is executable?

[juanvallejo]

Thanks, added this as part of the "Verify" method

[soltysh]

I'm manually adding approve label, since the docs update is related with cli changes.

[juanvallejo]

/retest

[juanvallejo]

/retest

[juanvallejo]

@soltysh thanks, review comments addressed

[juanvallejo]

/test pull-kubernetes-e2e-gce

[soltysh]

The code looks good, the proposal has merged as well.
/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: juanvallejo, soltysh

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:

• docs/OWNERS
• pkg/kubectl/OWNERS [soltysh]
• test/cmd/OWNERS [soltysh]
• test/fixtures/pkg/kubectl/OWNERS [soltysh]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[k8s-github-robot]

Automatic merge from submit-queue (batch tested with PRs 67062, 67169, 67539, 67504, 66876). If you want to cherry-pick this change to another branch, please follow the instructions here.