controllers

Documentation

Overview

Copyright 2025 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2024 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func InitInfraMachineAndInfraClusterFromProvider(platform configv1.PlatformType) (client.Object, client.Object, error)
• func InitInfraMachineTemplateAndInfraClusterFromProvider(platform configv1.PlatformType) (client.Object, client.Object, error)

Constants

const (
	// DefaultManagedNamespace is the default namespace where the operator
	// manages CAPI resources.
	DefaultManagedNamespace = "openshift-cluster-api"

	// DefaultMAPIManagedNamespace the default namespace where the operator
	// manages MAPI resources.
	DefaultMAPIManagedNamespace = "openshift-machine-api"

	// OperatorVersionKey is the key used to store the operator version in the ClusterOperator status.
	OperatorVersionKey = "operator"

	// ClusterOperatorName is the name of the ClusterOperator resource.
	ClusterOperatorName = "cluster-api"

	// InfrastructureResourceName is the name of the cluster global infrastructure resource.
	InfrastructureResourceName = "cluster"

	// SynchronizedCondition is used to denote when a MAPI or CAPI resource is
	// synchronized. This condition should only be true when a synchronization
	// controller has successfully synchronized a non-authoritative resource.
	SynchronizedCondition machinev1beta1.ConditionType = "Synchronized"

	// ReasonResourceSynchronized denotes that the resource is synchronized
	// successfully.
	ReasonResourceSynchronized = "ResourceSynchronized"

	// ReasonAuthoritativeAPIChanged indicates that sync state is stale due to a change of authoritativeAPI.
	ReasonAuthoritativeAPIChanged = "AuthoritativeAPIChanged"

	// MachineSetOpenshiftLabelKey is the key for label referring to a Machine API MachineSet.
	MachineSetOpenshiftLabelKey = "machine.openshift.io/cluster-api-machineset"
)

Variables

var (

	// ErrInvalidSpecAuthoritativeAPI is returned when spec.authoritativeAPI has a value which is not permitted.
	ErrInvalidSpecAuthoritativeAPI = errors.New("invalid spec.authoritativeAPI")
)

Functions

func InitInfraMachineAndInfraClusterFromProvider

func InitInfraMachineAndInfraClusterFromProvider(platform configv1.PlatformType) (client.Object, client.Object, error)

InitInfraMachineAndInfraClusterFromProvider returns the correct InfraMachine and InfraCluster implementation for a given provider.

As we implement other cloud providers, we'll need to update this list.

func InitInfraMachineTemplateAndInfraClusterFromProvider

func InitInfraMachineTemplateAndInfraClusterFromProvider(platform configv1.PlatformType) (client.Object, client.Object, error)

InitInfraMachineTemplateAndInfraClusterFromProvider returns the correct InfraMachineTemplate and InfraCluster implementation for a given provider.

As we implement other cloud providers, we'll need to update this list.