karmada

Documentation

Index

• func NewDeInitDataJob(opt *DeInitOptions) *workflow.Job
• func NewInitJob(opt *InitOptions) *workflow.Job
• type DeInitOpt
  • func NewDeInitOptWithKarmada(karmada *operatorv1alpha1.Karmada) DeInitOpt
  • func NewDeInitOptWithKubeconfig(config *rest.Config) DeInitOpt
• type DeInitOptions
  • func NewJobDeInitOptions(opts ...DeInitOpt) *DeInitOptions
• type InitOpt
  • func NewInitOptWithKarmada(karmada *operatorv1alpha1.Karmada) InitOpt
  • func NewInitOptWithKubeconfig(config *rest.Config) InitOpt
• type InitOptions
  • func NewJobInitOptions(opts ...InitOpt) *InitOptions
  • func (opt *InitOptions) Validate() error

Functions

func NewDeInitDataJob

func NewDeInitDataJob(opt *DeInitOptions) *workflow.Job

NewDeInitDataJob initializes a deInit job with a list of sub tasks. and build deinit runData object

func NewInitJob

func NewInitJob(opt *InitOptions) *workflow.Job

NewInitJob initializes a job with list of init sub-task. and build init runData object.

Types

type DeInitOpt

type DeInitOpt func(o *DeInitOptions)

DeInitOpt defines a type of function to set DeInitOptions values.

func NewDeInitOptWithKarmada

func NewDeInitOptWithKarmada(karmada *operatorv1alpha1.Karmada) DeInitOpt

NewDeInitOptWithKarmada returns a DeInitOpt function to initialize DeInitOptions with karmada resource

func NewDeInitOptWithKubeconfig

func NewDeInitOptWithKubeconfig(config *rest.Config) DeInitOpt

NewDeInitOptWithKubeconfig returns a DeInitOpt function to set kubeconfig to DeInitOptions with rest config

type DeInitOptions

type DeInitOptions struct {
	Name        string
	Namespace   string
	Kubeconfig  *rest.Config
	HostCluster *operatorv1alpha1.HostCluster
}

DeInitOptions defines all the Deinit workflow options.

func NewJobDeInitOptions

func NewJobDeInitOptions(opts ...DeInitOpt) *DeInitOptions

NewJobDeInitOptions calls all of DeInitOpt func to initialize a DeInitOptions. if there is not DeInitOpt functions, it will return a default DeInitOptions.

type InitOpt

type InitOpt func(o *InitOptions)

InitOpt defines a type of function to set InitOptions values.

func NewInitOptWithKarmada

func NewInitOptWithKarmada(karmada *operatorv1alpha1.Karmada) InitOpt

NewInitOptWithKarmada returns a InitOpt function to initialize InitOptions with karmada resource

func NewInitOptWithKubeconfig

func NewInitOptWithKubeconfig(config *rest.Config) InitOpt

NewInitOptWithKubeconfig returns a InitOpt function to set kubeconfig to InitOptions with rest config

type InitOptions

type InitOptions struct {
	Name           string
	Namespace      string
	Kubeconfig     *rest.Config
	KarmadaVersion string
	CRDRemoteURL   string
	KarmadaDataDir string
	Karmada        *operatorv1alpha1.Karmada
}

InitOptions defines all the init workflow options.

func NewJobInitOptions

func NewJobInitOptions(opts ...InitOpt) *InitOptions

NewJobInitOptions calls all of InitOpt func to initialize a InitOptions. if there is not InitOpt functions, it will return a default InitOptions.

func (*InitOptions) Validate

func (opt *InitOptions) Validate() error

Validate is used to validate the initOptions before creating initJob.