ctl

Documentation

Index

• func NewCommand() *cobra.Command
• type Handler
  • func (h *Handler) BindFlags(cmd *cobra.Command) []string
  • func (h *Handler) Init() handler_cobra.Init
  • func (h *Handler) Run(ctx context.Context, input handler.Input)

Functions

func NewCommand

func NewCommand() *cobra.Command

New returns a cobra command instance based on Handler.

Types

type Handler

type Handler struct {
	handler.Session

	KubectlConfigClient cage_k8s_config.Client
	KubeApiClientset    *cage_k8s_core.Clientset
	IdentityRegistry    *cage_k8s_identity.Registry

	// Executor provides an os/exec.Command API for running the kubectl CLI.
	Executor cage_exec.Executor

	AllNamespaces bool     `usage:"include identities from any/no namespace"`
	As            string   `usage:"User/ServiceAccount/Role/ClusterRole to impersonate"`
	AsGroup       []string `usage:"Group(s) to impersonate"`
	Cluster       string   `usage:"pass to kubctl if effective context's cluster matches, else error (default from current-context)"`
	ConfigFile    string   `usage:"kubectl config file to modify"`
	Context       string   `usage:"consider users in this --kubeconfig context (defaults to current-context)"`
	Namespace     string   `usage:"include identities from only one namespace (default from --context)"`

	Verbosity int `usage:"kubectl verbosity level (and verbose kubeauth output for any level > 0)"`
	// contains filtered or unexported fields
}

Handler defines the sub-command flags and logic.

func (*Handler) BindFlags

func (h *Handler) BindFlags(cmd *cobra.Command) []string

BindFlags binds the flags to Handler fields.

It implements cli/handler/cobra.Handler.

func (*Handler) Init

func (h *Handler) Init() handler_cobra.Init

Init defines the command, its environment variable prefix, etc.

It implements cli/handler/cobra.Handler.

func (*Handler) Run

func (h *Handler) Run(ctx context.Context, input handler.Input)

Run performs the sub-command logic.

It implements cli/handler/cobra.Handler.