v1beta1

Documentation

Overview

The package v1beta1 contains some API Schema definitions for the v1beta1 version of some Hypershift API group. https://github.com/openshift/hypershift does not put its API definitions in a submodule, so we took what we needed from https://github.com/openshift/hypershift/blob/main/api/v1beta1/hostedcluster_types.go to avoid having to import all of Hypershift. +kubebuilder:object:generate=true +groupName=hypershift.openshift.io

Index

• Constants
• Variables
• func HostedClusterNamespace(cluster HostedCluster) string
• type HostedCluster
  • func (in *HostedCluster) DeepCopy() *HostedCluster
  • func (in *HostedCluster) DeepCopyInto(out *HostedCluster)
  • func (in *HostedCluster) DeepCopyObject() runtime.Object
• type HostedClusterList
  • func (in *HostedClusterList) DeepCopy() *HostedClusterList
  • func (in *HostedClusterList) DeepCopyInto(out *HostedClusterList)
  • func (in *HostedClusterList) DeepCopyObject() runtime.Object
• type HostedClusterStatus
  • func (in *HostedClusterStatus) DeepCopy() *HostedClusterStatus
  • func (in *HostedClusterStatus) DeepCopyInto(out *HostedClusterStatus)

Constants

const (
	// HostedClusterAvailable indicates whether the HostedCluster has a healthy
	// control plane.
	HostedClusterAvailable = "Available"
)

More conditions at https://github.com/openshift/hypershift/blob/main/api/v1alpha1/conditions.go HostedCluster conditions.

Variables

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

	// 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
)

Functions

func HostedClusterNamespace

func HostedClusterNamespace(cluster HostedCluster) string

From https://github.com/openshift/hypershift/blob/ 9c3e998b0b37bedce07163a197e0bf30339e627e/hypershift-operator/ controllers/manifests/manifests.go#L13.

Types

type HostedCluster

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

	// Status is the latest observed status of the HostedCluster.
	Status HostedClusterStatus `json:"status,omitempty"`
}

HostedCluster is the primary representation of a HyperShift cluster and encapsulates the control plane and common data plane configuration. Creating a HostedCluster results in a fully functional OpenShift control plane with no attached nodes. To support workloads (e.g. pods), a HostedCluster may have one or more associated NodePool resources.

+kubebuilder:object:root=true

func (*HostedCluster) DeepCopy

func (in *HostedCluster) DeepCopy() *HostedCluster

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

func (*HostedCluster) DeepCopyInto

func (in *HostedCluster) DeepCopyInto(out *HostedCluster)

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

func (*HostedCluster) DeepCopyObject

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

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

type HostedClusterList

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

+kubebuilder:object:root=true HostedClusterList contains a list of HostedCluster.

func (*HostedClusterList) DeepCopy

func (in *HostedClusterList) DeepCopy() *HostedClusterList

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

func (*HostedClusterList) DeepCopyInto

func (in *HostedClusterList) DeepCopyInto(out *HostedClusterList)

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

func (*HostedClusterList) DeepCopyObject

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

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

type HostedClusterStatus

type HostedClusterStatus struct {
	// KubeConfig is a reference to the secret containing the default kubeconfig
	// for the cluster.
	// +optional
	KubeConfig *corev1.LocalObjectReference `json:"kubeconfig,omitempty"`

	// KubeadminPassword is a reference to the secret that contains the initial
	// kubeadmin user password for the guest cluster.
	// +optional
	KubeadminPassword *corev1.LocalObjectReference `json:"kubeadminPassword,omitempty"`

	// Conditions represents the latest available observations of a control
	// plane's current state.
	Conditions []metav1.Condition `json:"conditions"`
}

HostedClusterStatus is the latest observed status of a HostedCluster.

func (*HostedClusterStatus) DeepCopy

func (in *HostedClusterStatus) DeepCopy() *HostedClusterStatus

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

func (*HostedClusterStatus) DeepCopyInto

func (in *HostedClusterStatus) DeepCopyInto(out *HostedClusterStatus)

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