Parameters
The parent key for all of the following parameters is openshift_upgrade_controller
.
namespace
type |
string |
default |
|
The namespace in which to deploy this component.
namespaceMetadata
type |
dict |
default |
|
Metadata to be added to the namespace.
manifests_version
type |
string |
default |
|
The Git reference to the controller deployment manifests. The default is the tag of the controller image.
upgrade_configs
type |
dict |
default |
|
example |
|
This parameter is used to configure the UpgradeConfig
objects.
The dictionary key is used as the name of the UpgradeConfig
object.
The value is the configuration of the UpgradeConfig
object.
See github.com/appuio/openshift-upgrade-controller for the manifest definition.
upgrade_job_hooks
type |
dict |
default |
|
example |
|
This parameter is used to configure the UpgradeJobHooks
objects.
The dictionary key is used as the name of the UpgradeJobHooks
object.
The value is the configuration of the UpgradeJobHooks
object.
UpgradeJobHooks
default to priorityClassName: system-cluster-critical
.
See github.com/appuio/openshift-upgrade-controller for the manifest definition.
spec.selector can be referenced from the UpgradeConfig object using Commodore variable expansion.
|
upgrade_silence
type |
object |
default:: default |
Creates a pre-configured UpgradeJobHook
object to silence alerts given by alert_matchers
during the upgrade.
upgrade_silence.alertmanager_host
, upgrade_silence.alertmanager_operated_service
, upgrade_silence.alertmanager_namespace
type |
string |
default |
|
The host name, service name and namespace of the Alertmanager to use.
upgrade_silence.upgrade_job_selector
type |
dict |
default |
|
example |
|
Selects which UpgradeJob
objects this hook applies to.
upgrade_silence.alert_matchers
type |
dict |
default |
|
example |
|
Selects the alerts to silence. The dictionary key is added as a comment to the silence. The value is the configuration of the silence. List values are ANDed together, and multiple silence configurations are ORed together.
cluster_version.openshiftVersion
type |
object |
default |
|
This parameter is used to conditionally add configurations in the ClusterVersion
object.
The component currently uses this parameter to set default values for
* 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.
cluster_version.spec
type |
object |
default |
|
See the OpenShift docs for available parameters and values.
Field |
Values specified in this parameter take precedence over default values derived from parameter openshiftVersion
.
The desiredUpdate
field is removed from the ClusterVersion
object.
The desired update is determined by the controller based on the UpgradeConfig
and upstream ClusterVersion
objects.
Example
We recommend configuring a reference for component parameter openshift_upgrade_controller.cluster_version.spec.clusterID
for all OpenShift 4 clusters:
parameters:
openshift:
clusterID: 'OVERRIDE_THIS_IN_THE_CLUSTER_CONFIG'
openshift_upgrade_controller:
cluster_version:
spec:
clusterID: ${openshift.clusterID}
With this approach, each individual cluster config only needs to set generic parameter openshift.clusterID
.
parameters:
openshift:
clusterID: '6d8329e3-7098-4bab-b7d8-11f1dc353481'
openshift_upgrade_controller:
cluster_version:
spec: ...
This example assumes that |
alerts
type |
dict |
example |
|
alerts
defines the alerts to be installed.
The dictionary key is used as the name of the alert.
alerts.<name>.rule
type |
dict |
Holds the configuration of the alert rule.
See Prometheus Alerting Rules for details.