managementcomponents

Documentation

Overview

Package managementcomponents implements management component installation helpers

Index

• func GetTKGPackageConfigValuesFileFromUserConfig(managementPackageVersion string, ...) (string, error)
• func InstallKappController(clusterClient clusterclient.Client, ...) error
• func InstallManagementComponents(mcip *ManagementComponentsInstallOptions) error
• func InstallManagementPackages(pkgClient tkgpackageclient.TKGPackageClient, ...) error
• func WaitForManagementPackages(clusterClient clusterclient.Client, packageInstallTimeout time.Duration) error
• type AddonsFeatureGates
• type AddonsManagerPackageValues
• type CLIPluginsPackageValues
• type ClusterClassInfraPackageValues
• type ClusterClassPackage
• type ClusterOptions
• type CoreManagementPluginsPackage
• type CoreManagementPluginsPackageValue
• type FeaturegatePackageValues
• type FrameworkPackage
• type KappControllerOptions
• type ManagementComponentsInstallOptions
• type ManagementPackageRepositoryOptions
• type Metadata
• type TKGPackageConfig
• type TKRServicePackageValues
• type TKRSourceControllerPackage
• type TKRSourceControllerPackageValues
• type TanzuAddonsManager
• type TanzuAuthPackageValues

Functions

func GetTKGPackageConfigValuesFileFromUserConfig

func GetTKGPackageConfigValuesFileFromUserConfig(managementPackageVersion string, userProviderConfigValues map[string]interface{}, tkgBomConfig *tkgconfigbom.BOMConfiguration) (string, error)

GetTKGPackageConfigValuesFileFromUserConfig returns values file from user configuration

func InstallKappController

func InstallKappController(clusterClient clusterclient.Client, kappControllerOptions KappControllerOptions) error

InstallKappController installs kapp-controller to the cluster

func InstallManagementComponents

func InstallManagementComponents(mcip *ManagementComponentsInstallOptions) error

InstallManagementComponents installs the management component to cluster

func InstallManagementPackages

func InstallManagementPackages(pkgClient tkgpackageclient.TKGPackageClient, mpro ManagementPackageRepositoryOptions) error

InstallManagementPackages installs TKG management packages to the cluster

func WaitForManagementPackages

func WaitForManagementPackages(clusterClient clusterclient.Client, packageInstallTimeout time.Duration) error

Types

type AddonsFeatureGates

type AddonsFeatureGates struct {
	ClusterBootstrapController bool `yaml:"clusterBootstrapController,omitempty"`
	PackageInstallStatus       bool `yaml:"packageInstallStatus,omitempty"`
}

type AddonsManagerPackageValues

type AddonsManagerPackageValues struct {
	VersionConstraints string             `yaml:"versionConstraints,omitempty"`
	TanzuAddonsManager TanzuAddonsManager `yaml:"tanzuAddonsManager,omitempty"`
}

type CLIPluginsPackageValues

type CLIPluginsPackageValues struct {
	Namespace          string `yaml:"namespace,omitempty"`
	CreateNamespace    string `yaml:"createNamespace,omitempty"`
	VersionConstraints string `yaml:"versionConstraints,omitempty"`
}

type ClusterClassInfraPackageValues

type ClusterClassInfraPackageValues struct {
	Namespace          string `yaml:"namespace,omitempty"`
	CreateNamespace    string `yaml:"createNamespace,omitempty"`
	VersionConstraints string `yaml:"versionConstraints,omitempty"`
}

type ClusterClassPackage

type ClusterClassPackage struct {
	NamespaceForPackageInstallation string                         `yaml:"namespaceForPackageInstallation,omitempty"`
	VersionConstraints              string                         `yaml:"versionConstraints,omitempty"`
	ClusterClassInfraPackageValues  ClusterClassInfraPackageValues `yaml:"clusterclassInfraPackageValues,omitempty"`
}

type ClusterOptions

type ClusterOptions struct {
	Kubeconfig  string
	Kubecontext string
}

ClusterOptions specifies cluster configuration

type CoreManagementPluginsPackage

type CoreManagementPluginsPackage struct {
	NamespaceForPackageInstallation   string                            `yaml:"namespaceForPackageInstallation,omitempty"`
	VersionConstraints                string                            `yaml:"versionConstraints,omitempty"`
	CoreManagementPluginsPackageValue CoreManagementPluginsPackageValue `yaml:"clusterclassInfraPackageValues,omitempty"`
}

type CoreManagementPluginsPackageValue

type CoreManagementPluginsPackageValue struct {
	DeployCLIPluginCRD bool `yaml:"deployCLIPluginCRD,omitempty"`
}

type FeaturegatePackageValues

type FeaturegatePackageValues struct {
	Namespace          string `yaml:"namespace,omitempty"`
	CreateNamespace    string `yaml:"createNamespace,omitempty"`
	VersionConstraints string `yaml:"versionConstraints,omitempty"`
}

type FrameworkPackage

type FrameworkPackage struct {
	NamespaceForPackageInstallation string                     `yaml:"namespaceForPackageInstallation,omitempty"`
	VersionConstraints              string                     `yaml:"versionConstraints,omitempty"`
	FeaturegatePackageValues        FeaturegatePackageValues   `yaml:"featureGatesPackageValues,omitempty"`
	TKRServicePackageValues         TKRServicePackageValues    `yaml:"tkrServicePackageValues,omitempty"`
	CLIPluginsPackageValues         CLIPluginsPackageValues    `yaml:"clipluginsPackageValues,omitempty"`
	AddonsManagerPackageValues      AddonsManagerPackageValues `yaml:"addonsManagerPackageValues,omitempty"`
	TanzuAuthPackageValues          TanzuAuthPackageValues     `yaml:"tanzuAuthPackageValues,omitempty"`
}

type KappControllerOptions

type KappControllerOptions struct {
	KappControllerConfigFile       string
	KappControllerInstallNamespace string
}

KappControllerOptions specifies kapp-controller deployment options

type ManagementComponentsInstallOptions

type ManagementComponentsInstallOptions struct {
	ClusterOptions                     ClusterOptions
	ManagementPackageRepositoryOptions ManagementPackageRepositoryOptions
}

ManagementComponentsInstallOptions specifies install options for management components

type ManagementPackageRepositoryOptions

type ManagementPackageRepositoryOptions struct {
	ManagementPackageRepoImage string
	TKGPackageValuesFile       string
	PackageVersion             string
	PackageInstallTimeout      time.Duration
}

ManagementPackageRepositoryOptions specifies management package repository deployment options

type Metadata

type Metadata struct {
	InfraProvider string `yaml:"infraProvider"`
}

Metadata specifies metadata as part of TKG package config

type TKGPackageConfig

type TKGPackageConfig struct {
	Metadata                     Metadata                     `yaml:"metadata"`
	ConfigValues                 map[string]interface{}       `yaml:"configvalues"`
	FrameworkPackage             FrameworkPackage             `yaml:"frameworkPackage"`
	ClusterClassPackage          ClusterClassPackage          `yaml:"clusterclassPackage"`
	TKRSourceControllerPackage   TKRSourceControllerPackage   `yaml:"tkrSourceControllerPackage"`
	CoreManagementPluginsPackage CoreManagementPluginsPackage `yaml:"coreManagementPluginsPackage"`
}

TKGPackageConfig defines TKG package configuration

type TKRServicePackageValues

type TKRServicePackageValues struct {
	Namespace          string `yaml:"namespace,omitempty"`
	CreateNamespace    string `yaml:"createNamespace,omitempty"`
	VersionConstraints string `yaml:"versionConstraints,omitempty"`
}

type TKRSourceControllerPackage

type TKRSourceControllerPackage struct {
	NamespaceForPackageInstallation  string                           `yaml:"namespaceForPackageInstallation,omitempty"`
	VersionConstraints               string                           `yaml:"versionConstraints,omitempty"`
	TKRSourceControllerPackageValues TKRSourceControllerPackageValues `yaml:"tkrSourceControllerPackageValues,omitempty"`
}

type TKRSourceControllerPackageValues

type TKRSourceControllerPackageValues struct {
	Namespace            string `yaml:"namespace,omitempty"`
	CreateNamespace      string `yaml:"createNamespace,omitempty"`
	VersionConstraints   string `yaml:"versionConstraints,omitempty"`
	BomImagePath         string `yaml:"bomImagePath,omitempty"`
	BomMetadataImagePath string `yaml:"bomMetadataImagePath,omitempty"`
	TKRRepoImagePath     string `yaml:"tkrRepoImagePath,omitempty"`
	DefaultCompatibleTKR string `yaml:"defaultCompatibleTKR,omitempty"`
}

type TanzuAddonsManager

type TanzuAddonsManager struct {
	FeatureGates AddonsFeatureGates `yaml:"featureGates,omitempty"`
}

type TanzuAuthPackageValues

type TanzuAuthPackageValues struct {
	Namespace          string `yaml:"namespace,omitempty"`
	CreateNamespace    string `yaml:"createNamespace,omitempty"`
	VersionConstraints string `yaml:"versionConstraints,omitempty"`
}