kubeblocks

Documentation

Index

• Constants
• func CollectProgress(ctx context.Context, progressCh <-chan interface{}, verbose bool) func() error
• func LoadVendorCheckYaml(vendorName util.K8sProvider) ([][]byte, error)
• func NewConfigCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• func NewDescribeConfigCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• func NewKubeBlocksCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• func NewPreflightCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• type InstallOptions
  • func (o *InstallOptions) Install() error
  • func (o *InstallOptions) PreCheck() error
  • func (o *InstallOptions) Upgrade() error
• type Options
  • func (o *Options) Complete(f cmdutil.Factory, cmd *cobra.Command) error
• type PreflightOptions
  • func (p *PreflightOptions) Preflight(f cmdutil.Factory, args []string, opts values.Options) error
• type UninstallOptions
  • func (o *UninstallOptions) PreCheck() error
  • func (o *UninstallOptions) Uninstall() error

Constants

const (
	ResourceScopeGlobal resourceScope = "global"
	ResourceScopeLocal  resourceScope = "namespaced"
)

const (
	PreflightPattern     = "data/%s_preflight.yaml"
	HostPreflightPattern = "data/%s_hostpreflight.yaml"
	PreflightMessage     = "Run a preflight to check that the environment meets the requirement for KubeBlocks. It takes 10~20 seconds."
)

Functions

func CollectProgress

func CollectProgress(ctx context.Context, progressCh <-chan interface{}, verbose bool) func() error

func LoadVendorCheckYaml

func LoadVendorCheckYaml(vendorName util.K8sProvider) ([][]byte, error)

func NewConfigCmd

func NewConfigCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewConfigCmd creates the config command

func NewDescribeConfigCmd

func NewDescribeConfigCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewKubeBlocksCmd

func NewKubeBlocksCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

NewKubeBlocksCmd creates the kubeblocks command

func NewPreflightCmd

func NewPreflightCmd(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

Types

type InstallOptions

type InstallOptions struct {
	Options
	Version         string
	Monitor         bool
	Quiet           bool
	CreateNamespace bool
	Check           bool
	ValueOpts       values.Options
}

func (*InstallOptions) Install

func (o *InstallOptions) Install() error

func (*InstallOptions) PreCheck

func (o *InstallOptions) PreCheck() error

func (*InstallOptions) Upgrade

func (o *InstallOptions) Upgrade() error

type Options

type Options struct {
	genericclioptions.IOStreams

	HelmCfg *helm.Config

	// Namespace is the current namespace that the command is running
	Namespace string
	Client    kubernetes.Interface
	Dynamic   dynamic.Interface
	Timeout   time.Duration
	Wait      bool
}

func (*Options) Complete

func (o *Options) Complete(f cmdutil.Factory, cmd *cobra.Command) error

type PreflightOptions

type PreflightOptions struct {
	genericclioptions.IOStreams
	*preflight.PreflightFlags

	ValueOpts values.Options
	// contains filtered or unexported fields
}

PreflightOptions declares the arguments accepted by the preflight command

func (*PreflightOptions) Preflight

func (p *PreflightOptions) Preflight(f cmdutil.Factory, args []string, opts values.Options) error

type UninstallOptions

type UninstallOptions struct {
	Factory cmdutil.Factory
	Options

	// AutoApprove if true, skip interactive approval
	AutoApprove bool

	RemoveNamespace bool

	Quiet bool
	// contains filtered or unexported fields
}

func (*UninstallOptions) PreCheck

func (o *UninstallOptions) PreCheck() error

func (*UninstallOptions) Uninstall

func (o *UninstallOptions) Uninstall() error