Parameters

The parent key for all of the following parameters is openshift4_version.

`openshiftVersion`

type	object
default	`Major: '4' Minor: '8'`

This parameter is used to conditionally add configurations in the ClusterVersion object.

The component currently uses this parameter to set default values for * field capabilities.baselineCapabilitySet, which was introduced in OpenShift 4.11. The component defaults this field to v4.11. * field channel. The component sets this field to stable-<Major>.<Minor>, where <Major> and <Minor> are replaced with the values of fields Major and Minor of this parameter.

`spec`

type	object
default	`upstream: https://api.openshift.com/api/upgrades_info/v1/graph`

See the OpenShift docs for available parameters and values.

Field clusterID must be set in the ClusterVersion object. The value for this field is supposed to be extracted from the cluster as a fact. However, the corresponding dynamic fact isn’t implemented yet. We recommend that users set spec.clusterID to a non-component parameter such as openshift.clusterID in the config hierarchy.

Values specified in this parameter take precedence over default values derived from parameter openshiftVersion.

`images`

type	dict
default	See `class/defaults.yml` on Github

This parameter allows selecting the Docker images to use for the job making the cluster version unmanaged. Each image is specified using keys registry, image and tag. This structure allows easily injecting a registry mirror, if required.

Example

We recommend configuring a reference for component parameter openshift4_version.spec.clusterID for all OpenShift 4 clusters:

openshift4.yml

parameters:
  openshift:
    clusterID: 'OVERRIDE_THIS_IN_THE_CLUSTER_CONFIG'
  openshift4_version:
    spec:
      clusterID: ${openshift.clusterID}

With this approach, each individual cluster config only needs to set generic parameter openshift.clusterID.

cluster.yml

parameters:
  openshift:
    clusterID: '6d8329e3-7098-4bab-b7d8-11f1dc353481'

  openshift4_version:
    spec:
      desiredUpdate:
        force: false
        image: quay.io/openshift-release-dev/ocp-release@sha256:7613d8f7db639147b91b16b54b24cfa351c3cbde6aa7b7bf1b9c80c260efad06
        version: 4.4.6

This example assumes that openshift4_version.spec.clusterID is set to ${openshift.clusterID} somewhere in the inventory. Due to github.com/projectsyn/commodore/issues/138, this can not yet be done in the defaults.