tkgconfighelper

Documentation

Overview

Package tkgconfighelper provides various helpers and utilities

Index

• Variables
• func GetDefaultOsOptions(providerType string) tkgconfigbom.OSInfo
• func GetDefaultOsOptionsForTKG12(providerType string) tkgconfigbom.OSInfo
• func GetIntegerVariableFromConfig(variable string, ...) (int, error)
• func GetOSOptionsForProviders(providerType string, ...) tkgconfigbom.OSInfo
• func GetUserProvidedOsOptions(tkgConfigReaderWriter tkgconfigreaderwriter.TKGConfigReaderWriter) tkgconfigbom.OSInfo
• func IsCustomRepository(imageRepo string) bool
• func SelectAWSImageBasedonOSOptions(amis []tkgconfigbom.AMIInfo, ...) *tkgconfigbom.AMIInfo
• func SelectAzureImageBasedonOSOptions(azureImages []tkgconfigbom.AzureInfo, ...) *tkgconfigbom.AzureInfo
• func SelectTemplateForVsphereProviderBasedonOSOptions(vms []*types.VSphereVirtualMachine, ...) *types.VSphereVirtualMachine
• func SkipImageReferenceUpdateOnUpgrade() bool
• func ValidateK8sVersionSupport(mgmtClusterTkgVersion, kubernetesVersion string) error

Variables

var ManagementClusterVersionToK8sVersionSupportMatrix = map[string][]string{
	"v1.0": {"v1.17"},
	"v1.1": {"v1.17", "v1.18"},
	"v1.2": {"v1.17", "v1.18", "v1.19"},
	"v1.3": {"v1.17", "v1.18", "v1.19", "v1.20"},
	"v1.4": {"v1.17", "v1.18", "v1.19", "v1.20", "v1.21"},
	"v1.5": {"v1.19", "v1.20", "v1.21", "v1.22"},
	"v1.6": {"v1.20", "v1.21", "v1.22", "v1.23"},
	"v1.7": {"v1.21", "v1.22", "v1.23", "v1.24"},
}

ManagementClusterVersionToK8sVersionSupportMatrix defines the support matrix of which k8s version are supported based on management cluster version

Functions

func GetDefaultOsOptions

func GetDefaultOsOptions(providerType string) tkgconfigbom.OSInfo

GetDefaultOsOptions returns default OS option based on providerType

func GetDefaultOsOptionsForTKG12

func GetDefaultOsOptionsForTKG12(providerType string) tkgconfigbom.OSInfo

GetDefaultOsOptionsForTKG12 returns default OS option based on providerType

func GetIntegerVariableFromConfig

func GetIntegerVariableFromConfig(variable string, tkgConfigReaderWriter tkgconfigreaderwriter.TKGConfigReaderWriter) (int, error)

GetIntegerVariableFromConfig returns integer variable from config file

func GetOSOptionsForProviders

func GetOSOptionsForProviders(providerType string, tkgConfigReaderWriter tkgconfigreaderwriter.TKGConfigReaderWriter) tkgconfigbom.OSInfo

GetOSOptionsForProviders returns OS options for the providers If user has configured any options, it will have higher precedence user provided settings gets merged with default OS options for the given provider

func GetUserProvidedOsOptions

func GetUserProvidedOsOptions(tkgConfigReaderWriter tkgconfigreaderwriter.TKGConfigReaderWriter) tkgconfigbom.OSInfo

GetUserProvidedOsOptions returns user provided os options

func IsCustomRepository

func IsCustomRepository(imageRepo string) bool

IsCustomRepository is custom image repository

func SelectAWSImageBasedonOSOptions

func SelectAWSImageBasedonOSOptions(amis []tkgconfigbom.AMIInfo, tkgConfigReaderWriter tkgconfigreaderwriter.TKGConfigReaderWriter) *tkgconfigbom.AMIInfo

SelectAWSImageBasedonOSOptions selects template among all for azure images

func SelectAzureImageBasedonOSOptions

func SelectAzureImageBasedonOSOptions(azureImages []tkgconfigbom.AzureInfo, tkgConfigReaderWriter tkgconfigreaderwriter.TKGConfigReaderWriter) *tkgconfigbom.AzureInfo

SelectAzureImageBasedonOSOptions selects template among all for azure images

func SelectTemplateForVsphereProviderBasedonOSOptions

func SelectTemplateForVsphereProviderBasedonOSOptions(vms []*types.VSphereVirtualMachine, tkgConfigReaderWriter tkgconfigreaderwriter.TKGConfigReaderWriter) *types.VSphereVirtualMachine

SelectTemplateForVsphereProviderBasedonOSOptions selects template among all for vsphere provider

func SkipImageReferenceUpdateOnUpgrade

func SkipImageReferenceUpdateOnUpgrade() bool

SkipImageReferenceUpdateOnUpgrade returns true if environment variable is set

func ValidateK8sVersionSupport

func ValidateK8sVersionSupport(mgmtClusterTkgVersion, kubernetesVersion string) error

ValidateK8sVersionSupport validates the k8s version is supported on management cluster or not