kubectl

Documentation

Index

• Constants
• type BinaryRunner
  • func NewBinaryRunner() *BinaryRunner
  • func (e *BinaryRunner) RunKubectlCommand(ctx context.Context, kubeConfigPath, defaultNamespace, cmd string) (string, error)
• type Config
  • func MergeConfigs(configs []*executor.Config) (Config, error)
  • func (c Config) Validate() error
• type Executor
  • func NewExecutor(ver string, kcRunner kcRunner) *Executor
  • func (e *Executor) Execute(ctx context.Context, in executor.ExecuteInput) (executor.ExecuteOutput, error)
  • func (*Executor) Help(context.Context) (api.Message, error)
  • func (e *Executor) Metadata(context.Context) (api.MetadataOutput, error)
• type KubeconfigScopedRunner
  • func NewKubeconfigScopedRunner(underlying kcRunner, kubeconfigPath string) *KubeconfigScopedRunner
  • func (k *KubeconfigScopedRunner) RunKubectlCommand(ctx context.Context, defaultNamespace, cmd string) (string, error)

Constants

const (
	// PluginName is the name of the Helm Botkube plugin.
	PluginName = "kubectl"
)

Types

type BinaryRunner

type BinaryRunner struct {
	// contains filtered or unexported fields
}

BinaryRunner runs a kubectl binary.

func NewBinaryRunner

func NewBinaryRunner() *BinaryRunner

NewBinaryRunner returns a new BinaryRunner instance.

func (*BinaryRunner) RunKubectlCommand

func (e *BinaryRunner) RunKubectlCommand(ctx context.Context, kubeConfigPath, defaultNamespace, cmd string) (string, error)

RunKubectlCommand runs a Kubectl CLI command and run output.

type Config

type Config struct {
	Log                config.Logger  `yaml:"log"`
	DefaultNamespace   string         `yaml:"defaultNamespace,omitempty"`
	InteractiveBuilder builder.Config `yaml:"interactiveBuilder,omitempty"`
}

Config holds Kubectl plugin configuration parameters.

func MergeConfigs

func MergeConfigs(configs []*executor.Config) (Config, error)

MergeConfigs merges the Kubectl configuration.

func (Config) Validate

func (c Config) Validate() error

type Executor

type Executor struct {
	// contains filtered or unexported fields
}

Executor provides functionality for running Helm CLI.

func NewExecutor

func NewExecutor(ver string, kcRunner kcRunner) *Executor

NewExecutor returns a new Executor instance.

func (*Executor) Execute

func (e *Executor) Execute(ctx context.Context, in executor.ExecuteInput) (executor.ExecuteOutput, error)

Execute returns a given command as response.

func (*Executor) Help

func (*Executor) Help(context.Context) (api.Message, error)

Help returns help message.

func (*Executor) Metadata

func (e *Executor) Metadata(context.Context) (api.MetadataOutput, error)

Metadata returns details about Helm plugin.

type KubeconfigScopedRunner

type KubeconfigScopedRunner struct {
	// contains filtered or unexported fields
}

KubeconfigScopedRunner is a runner that executes kubectl commands using a specific kubeconfig file.

func NewKubeconfigScopedRunner

func NewKubeconfigScopedRunner(underlying kcRunner, kubeconfigPath string) *KubeconfigScopedRunner

NewKubeconfigScopedRunner creates a new instance of KubeconfigScopedRunner.

func (*KubeconfigScopedRunner) RunKubectlCommand

func (k *KubeconfigScopedRunner) RunKubectlCommand(ctx context.Context, defaultNamespace, cmd string) (string, error)

RunKubectlCommand runs a kubectl CLI command scoped to configured kubeconfig.