Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io
Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/cluster-api/pkg/apis/cluster +k8s:defaulter-gen=TypeMeta +groupName=cluster.k8s.io
Index ¶
Constants ¶
const ClusterFinalizer = "cluster.cluster.k8s.io"
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: "cluster.k8s.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme adds registered types to the builder. // Required by pkg/client/... // TODO(pwittrock): Remove this after removing pkg/client/... AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Required by pkg/client/listers/... TODO(pwittrock): Remove this after removing pkg/client/...
Types ¶
type APIEndpoint ¶
type APIEndpoint struct { // The hostname on which the API server is serving. Host string `json:"host"` // The port on which the API server is serving. Port int `json:"port"` }
/ APIEndpoint APIEndpoint represents a reachable Kubernetes API endpoint.
func (*APIEndpoint) DeepCopy ¶
func (in *APIEndpoint) DeepCopy() *APIEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIEndpoint.
func (*APIEndpoint) DeepCopyInto ¶
func (in *APIEndpoint) DeepCopyInto(out *APIEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Cluster ¶
type Cluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ClusterSpec `json:"spec,omitempty"` Status ClusterStatus `json:"status,omitempty"` }
/ Cluster Cluster is the Schema for the clusters API +k8s:openapi-gen=true +kubebuilder:subresource:status
func (*Cluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.
func (*Cluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterList ¶
type ClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Cluster `json:"items"` }
ClusterList contains a list of Cluster
func (*ClusterList) DeepCopy ¶
func (in *ClusterList) DeepCopy() *ClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterList.
func (*ClusterList) DeepCopyInto ¶
func (in *ClusterList) DeepCopyInto(out *ClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterList) DeepCopyObject ¶
func (in *ClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterNetworkingConfig ¶
type ClusterNetworkingConfig struct { // The network ranges from which service VIPs are allocated. Services NetworkRanges `json:"services"` // The network ranges from which Pod networks are allocated. Pods NetworkRanges `json:"pods"` // Domain name for services. ServiceDomain string `json:"serviceDomain"` }
/ ClusterNetworkingConfig ClusterNetworkingConfig specifies the different networking parameters for a cluster.
func (*ClusterNetworkingConfig) DeepCopy ¶
func (in *ClusterNetworkingConfig) DeepCopy() *ClusterNetworkingConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterNetworkingConfig.
func (*ClusterNetworkingConfig) DeepCopyInto ¶
func (in *ClusterNetworkingConfig) DeepCopyInto(out *ClusterNetworkingConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterSpec ¶
type ClusterSpec struct { // Cluster network configuration ClusterNetwork ClusterNetworkingConfig `json:"clusterNetwork"` // Provider-specific serialized configuration to use during // cluster creation. It is recommended that providers maintain // their own versioned API types that should be // serialized/deserialized from this field. // +optional ProviderSpec ProviderSpec `json:"providerSpec,omitempty"` }
/ ClusterSpec ClusterSpec defines the desired state of Cluster
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶
type ClusterStatus struct { // APIEndpoint represents the endpoint to communicate with the IP. // +optional APIEndpoints []APIEndpoint `json:"apiEndpoints,omitempty"` // If set, indicates that there is a problem reconciling the // state, and will be set to a token value suitable for // programmatic interpretation. // +optional ErrorReason common.ClusterStatusError `json:"errorReason,omitempty"` // If set, indicates that there is a problem reconciling the // state, and will be set to a descriptive error message. // +optional ErrorMessage string `json:"errorMessage,omitempty"` // Provider-specific status. // It is recommended that providers maintain their // own versioned API types that should be // serialized/deserialized from this field. // +optional ProviderStatus *runtime.RawExtension `json:"providerStatus,omitempty"` }
/ ClusterStatus ClusterStatus defines the observed state of Cluster
func (*ClusterStatus) DeepCopy ¶
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachineClassRef ¶
type MachineClassRef struct { // +optional *corev1.ObjectReference `json:",inline"` // Provider is the name of the cloud-provider which MachineClass is intended for. // +optional Provider string `json:"provider,omitempty"` }
MachineClassRef is a reference to the MachineClass object. Controllers should find the right MachineClass using this reference.
func (*MachineClassRef) DeepCopy ¶
func (in *MachineClassRef) DeepCopy() *MachineClassRef
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachineClassRef.
func (*MachineClassRef) DeepCopyInto ¶
func (in *MachineClassRef) DeepCopyInto(out *MachineClassRef)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NetworkRanges ¶
type NetworkRanges struct {
CIDRBlocks []string `json:"cidrBlocks"`
}
/ NetworkRanges NetworkRanges represents ranges of network addresses.
func (*NetworkRanges) DeepCopy ¶
func (in *NetworkRanges) DeepCopy() *NetworkRanges
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkRanges.
func (*NetworkRanges) DeepCopyInto ¶
func (in *NetworkRanges) DeepCopyInto(out *NetworkRanges)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProviderSpec ¶
type ProviderSpec struct { // Value is an inlined, serialized representation of the resource // configuration. It is recommended that providers maintain their own // versioned API types that should be serialized/deserialized from this // field, akin to component config. // +optional Value *runtime.RawExtension `json:"value,omitempty"` // Source for the provider configuration. Cannot be used if value is // not empty. // +optional ValueFrom *ProviderSpecSource `json:"valueFrom,omitempty"` }
ProviderSpec defines the configuration to use during node creation.
func (*ProviderSpec) DeepCopy ¶
func (in *ProviderSpec) DeepCopy() *ProviderSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderSpec.
func (*ProviderSpec) DeepCopyInto ¶
func (in *ProviderSpec) DeepCopyInto(out *ProviderSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProviderSpecSource ¶
type ProviderSpecSource struct { // The machine class from which the provider config should be sourced. // +optional MachineClass *MachineClassRef `json:"machineClass,omitempty"` }
ProviderSpecSource represents a source for the provider-specific resource configuration.
func (*ProviderSpecSource) DeepCopy ¶
func (in *ProviderSpecSource) DeepCopy() *ProviderSpecSource
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderSpecSource.
func (*ProviderSpecSource) DeepCopyInto ¶
func (in *ProviderSpecSource) DeepCopyInto(out *ProviderSpecSource)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.