rancher
/
elemental-docs
mirror of https://github.com/rancher/elemental-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
elemental-docs/docs/managedosversionchannel-ref...

3.3 KiB
Raw Permalink Blame History

sidebar_label title
ManagedOSVersionChannel reference
<head> </head>

ManagedOSVersionChannel reference

The ManagedOSVersionChannel resource is responsible of defining OS image channels which embed information about ready to use OS and ISO images.

The ManagedOSVersionChannel is digested by the elemental-operator to produce a set of ManagedOSVersion resources, which are used for building installation images and to perform OS upgrades.

See Operator/Channels for more details.

There are several keys that can be configured under a ManagedOSVersionChannel resource spec.

apiVersion: elemental.cattle.io/v1beta1
kind: ManagedOSVersionChannel
metadata:
  name: elemental-channel
  namespace: fleet-default
spec:
  options:
    image: registry.suse.com/rancher/elemental-channel:1.4.2
  registry: priv-registry.local
  syncInterval: 1h
  type: custom

ManagedOSVersionChannelSpec reference

Key Type Default value Description
deleteNoLongerInSyncVersions bool false Automatically delete deprecated OS versions that are no longer included in the channel
enabled bool true Enables this channel. Allowing syncing of OS versions.
options object null Defines the optional information that can be added in an OS channel
registry string empty Registry prepended to all the embedded URIs during ManagedOSVersion resource generation
syncInterval string 1h Defines when to sync the OS channel
type string empty Defines the channel type, only custom is supported now
upgradeContainer object null An upgrade container that can be defined. See reference

registry

When set, the value is prepended to all the embedded OS and ISO URLs found in the channel to form the actual ManagedOSVersion resources. This makes the airgap setup easier, as the channel image can be used as is (while the actual OS and ISO images should still be extracted and loaded on the private registry).

upgradeContainer

This allows to overwrite the default upgrade field of System Upgrade Controller plans (see upgrade components) based on this ManagedOSVersion. These keys are translated by the System Upgrade Controller to a Kubernetes container specification. This is the container responsible of running an OS upgrade.