cmd

Documentation

Overview

Package cmd implements capioperator commands.

Index

• Variables
• func CheckDeploymentAvailability(ctx context.Context, client ctrlclient.Client, labels map[string]string) (bool, error)
• func CreateKubeClient(kubeconfigPath, kubeconfigContext string) (ctrlclient.Client, error)
• func EnsureNamespaceExists(ctx context.Context, client ctrlclient.Client, namespace string) error
• func Examples(s string) string
• func Execute()
• func GetDeploymentByLabels(ctx context.Context, client ctrlclient.Client, labels map[string]string) (*appsv1.Deployment, error)
• func GetKubeconfigLocation() string
• func GetLatestRelease(ctx context.Context, repo repository.Repository) (string, error)
• func LongDesc(s string) string
• func NewGenericProvider(providerType clusterctlv1.ProviderType) operatorv1.GenericProvider
• type DeleteGroup
• type Version

Variables

var (
	ErrNotFound = fmt.Errorf("resource was not found")
)

var RootCmd = &cobra.Command{
	Use:          "capioperator",
	SilenceUsage: true,
	Short:        "capioperator controls the lifecycle of a Cluster API management cluster",
	Long: LongDesc(`
		Get started with Cluster API using capioperator to create a management cluster,
		install providers, and create templates for your workload cluster.`),
	PersistentPostRunE: func(cmd *cobra.Command, args []string) error {
		return nil
	},
}

RootCmd is capioperator root CLI command.

Functions

func CheckDeploymentAvailability

func CheckDeploymentAvailability(ctx context.Context, client ctrlclient.Client, labels map[string]string) (bool, error)

CheckDeploymentAvailability checks if the deployment with given labels is available.

func CreateKubeClient

func CreateKubeClient(kubeconfigPath, kubeconfigContext string) (ctrlclient.Client, error)

CreateKubeClient creates a kubernetes client from provided kubeconfig and kubecontext.

func EnsureNamespaceExists

func EnsureNamespaceExists(ctx context.Context, client ctrlclient.Client, namespace string) error

func Examples

func Examples(s string) string

Examples normalizes a command's examples to follow the conventions.

func Execute

func Execute()

Execute executes the root command.

func GetDeploymentByLabels

func GetDeploymentByLabels(ctx context.Context, client ctrlclient.Client, labels map[string]string) (*appsv1.Deployment, error)

GetDeploymentByLabels fetches deployment based on the provided labels.

func GetKubeconfigLocation

func GetKubeconfigLocation() string

GetKubeconfigLocation will read the environment variable $KUBECONFIG otherwise set it to ~/.kube/config.

func GetLatestRelease

func GetLatestRelease(ctx context.Context, repo repository.Repository) (string, error)

GetLatestRelease returns the latest patch release.

func LongDesc

func LongDesc(s string) string

LongDesc normalizes a command's long description to follow the conventions.

func NewGenericProvider

func NewGenericProvider(providerType clusterctlv1.ProviderType) operatorv1.GenericProvider

Types

type DeleteGroup

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

type Version

type Version struct {
	ClientVersion *version.Info `json:"capioperator"`
}

Version provides the version information of CAPI operator.