mfpierre / kubectl-plugin-boilerplate

This repository provide a starting code base to write a kubectl plugin in go.

kubectl-plugin-boilerplate

This repository provide a starting code base to write a kubectl plugin in go.

Installing

make install

Running

./kubectl-boilerplate -h
Kubectl plugin boilerplate

Usage:
  plugin-boilerplate [command]

Available Commands:
  find        Find the node running the provided pod
  help        Help about any command

Flags:
      --as string                      Username to impersonate for the operation
      --as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --cache-dir string               Default HTTP cache directory (default "/Users/pierre/.kube/http-cache")
      --certificate-authority string   Path to a cert file for the certificate authority
      --client-certificate string      Path to a client certificate file for TLS
      --client-key string              Path to a client key file for TLS
      --cluster string                 The name of the kubeconfig cluster to use
      --context string                 The name of the kubeconfig context to use
  -h, --help                           help for plugin-boilerplate
      --insecure-skip-tls-verify       If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
      --kubeconfig string              Path to the kubeconfig file to use for CLI requests.
  -n, --namespace string               If present, the namespace scope for this CLI request
      --request-timeout string         The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
  -s, --server string                  The address and port of the Kubernetes API server
      --token string                   Bearer token for authentication to the API server
      --user string                    The name of the kubeconfig user to use

Use "plugin-boilerplate [command] --help" for more information about a command.

Cleanup

You can "uninstall" this plugin from kubectl by simply removing it from your PATH:

rm /usr/local/bin/kubectl-plugin-boilerplate

Compatibility

HEAD of this repository will match HEAD of k8s.io/apimachinery and k8s.io/client-go.