Production-Grade Container Scheduling and Management
Go to file
Kubernetes Submit Queue d4ece0abc3 Merge pull request #37499 from fabianofranz/kubectl_plugins
Automatic merge from submit-queue

kubectl binary plugins

**What this PR does / why we need it**:

Introduces the ability to extend `kubectl` by adding third-party plugins that will be exposed through `kubectl`.

Plugins are executable commands written in any language. To be included as a plugin, a binary or script file has to

1. be located under one of the supported plugin path locations:
1.1 `~/.kubectl/plugins` dir
1.2. one or more directory set in the `KUBECTL_PLUGINS_PATH` env var
1.3. the `kubectl/plugins` dir under one or more directory set in the `XDG_DATA_DIRS` env var, which defaults to `/usr/local/share:/usr/share`
2. in any of the plugin path above, have a subfolder with the plugin file(s)
3. in the subfolder, contain at least a `plugin.yaml` file that describes the plugin

Example:

```
$ cat ~/.kube/plugins/myplugin/plugin.yaml
name: "myplugin"
shortDesc: "My plugin's short description"
command: "echo Hello plugins!"

$ kubectl myplugin
Hello plugins!
```

~~In case the plugin declares `tunnel: true`, the plugin engine will pass the `KUBECTL_PLUGIN_API_HOST` env var when calling the plugin binary. Plugins can then access the Kube REST API in "http://$KUBECTL_PLUGIN_API_HOST/api" using the same context currently in use by `kubectl`.~~

Test plugins are provided in `pkg/kubectl/plugins/examples`. Just copy (or symlink) the files to `~/.kube/plugins` to test.

**Which issue this PR fixes**:

Related to the discussions in the proposal document: https://github.com/kubernetes/kubernetes/pull/30086 and https://github.com/kubernetes/community/pull/122.

**Release note**:
```release-note
Introduces the ability to extend kubectl by adding third-party plugins. Developer preview, please refer to the documentation for instructions about how to use it.
```
2017-04-28 12:23:59 -07:00
.github PR template: Update links to kubernetes/community repo 2017-03-17 12:23:58 -04:00
api Add PATCH to supported list of proxy subresource verbs 2017-04-27 10:38:10 -04:00
build Merge pull request #44346 from mikedanese/build-static 2017-04-27 12:11:00 -07:00
cluster Merge pull request #43620 from ktsakalozos/bug/juju-master 2017-04-28 10:03:39 -07:00
cmd Merge pull request #44628 from dmmcquay/kubeadm_join_tests 2017-04-28 08:41:36 -07:00
docs Plugins are loaded under the 'kubectl plugin' command 2017-04-28 01:34:07 -03:00
examples Merge pull request #44804 from humblec/glusterfs-rearrange 2017-04-27 08:57:32 -07:00
federation Merge pull request #44888 from caesarxuchao/clean-deepcopy-init 2017-04-27 18:48:28 -07:00
Godeps Merge pull request #41197 from aleksandra-malinowska/monitoring-test 2017-04-27 03:44:22 -07:00
hack Plugins are loaded under the 'kubectl plugin' command 2017-04-28 01:34:07 -03:00
hooks
logo
pkg Merge pull request #37499 from fabianofranz/kubectl_plugins 2017-04-28 12:23:59 -07:00
plugin Merge pull request #41985 from ericchiang/bootstrap-token-auth-logging 2017-04-28 10:03:41 -07:00
staging Merge pull request #37499 from fabianofranz/kubectl_plugins 2017-04-28 12:23:59 -07:00
test Merge pull request #37499 from fabianofranz/kubectl_plugins 2017-04-28 12:23:59 -07:00
third_party autogenerated 2017-04-14 10:40:57 -07:00
translations Extract a bunch more strings from kubectl 2017-04-06 20:12:50 -07:00
vendor Merge pull request #41197 from aleksandra-malinowska/monitoring-test 2017-04-27 03:44:22 -07:00
.bazelrc
.gazelcfg.json Add go_genrule for zz_generated.openapi.go. 2017-04-25 17:51:36 -07:00
.generated_files
.gitattributes
.gitignore Remove verify_gen_openapi make rule. 2017-04-25 17:41:33 -07:00
BUILD.bazel Update repo-infra bazel dependency and use new gcs_upload rule 2017-04-25 13:45:28 -07:00
CHANGELOG.md Update CHANGELOG.md for v1.5.7. 2017-04-27 08:07:09 -04:00
code-of-conduct.md
CONTRIBUTING.md
labels.yaml
LICENSE
Makefile Remove verify_gen_openapi make rule. 2017-04-25 17:41:33 -07:00
Makefile.generated_files Remove verify_gen_openapi make rule. 2017-04-25 17:41:33 -07:00
OWNERS
OWNERS_ALIASES Merge pull request #42953 from kargakis/rm-myself 2017-04-03 01:50:58 -07:00
README.md Adjust the link to the right troubleshooting doc page 2017-04-13 08:20:39 +00:00
Vagrantfile
WORKSPACE update libc 2017-04-27 11:59:18 -07:00

Kubernetes

Submit Queue Widget GoDoc Widget


Kubernetes is an open source system for managing containerized applications across multiple hosts, providing basic mechanisms for deployment, maintenance, and scaling of applications.

Kubernetes builds upon a decade and a half of experience at Google running production workloads at scale using a system called Borg, combined with best-of-breed ideas and practices from the community.

Kubernetes is hosted by the Cloud Native Computing Foundation (CNCF). If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Kubernetes plays a role, read the CNCF announcement.


To start using Kubernetes

See our documentation on kubernetes.io.

Try our interactive tutorial.

Take a free course on Scalable Microservices with Kubernetes.

To start developing Kubernetes

The community repository hosts all information about building Kubernetes from source, how to contribute code and documentation, who to contact about what, etc.

If you want to build Kubernetes right away there are two options:

You have a working Go environment.
$ go get -d k8s.io/kubernetes
$ cd $GOPATH/src/k8s.io/kubernetes
$ make
You have a working Docker environment.
$ git clone https://github.com/kubernetes/kubernetes
$ cd kubernetes
$ make quick-release

If you are less impatient, head over to the developer's documentation.

Support

If you need support, start with the troubleshooting guide and work your way through the process that we've outlined.

That said, if you have questions, reach out to us one way or another.

Analytics