elemental-lifecycle-manager

Release API

The Release resource is the single point of entry for environment upgrades. It defines the desired state of an environment and provides upgrade-specific configuration. Elemental Lifecycle Manager (LCM) reconciles the cluster to match the state described by this resource.

Constraints

When defining a Release resource, LCM enforces the following constraints:

Only one Release resource can exist on a cluster.
Updates of an existing Release resource are only allowed when no upgrade is currently in progress.
Downgrades of an existing Release resource spec.version field are not allowed.

Spec

# Release resource example
apiVersion: lifecycle.suse.com/v1alpha1
kind: Release
metadata:
  name: release-example
spec:
  version: "1.0.0"
  registry: "registry.example.org/project/release-manifest"
  disableDrain: true
  componentConfiguration:
    helm:
    - chart: example
      values:
        replicaCount: 1
        resources:
          requests:
            cpu: 250m
            memory: 250Mi
      valuesFrom:
        secretRef:
          name: example-values-secret
          keys:
          - "values-example-chart"

Field	Description	Required
`spec.version`	Target version of the release. Use semantic versioning, when possible.	`true`
`spec.registry`	OCI registry from which LCM will fetch the release metadata. Metadata must be defined in the form of a release manifest.	`true`
`spec.disableDrain`	Disables node drains during upgrade phases. Defaults to `false`.	`false`
`spec.componentConfiguration.helm`	Provide configurations to Helm chart components specified in the release.	`false`

Component Configurations

IMPORTANT: Component configuration can only be done during a release version upgrade. Configuring components outside of a release version upgrade is not yet supported.

Helm

NOTE: The [*] prefix refers to an entry in the spec.componentConfiguration.helm configuration list.

Field	Description	Required
`[*].chart`	Reference to the chart in the release that will be configured.	`true`
`[*].values`	Custom Helm values configuration provided inline.	`false`
`[*].valuesFrom.secretRef`	Apply Helm values configuration provided from a Kubernetes Secret.	`false`
`[*].valuesFrom.secretRef.name`	Name of the secret from which to retrieve custom helm chart values. The secret must be located in the `kube-system` namespace.	`true`
`[*].valuesFrom.secretRef.keys`	Data entries containing the desired values as seen in the Secret.	`true`

NOTE: [*].valuesFrom takes precedence over [*].values definitions.

Status

Field	Description
`status.version`	The last release version to which the environment state was successfully upgraded.
`spec.conditions`	Information about the state of the currently running upgrade process.
`spec.disableDrain`	The latest resource generation observed by the controller. Meant for internal use only.

This site is open source. Improve this page.