v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the extensions v1alpha1 API group +kubebuilder:object:generate=true +groupName=extensions.hive.openshift.io

Index

• Constants
• Variables
• type BareMetalHostReference
  • func (in *BareMetalHostReference) DeepCopy() *BareMetalHostReference
  • func (in *BareMetalHostReference) DeepCopyInto(out *BareMetalHostReference)
• type ImageClusterInstall
  • func (in *ImageClusterInstall) DeepCopy() *ImageClusterInstall
  • func (in *ImageClusterInstall) DeepCopyInto(out *ImageClusterInstall)
  • func (in *ImageClusterInstall) DeepCopyObject() runtime.Object
  • func (r *ImageClusterInstall) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (r *ImageClusterInstall) ValidateCreate() (admission.Warnings, error)
  • func (r *ImageClusterInstall) ValidateDelete() (admission.Warnings, error)
  • func (r *ImageClusterInstall) ValidateUpdate(old runtime.Object) (admission.Warnings, error)
• type ImageClusterInstallList
  • func (in *ImageClusterInstallList) DeepCopy() *ImageClusterInstallList
  • func (in *ImageClusterInstallList) DeepCopyInto(out *ImageClusterInstallList)
  • func (in *ImageClusterInstallList) DeepCopyObject() runtime.Object
• type ImageClusterInstallSpec
  • func (in *ImageClusterInstallSpec) DeepCopy() *ImageClusterInstallSpec
  • func (in *ImageClusterInstallSpec) DeepCopyInto(out *ImageClusterInstallSpec)
• type ImageClusterInstallStatus
  • func (in *ImageClusterInstallStatus) DeepCopy() *ImageClusterInstallStatus
  • func (in *ImageClusterInstallStatus) DeepCopyInto(out *ImageClusterInstallStatus)
• type Proxy
  • func (in *Proxy) DeepCopy() *Proxy
  • func (in *Proxy) DeepCopyInto(out *Proxy)

Constants

const (
	Group   = "extensions.hive.openshift.io"
	Version = "v1alpha1"
)

const (
	ImageNotReadyReason = "NotReady"
	ImageReadyReason    = "Ready"
	ImageReadyMessage   = "Image is ready for use"

	HostConfiguraionFailedReason      = "HostConfigurationFailed"
	HostConfiguraionSucceededReason   = "HostConfigurationSucceeded"
	HostConfigurationSucceededMessage = "Configuration image is attached to the referenced host"

	InstallTimedoutReason  = "ClusterInstallationTimedOut"
	InstallTimedoutMessage = "Cluster installation is taking longer than expected"

	InstallInProgressReason  = "ClusterInstallationInProgress"
	InstallInProgressMessage = "Cluster installation is in progress"

	InstallSucceededReason  = "ClusterInstallationSucceeded"
	InstallSucceededMessage = "Cluster installation has succeeded"

	HostValidationFailedReason = "HostValidationFailed"
	HostValidationSucceeded    = "HostValidationSucceeded"
	HostValidationPending      = "HostValidationPending"
	HostValidationsOKMsg       = "The host's validations are passing and image is ready"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type BareMetalHostReference

type BareMetalHostReference struct {
	// Name identifies the BareMetalHost within a namespace
	Name string `json:"name"`
	// Namespace identifies the namespace containing the referenced BareMetalHost
	Namespace string `json:"namespace"`
}

func (*BareMetalHostReference) DeepCopy

func (in *BareMetalHostReference) DeepCopy() *BareMetalHostReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BareMetalHostReference.

func (*BareMetalHostReference) DeepCopyInto

func (in *BareMetalHostReference) DeepCopyInto(out *BareMetalHostReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ImageClusterInstall

type ImageClusterInstall struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ImageClusterInstallSpec   `json:"spec,omitempty"`
	Status ImageClusterInstallStatus `json:"status,omitempty"`
}

ImageClusterInstall is the Schema for the imageclusterinstall API

func (*ImageClusterInstall) DeepCopy

func (in *ImageClusterInstall) DeepCopy() *ImageClusterInstall

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageClusterInstall.

func (*ImageClusterInstall) DeepCopyInto

func (in *ImageClusterInstall) DeepCopyInto(out *ImageClusterInstall)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ImageClusterInstall) DeepCopyObject

func (in *ImageClusterInstall) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ImageClusterInstall) SetupWebhookWithManager

func (r *ImageClusterInstall) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*ImageClusterInstall) ValidateCreate

func (r *ImageClusterInstall) ValidateCreate() (admission.Warnings, error)

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*ImageClusterInstall) ValidateDelete

func (r *ImageClusterInstall) ValidateDelete() (admission.Warnings, error)

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*ImageClusterInstall) ValidateUpdate

func (r *ImageClusterInstall) ValidateUpdate(old runtime.Object) (admission.Warnings, error)

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type ImageClusterInstallList

type ImageClusterInstallList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ImageClusterInstall `json:"items"`
}

ImageClusterInstallList contains a list of ImageClusterInstall

func (*ImageClusterInstallList) DeepCopy

func (in *ImageClusterInstallList) DeepCopy() *ImageClusterInstallList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageClusterInstallList.

func (*ImageClusterInstallList) DeepCopyInto

func (in *ImageClusterInstallList) DeepCopyInto(out *ImageClusterInstallList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ImageClusterInstallList) DeepCopyObject

func (in *ImageClusterInstallList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ImageClusterInstallSpec

type ImageClusterInstallSpec struct {
	// ClusterDeploymentRef is a reference to the ClusterDeployment.
	// +optional
	ClusterDeploymentRef *corev1.LocalObjectReference `json:"clusterDeploymentRef"`

	// ImageSetRef is a reference to a ClusterImageSet.
	ImageSetRef hivev1.ClusterImageSetReference `json:"imageSetRef"`

	// ClusterMetadata contains metadata information about the installed cluster.
	// This must be set as soon as all the information is available.
	// +optional
	ClusterMetadata *hivev1.ClusterMetadata `json:"clusterMetadata"`

	// NodeIP is the desired IP for the host
	// +optional
	// Deprecated: this field is ignored (will be removed in a future release).
	NodeIP string `json:"nodeIP,omitempty"`

	// Hostname is the desired hostname for the host
	Hostname string `json:"hostname,omitempty"`

	// SSHKey is the public Secure Shell (SSH) key to provide access to
	// instances. Equivalent to install-config.yaml's sshKey.
	// This key will be added to the host to allow ssh access
	SSHKey string `json:"sshKey,omitempty"`

	// ImageDigestSources lists sources/repositories for the release-image content.
	// +optional
	ImageDigestSources []apicfgv1.ImageDigestMirrors `json:"imageDigestSources,omitempty"`

	// CABundle is a reference to a config map containing the new bundle of trusted certificates for the host.
	// The tls-ca-bundle.pem entry in the config map will be written to /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem
	CABundleRef *corev1.LocalObjectReference `json:"caBundleRef,omitempty"`

	// ExtraManifestsRefs is list of config map references containing additional manifests to be applied to the relocated cluster.
	// +optional
	ExtraManifestsRefs []corev1.LocalObjectReference `json:"extraManifestsRefs,omitempty"`

	// BareMetalHostRef identifies a BareMetalHost object to be used to attach the configuration to the host.
	// +optional
	BareMetalHostRef *BareMetalHostReference `json:"bareMetalHostRef,omitempty"`

	// MachineNetwork is the subnet provided by user for the ocp cluster.
	// This will be used to create the node network and choose ip address for the node.
	// Equivalent to install-config.yaml's machineNetwork.
	// +optional.
	MachineNetwork string `json:"machineNetwork,omitempty"`

	// Proxy defines the proxy settings to be applied in relocated cluster
	// +optional
	Proxy *Proxy `json:"proxy,omitempty"`
}

ImageClusterInstallSpec defines the desired state of ImageClusterInstall

func (*ImageClusterInstallSpec) DeepCopy

func (in *ImageClusterInstallSpec) DeepCopy() *ImageClusterInstallSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageClusterInstallSpec.

func (*ImageClusterInstallSpec) DeepCopyInto

func (in *ImageClusterInstallSpec) DeepCopyInto(out *ImageClusterInstallSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ImageClusterInstallStatus

type ImageClusterInstallStatus struct {
	// Conditions is a list of conditions associated with syncing to the cluster.
	// +optional
	Conditions []hivev1.ClusterInstallCondition `json:"conditions,omitempty"`

	// InstallRestarts is the total count of container restarts on the clusters install job.
	InstallRestarts int `json:"installRestarts,omitempty"`

	BareMetalHostRef *BareMetalHostReference `json:"bareMetalHostRef,omitempty"`

	// BootTime indicates the time at which the host was requested to boot. Used to determine install timeouts.
	BootTime metav1.Time `json:"bootTime,omitempty"`
}

ImageClusterInstallStatus defines the observed state of ImageClusterInstall

func (*ImageClusterInstallStatus) DeepCopy

func (in *ImageClusterInstallStatus) DeepCopy() *ImageClusterInstallStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImageClusterInstallStatus.

func (*ImageClusterInstallStatus) DeepCopyInto

func (in *ImageClusterInstallStatus) DeepCopyInto(out *ImageClusterInstallStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Proxy

type Proxy struct {
	// HTTPProxy is the URL of the proxy for HTTP requests.
	// +optional
	HTTPProxy string `json:"httpProxy,omitempty"`

	// HTTPSProxy is the URL of the proxy for HTTPS requests.
	// +optional
	HTTPSProxy string `json:"httpsProxy,omitempty"`

	// NoProxy is a comma-separated list of domains and CIDRs for which the proxy should not be
	// used.
	// +optional
	NoProxy string `json:"noProxy,omitempty"`
}

Proxy defines the proxy settings for the cluster. At least one of HTTPProxy or HTTPSProxy is required.

func (*Proxy) DeepCopy

func (in *Proxy) DeepCopy() *Proxy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Proxy.

func (*Proxy) DeepCopyInto

func (in *Proxy) DeepCopyInto(out *Proxy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.