install

Documentation

Index

• Constants
• func NewDeploymentMutator(values *Values) resources.Mutator[*appsv1.Deployment]
• func NewJobMutator(values *Values, deploymentSpec *v1alpha1.DeploymentSpec, ...) resources.Mutator[*v1.Job]
• type Installer
  • func (a *Installer) CheckProviderReadiness(ctx context.Context) readiness.CheckResult
  • func (a *Installer) InstallInitJob(ctx context.Context) (completed bool, err error)
  • func (a *Installer) InstallProvider(ctx context.Context) error
  • func (a *Installer) UninstallProvider(ctx context.Context) (deleted bool, err error)
• type Values
  • func NewValues(provider *unstructured.Unstructured, deploymentSpec *v1alpha1.DeploymentSpec, ...) *Values
  • func (v *Values) ClusterScopedDefaultResourceName() string
  • func (v *Values) ClusterScopedResourceName(suffix string) string
  • func (v *Values) Environment() string
  • func (v *Values) EnvironmentVariables() ([]corev1.EnvVar, error)
  • func (v *Values) Image() string
  • func (v *Values) ImagePullSecrets() []corev1.LocalObjectReference
  • func (v *Values) LabelsCommon() map[string]string
  • func (v *Values) LabelsController() map[string]string
  • func (v *Values) LabelsInitJob() map[string]string
  • func (v *Values) Namespace() string
  • func (v *Values) NamespacedDefaultResourceName() string
  • func (v *Values) NamespacedResourceName(suffix string) string
  • func (v *Values) Verbosity() string

Constants

const (
	ProviderNameLabel       = "openmcp.cloud/provider-name"
	ProviderKindLabel       = "openmcp.cloud/provider-kind"
	ProviderGenerationLabel = "openmcp.cloud/provider-generation"
)

Functions

func NewDeploymentMutator

func NewDeploymentMutator(values *Values) resources.Mutator[*appsv1.Deployment]

func NewJobMutator

func NewJobMutator(values *Values, deploymentSpec *v1alpha1.DeploymentSpec, annotations map[string]string) resources.Mutator[*v1.Job]

Types

type Installer

type Installer struct {
	PlatformClient client.Client
	Provider       *unstructured.Unstructured
	DeploymentSpec *v1alpha1.DeploymentSpec
	Environment    string
}

func (*Installer) CheckProviderReadiness

func (a *Installer) CheckProviderReadiness(ctx context.Context) readiness.CheckResult

func (*Installer) InstallInitJob

func (a *Installer) InstallInitJob(ctx context.Context) (completed bool, err error)

InstallInitJob installs the init job of a provider. Does nothing if the generation has not changed. Otherwise, it deletes the old job before it creates the new job. Adds provider generation as annotation to the job.

func (*Installer) InstallProvider

func (a *Installer) InstallProvider(ctx context.Context) error

func (*Installer) UninstallProvider

func (a *Installer) UninstallProvider(ctx context.Context) (deleted bool, err error)

type Values

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

func NewValues

func NewValues(provider *unstructured.Unstructured, deploymentSpec *v1alpha1.DeploymentSpec, environment string) *Values

func (*Values) ClusterScopedDefaultResourceName

func (v *Values) ClusterScopedDefaultResourceName() string

func (*Values) ClusterScopedResourceName

func (v *Values) ClusterScopedResourceName(suffix string) string

func (*Values) Environment

func (v *Values) Environment() string

func (*Values) EnvironmentVariables

func (v *Values) EnvironmentVariables() ([]corev1.EnvVar, error)

EnvironmentVariables returns the environment variables set in the provider resource, enriched by the following: - OPENMCP_PROVIDER_NAME: the name of the provider resource, - OPENMCP_PROVIDER_NAMESPACE: the namespace in which the provider will be deployed.

func (*Values) Image

func (v *Values) Image() string

func (*Values) ImagePullSecrets

func (v *Values) ImagePullSecrets() []corev1.LocalObjectReference

func (*Values) LabelsCommon

func (v *Values) LabelsCommon() map[string]string

func (*Values) LabelsController

func (v *Values) LabelsController() map[string]string

func (*Values) LabelsInitJob

func (v *Values) LabelsInitJob() map[string]string

func (*Values) Namespace

func (v *Values) Namespace() string

func (*Values) NamespacedDefaultResourceName

func (v *Values) NamespacedDefaultResourceName() string

func (*Values) NamespacedResourceName

func (v *Values) NamespacedResourceName(suffix string) string

func (*Values) Verbosity

func (v *Values) Verbosity() string