kotsutil

Documentation

Index

• func EncodeIdentityConfig(spec kotsv1beta1.IdentityConfig) ([]byte, error)
• func EncodeIngressConfig(ingressConfig kotsv1beta1.IngressConfig) ([]byte, error)
• func FixUpYAML(inputContent []byte) ([]byte, error)
• func GetIncompatbileKotsVersionMessage(kotsApplication kotsv1beta1.Application, isInstall bool) string
• func GetKurlRegistryCreds() (hostname string, username string, password string, finalErr error)
• func GetKurlS3Secret() (*corev1.Secret, error)
• func IsKotsAutoUpgradeSupported(app *kotsv1beta1.Application) bool
• func IsKotsVersionCompatibleWithApp(kotsApplication kotsv1beta1.Application, isInstall bool) bool
• func IsKurl(clientset kubernetes.Interface) bool
• func LoadBackupFromContents(content []byte) (*velerov1.Backup, error)
• func LoadConfigFromBytes(data []byte) (*kotsv1beta1.Config, error)
• func LoadConfigValuesFromFile(configValuesFilePath string) (*kotsv1beta1.ConfigValues, error)
• func LoadHelmChartsFromPath(fromDir string) ([]*kotsv1beta1.HelmChart, error)
• func LoadIdentityConfigFromContents(content []byte) (*kotsv1beta1.IdentityConfig, error)
• func LoadIdentityFromContents(content []byte) (*kotsv1beta1.Identity, error)
• func LoadIngressConfigFromContents(content []byte) (*kotsv1beta1.IngressConfig, error)
• func LoadInstallationFromContents(installationData []byte) (*kotsv1beta1.Installation, error)
• func LoadInstallationFromPath(installationFilePath string) (*kotsv1beta1.Installation, error)
• func LoadKotsAppFromContents(data []byte) (*kotsv1beta1.Application, error)
• func LoadLicenseFromBytes(data []byte) (*kotsv1beta1.License, error)
• func LoadLicenseFromPath(licenseFilePath string) (*kotsv1beta1.License, error)
• func LoadPreflightFromContents(content []byte) (*troubleshootv1beta2.Preflight, error)
• func LoadSupportBundleFromContents(data []byte) (*troubleshootv1beta2.SupportBundle, error)
• func SupportBundleToAnalyzer(sb *troubleshootv1beta2.SupportBundle) *troubleshootv1beta2.Analyzer
• func SupportBundleToCollector(sb *troubleshootv1beta2.SupportBundle) *troubleshootv1beta2.Collector
• type InstallationParams
  • func GetInstallationParams(configMapName string) (InstallationParams, error)
• type KotsKinds
  • func EmptyKotsKinds() KotsKinds
  • func LoadKotsKindsFromPath(fromDir string) (*KotsKinds, error)
  • func (k *KotsKinds) DecryptConfigValues() error
  • func (k *KotsKinds) EncryptConfigValues() error
  • func (k KotsKinds) GetKustomizeBinaryPath() string
  • func (k *KotsKinds) HasPreflights() bool
  • func (k *KotsKinds) IsConfigurable() bool
  • func (o KotsKinds) Marshal(g string, v string, k string) (string, error)

Functions

func EncodeIdentityConfig

func EncodeIdentityConfig(spec kotsv1beta1.IdentityConfig) ([]byte, error)

func EncodeIngressConfig

func EncodeIngressConfig(ingressConfig kotsv1beta1.IngressConfig) ([]byte, error)

func FixUpYAML

func FixUpYAML(inputContent []byte) ([]byte, error)

FixUpYAML is a general purpose function that will ensure that YAML is compatible with KOTS This ensures that lines aren't wrapped at 80 chars which breaks template functions

func GetIncompatbileKotsVersionMessage

func GetIncompatbileKotsVersionMessage(kotsApplication kotsv1beta1.Application, isInstall bool) string

func GetKurlRegistryCreds

func GetKurlRegistryCreds() (hostname string, username string, password string, finalErr error)

func GetKurlS3Secret

func GetKurlS3Secret() (*corev1.Secret, error)

func IsKotsAutoUpgradeSupported

func IsKotsAutoUpgradeSupported(app *kotsv1beta1.Application) bool

func IsKotsVersionCompatibleWithApp

func IsKotsVersionCompatibleWithApp(kotsApplication kotsv1beta1.Application, isInstall bool) bool

func IsKurl

func IsKurl(clientset kubernetes.Interface) bool

func LoadBackupFromContents

func LoadBackupFromContents(content []byte) (*velerov1.Backup, error)

func LoadConfigFromBytes

func LoadConfigFromBytes(data []byte) (*kotsv1beta1.Config, error)

func LoadConfigValuesFromFile

func LoadConfigValuesFromFile(configValuesFilePath string) (*kotsv1beta1.ConfigValues, error)

func LoadHelmChartsFromPath

func LoadHelmChartsFromPath(fromDir string) ([]*kotsv1beta1.HelmChart, error)

func LoadIdentityConfigFromContents

func LoadIdentityConfigFromContents(content []byte) (*kotsv1beta1.IdentityConfig, error)

func LoadIdentityFromContents

func LoadIdentityFromContents(content []byte) (*kotsv1beta1.Identity, error)

func LoadIngressConfigFromContents

func LoadIngressConfigFromContents(content []byte) (*kotsv1beta1.IngressConfig, error)

func LoadInstallationFromContents

func LoadInstallationFromContents(installationData []byte) (*kotsv1beta1.Installation, error)

func LoadInstallationFromPath

func LoadInstallationFromPath(installationFilePath string) (*kotsv1beta1.Installation, error)

func LoadKotsAppFromContents

func LoadKotsAppFromContents(data []byte) (*kotsv1beta1.Application, error)

func LoadLicenseFromBytes

func LoadLicenseFromBytes(data []byte) (*kotsv1beta1.License, error)

func LoadLicenseFromPath

func LoadLicenseFromPath(licenseFilePath string) (*kotsv1beta1.License, error)

func LoadPreflightFromContents

func LoadPreflightFromContents(content []byte) (*troubleshootv1beta2.Preflight, error)

func LoadSupportBundleFromContents

func LoadSupportBundleFromContents(data []byte) (*troubleshootv1beta2.SupportBundle, error)

func SupportBundleToAnalyzer

func SupportBundleToAnalyzer(sb *troubleshootv1beta2.SupportBundle) *troubleshootv1beta2.Analyzer

func SupportBundleToCollector

func SupportBundleToCollector(sb *troubleshootv1beta2.SupportBundle) *troubleshootv1beta2.Collector

Types

type InstallationParams

type InstallationParams struct {
	KotsadmRegistry        string
	SkipImagePush          bool
	SkipPreflights         bool
	SkipCompatibilityCheck bool
	RegistryIsReadOnly     bool
	EnableImageDeletion    bool
}

func GetInstallationParams

func GetInstallationParams(configMapName string) (InstallationParams, error)

type KotsKinds

type KotsKinds struct {
	KotsApplication kotsv1beta1.Application
	Application     *applicationv1beta1.Application
	HelmCharts      []*kotsv1beta1.HelmChart

	Collector     *troubleshootv1beta2.Collector
	Preflight     *troubleshootv1beta2.Preflight
	Analyzer      *troubleshootv1beta2.Analyzer
	SupportBundle *troubleshootv1beta2.SupportBundle
	Redactor      *troubleshootv1beta2.Redactor

	Config       *kotsv1beta1.Config
	ConfigValues *kotsv1beta1.ConfigValues

	Installation kotsv1beta1.Installation
	License      *kotsv1beta1.License

	Identity       *kotsv1beta1.Identity
	IdentityConfig *kotsv1beta1.IdentityConfig

	Backup *velerov1.Backup
}

KotsKinds are all of the special "client-side" kinds that are packaged in an application. These should be pointers because they are all optional. But a few are still expected in the code later, so we make them not pointers, because other codepaths expect them to be present

func EmptyKotsKinds

func EmptyKotsKinds() KotsKinds

create a new kots kinds, ensuring that the require objets exist as empty defaults

func LoadKotsKindsFromPath

func LoadKotsKindsFromPath(fromDir string) (*KotsKinds, error)

func (*KotsKinds) DecryptConfigValues

func (k *KotsKinds) DecryptConfigValues() error

func (*KotsKinds) EncryptConfigValues

func (k *KotsKinds) EncryptConfigValues() error

func (KotsKinds) GetKustomizeBinaryPath

func (k KotsKinds) GetKustomizeBinaryPath() string

GetKustomizeBinaryPath will return the kustomize binary version to use for this application applying the default, if there is one, for the current version of kots

func (*KotsKinds) HasPreflights

func (k *KotsKinds) HasPreflights() bool

func (*KotsKinds) IsConfigurable

func (k *KotsKinds) IsConfigurable() bool

func (KotsKinds) Marshal

func (o KotsKinds) Marshal(g string, v string, k string) (string, error)