cluster

package
v1.0.0-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 19, 2024 License: AGPL-3.0 Imports: 89 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ComponentStatusDefaultPodName = "Unknown"
)

Variables

This section is empty.

Functions

func BuildRegisterSuccessExamples

func BuildRegisterSuccessExamples(t cluster.ClusterType) string

BuildRegisterSuccessExamples builds the creation examples for the specified ClusterType type.

func MultipleSourceComponents

func MultipleSourceComponents(fileName string, in io.Reader) ([]byte, error)

MultipleSourceComponents gets component data from multiple source, such as stdin, URI and local file

func New

func New(clusterName string, namespace string, cli dynamic.Interface, component ...string) *configObjectsWrapper

func NewCancelCmd

func NewCancelCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewClusterCmd

func NewClusterCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewClusterCmd creates the cluster command

func NewConnectCmd

func NewConnectCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewConnectCmd returns the cmd of connecting to a cluster

func NewCreateBackupCmd

func NewCreateBackupCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewCreateCmd

func NewCreateCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewCreateRestoreCmd

func NewCreateRestoreCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewCustomOpsCmd added in v0.7.2

func NewCustomOpsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDeleteBackupCmd

func NewDeleteBackupCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDeleteCmd

func NewDeleteCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDeleteOpsCmd

func NewDeleteOpsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDescribeBackupCmd

func NewDescribeBackupCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDescribeBackupPolicyCmd

func NewDescribeBackupPolicyCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDescribeCmd

func NewDescribeCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDescribeOpsCmd

func NewDescribeOpsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewDescribeReconfigureCmd

func NewDescribeReconfigureCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewDescribeReconfigureCmd shows details of history modifications or configuration file of reconfiguring operations

func NewDiffConfigureCmd

func NewDiffConfigureCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewDiffConfigureCmd shows the difference between two configuration version.

func NewEditBackupPolicyCmd

func NewEditBackupPolicyCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewEditConfigureCmd

func NewEditConfigureCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewEditConfigureCmd shows the difference between two configuration version.

func NewExplainReconfigureCmd

func NewExplainReconfigureCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewExplainReconfigureCmd shows details of modifiable parameters.

func NewExposeCmd

func NewExposeCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewExposeCmd creates an expose command

func NewLabelCmd

func NewLabelCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListBackupCmd

func NewListBackupCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListBackupPolicyCmd

func NewListBackupPolicyCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListCmd

func NewListCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListComponentsCmd

func NewListComponentsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListEventsCmd

func NewListEventsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListInstancesCmd

func NewListInstancesCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListLogsCmd

func NewListLogsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListOpsCmd

func NewListOpsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewListRestoreCommand

func NewListRestoreCommand(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewLogsCmd

func NewLogsCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewLogsCmd returns the logic of accessing cluster log file

func NewPromoteCmd

func NewPromoteCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewPromoteCmd creates a promote command

func NewRebuildInstanceCmd added in v0.9.0

func NewRebuildInstanceCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewRebuildInstanceCmd creates a rebuildInstance command

func NewReconfigureCmd

func NewReconfigureCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewReconfigureCmd creates a Reconfiguring command

func NewRestartCmd

func NewRestartCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewRestartCmd creates a restart command

func NewRestoreDescribeCommand

func NewRestoreDescribeCommand(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewScaleInCmd

func NewScaleInCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewScaleInCmd creates a scale in command

func NewScaleOutCmd

func NewScaleOutCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewStartCmd

func NewStartCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewStartCmd creates a start command

func NewStopCmd

func NewStopCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewStopCmd creates a stop command

func NewUpdateCmd

func NewUpdateCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

func NewUpgradeCmd

func NewUpgradeCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewUpgradeCmd creates an upgrade command

func NewVerticalScalingCmd

func NewVerticalScalingCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewVerticalScalingCmd creates a vertical scaling command

func NewVolumeExpansionCmd

func NewVolumeExpansionCmd(f cmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Command

NewVolumeExpansionCmd creates a volume expanding command

func RegisterClusterChart

func RegisterClusterChart(f cmdutil.Factory, streams genericiooptions.IOStreams, source, engine, version, repo string) error

RegisterClusterChart a util function to register cluster chart used by addon install, upgrade and enable.

Types

type ConfigRelatedObjects

type ConfigRelatedObjects struct {
	Cluster        *appsv1alpha1.Cluster
	ConfigSpecs    map[string]configSpecsType
	Configurations []*appsv1alpha1.Configuration
}

type ConnectOptions

type ConnectOptions struct {
	*action.ExecOptions
	// contains filtered or unexported fields
}

func (*ConnectOptions) Complete added in v0.7.3

func (o *ConnectOptions) Complete() error

func (*ConnectOptions) Validate added in v0.7.3

func (o *ConnectOptions) Validate(args []string) error

type CreateOptions

type CreateOptions struct {
	Cmd *cobra.Command `json:"-"`

	action.CreateOptions `json:"-"`
}

func NewCreateOptions

func NewCreateOptions(f cmdutil.Factory, streams genericiooptions.IOStreams) *CreateOptions

type CreateSubCmdsOptions added in v0.7.2

type CreateSubCmdsOptions struct {
	// ClusterType is the type of the cluster to create.
	ClusterType cluster.ClusterType

	// values is used to render the cluster helm ChartInfo.
	Values map[string]interface{}

	// ChartInfo is the cluster chart information, used to render the command flag
	// and validate the values.
	ChartInfo *cluster.ChartInfo

	// Configuration and options for cluster affinity and tolerations
	PodAntiAffinity string `json:"podAntiAffinity"`
	// TopologyKeys if TopologyKeys is nil, add omitempty json tag, because CueLang can not covert null to list.
	TopologyKeys   []string          `json:"topologyKeys,omitempty"`
	NodeLabels     map[string]string `json:"nodeLabels,omitempty"`
	Tenancy        string            `json:"tenancy"`
	TolerationsRaw []string          `json:"-"`
	Tolerations    []corev1.Toleration

	// SkipSchemaValidation is used to skip the schema validation of the helm chart.
	SkipSchemaValidation bool `json:"-"`

	*action.CreateOptions
}

func NewSubCmdsOptions added in v0.7.2

func NewSubCmdsOptions(createOptions *action.CreateOptions, t cluster.ClusterType) (*CreateSubCmdsOptions, error)

func (*CreateSubCmdsOptions) Complete

func (o *CreateSubCmdsOptions) Complete(cmd *cobra.Command) error

func (*CreateSubCmdsOptions) Run added in v0.7.2

func (o *CreateSubCmdsOptions) Run() error

func (*CreateSubCmdsOptions) Validate

func (o *CreateSubCmdsOptions) Validate() error

type CustomOperations added in v0.7.3

type CustomOperations struct {
	*OperationsOptions
	OpsDefinitionName string                  `json:"opsDefinitionName"`
	Params            []opsv1alpha1.Parameter `json:"params"`
	SchemaProperties  *apiextensionsv1.JSONSchemaProps
}

type LabelOptions

type LabelOptions struct {
	Factory cmdutil.Factory
	GVR     schema.GroupVersionResource

	genericiooptions.IOStreams
	// contains filtered or unexported fields
}

type ListLogsOptions

type ListLogsOptions struct {
	genericiooptions.IOStreams
	// contains filtered or unexported fields
}

ListLogsOptions declares the arguments accepted by the list-logs command

func (*ListLogsOptions) Complete

func (o *ListLogsOptions) Complete(f cmdutil.Factory, args []string) error

func (*ListLogsOptions) Run

func (o *ListLogsOptions) Run() error

func (*ListLogsOptions) Validate

func (o *ListLogsOptions) Validate(args []string) error

type LogsOptions

type LogsOptions struct {
	*action.ExecOptions
	// contains filtered or unexported fields
}

LogsOptions declares the arguments accepted by the logs command

type OperationsOptions

type OperationsOptions struct {
	action.CreateOptions  `json:"-"`
	HasComponentNamesFlag bool `json:"-"`
	// AutoApprove when set true, skip the double check.
	AutoApprove            bool     `json:"-"`
	ComponentNames         []string `json:"componentNames,omitempty"`
	OpsRequestName         string   `json:"opsRequestName"`
	InstanceTPLNames       []string `json:"instanceTPLNames,omitempty"`
	TTLSecondsAfterSucceed int      `json:"ttlSecondsAfterSucceed"`
	Force                  bool     `json:"force"`

	// OpsType operation type
	OpsType opsv1alpha1.OpsType `json:"type"`

	// OpsTypeLower lower OpsType
	OpsTypeLower string `json:"typeLower"`

	ComponentDefinitionName string `json:"componentDefinitionName"`
	ServiceVersion          string `json:"serviceVersion"`

	// VerticalScaling options
	CPU    string `json:"cpu"`
	Memory string `json:"memory"`

	// HorizontalScaling options
	Replicas                 string   `json:"replicas"`
	ScaleOut                 bool     `json:"scaleOut"`
	OfflineInstancesToOnline []string `json:"offlineInstancesToOnline,omitempty"`
	OnlineInstancesToOffline []string `json:"onlineInstancesToOffline,omitempty"`

	// Reconfiguring options
	KeyValues       map[string]*string `json:"keyValues"`
	CfgTemplateName string             `json:"cfgTemplateName"`
	CfgFile         string             `json:"cfgFile"`
	ForceRestart    bool               `json:"forceRestart"`
	FileContent     string             `json:"fileContent"`
	HasPatch        bool               `json:"hasPatch"`

	// VolumeExpansion options.
	// VCTNames VolumeClaimTemplate names
	VCTNames []string `json:"vctNames,omitempty"`
	Storage  string   `json:"storage"`

	// Expose options
	ExposeType    string                   `json:"-"`
	ExposeSubType string                   `json:"-"`
	ExposeEnabled string                   `json:"exposeEnabled,omitempty"`
	Services      []opsv1alpha1.OpsService `json:"services,omitempty"`

	// Switchover options
	Component           string                        `json:"component"`
	Instance            string                        `json:"instance"`
	BackupName          string                        `json:"-"`
	Inplace             bool                          `json:"-"`
	InstanceNames       []string                      `json:"-"`
	Nodes               []string                      `json:"-"`
	RebuildInstanceFrom []opsv1alpha1.RebuildInstance `json:"rebuildInstanceFrom,omitempty"`
	Env                 []string                      `json:"-"`
}

func (*OperationsOptions) CompleteComponentsFlag

func (o *OperationsOptions) CompleteComponentsFlag() error

CompleteComponentsFlag when components flag is null and the cluster only has one component, auto complete it.

func (*OperationsOptions) CompleteRestartOps

func (o *OperationsOptions) CompleteRestartOps() error

CompleteRestartOps restarts all components of the cluster we should set all component names to ComponentNames flag.

func (*OperationsOptions) CompleteSwitchoverOps

func (o *OperationsOptions) CompleteSwitchoverOps() error

func (*OperationsOptions) Validate

func (o *OperationsOptions) Validate() error

Validate command flags or args is legal

type UpdatableFlags

type UpdatableFlags struct {
	// Options for cluster termination policy
	TerminationPolicy string `json:"terminationPolicy"`

	// Add-on switches for cluster observability
	DisableExporter bool `json:"monitor"`
	EnableAllLogs   bool `json:"enableAllLogs"`

	// Configuration and options for cluster affinity and tolerations
	PodAntiAffinity  string `json:"podAntiAffinity"`
	RuntimeClassName string `json:"runtimeClassName,omitempty"`
	// TopologyKeys if TopologyKeys is nil, add omitempty json tag, because CueLang can not covert null to list.
	TopologyKeys   []string          `json:"topologyKeys,omitempty"`
	NodeLabels     map[string]string `json:"nodeLabels,omitempty"`
	Tenancy        string            `json:"tenancy"`
	TolerationsRaw []string          `json:"-"`

	// backup config
	BackupEnabled                 bool   `json:"-"`
	BackupRetentionPeriod         string `json:"-"`
	BackupMethod                  string `json:"-"`
	BackupCronExpression          string `json:"-"`
	BackupStartingDeadlineMinutes int64  `json:"-"`
	BackupRepoName                string `json:"-"`
	BackupPITREnabled             bool   `json:"-"`
}

UpdatableFlags is the flags that cat be updated by update command

type UpdateOptions added in v0.7.2

type UpdateOptions struct {
	ValMap map[string]interface{}

	UpdatableFlags
	*action.PatchOptions
	// contains filtered or unexported fields
}

func NewUpdateOptions added in v0.7.2

func NewUpdateOptions(f cmdutil.Factory, streams genericiooptions.IOStreams) *UpdateOptions

func (*UpdateOptions) CmdComplete added in v0.7.2

func (o *UpdateOptions) CmdComplete(cmd *cobra.Command, args []string) error

func (*UpdateOptions) Complete added in v0.7.2

func (o *UpdateOptions) Complete() error

func (*UpdateOptions) Exec added in v0.7.2

func (o *UpdateOptions) Exec() error

func (*UpdateOptions) Validate added in v0.7.2

func (o *UpdateOptions) Validate() error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL