Infra API reference

Detailed documentation on the infras API

Packages:

infrastructure.cluster.x-k8s.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the cluster v1alpha1 API group

Resource Types:

CustomCluster

CustomCluster represents the parameters for a cluster in supplement of Cluster API.

Field Description
apiVersion
string		 infrastructure.cluster.x-k8s.io/v1alpha1
kind
string 		CustomCluster
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
CustomClusterSpec

Specification of the desired behavior of the kurator cluster.

machineRef
Kubernetes core/v1.ObjectReference

MachineRef is the reference of nodes for provisioning a kurator cluster.
cni
CNIConfig

CNIConfig is the configuration for the CNI of the cluster.
controlPlaneConfig
ControlPlaneConfig 		(Optional)

ControlPlaneConfig contains control plane configuration.
status
CustomClusterStatus

Current status of the kurator cluster

CustomMachine

CustomMachine is the schema for kubernetes nodes.

Field Description
apiVersion
string		 infrastructure.cluster.x-k8s.io/v1alpha1
kind
string 		CustomMachine
metadata
Kubernetes meta/v1.ObjectMeta 		(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
CustomMachineSpec

Specification of the desired behavior of the kurator cluster.

master
[]Machine
node
[]Machine
status
CustomMachineStatus

Current status of the machine.

CNIConfig

(Appears on: CustomClusterSpec)

Field Description
type
string

Type is the type of CNI. The supported types are: calico, canal, cilium, flannel, kube-ovn, kube-router, macvlan, weave

ControlPlaneConfig

(Appears on: CustomClusterSpec)

Field Description
address
string

same as ControlPlaneEndpoint (e.g. 192.x.x.0).
certSANs
[]string 		(Optional)

CertSANs sets extra Subject Alternative Names for the API Server signing cert (e.g.[200.x.x.1,200.x.x.2,kubernetes.default.svc.cluster.local], [200.x.x.1], etc…).
loadBalancerDomainName
string 		(Optional)

LoadBalancerDomainName is a variable used to set the endpoint for a Kubernetes cluster when a load balancer (LB) is enabled. The default value is ControlPlaneConfig.Address.

CustomClusterPhase (string alias)

(Appears on: CustomClusterStatus)

CustomClusterSpec

(Appears on: CustomCluster)

CustomClusterSpec defines the desired state of a kurator cluster.

Field Description
machineRef
Kubernetes core/v1.ObjectReference

MachineRef is the reference of nodes for provisioning a kurator cluster.
cni
CNIConfig

CNIConfig is the configuration for the CNI of the cluster.
controlPlaneConfig
ControlPlaneConfig 		(Optional)

ControlPlaneConfig contains control plane configuration.

CustomClusterStatus

(Appears on: CustomCluster)

CustomClusterStatus represents the current status of the cluster.

Field Description
conditions
Cluster API /v1beta1.Conditions 		(Optional)

Conditions defines current service state of the cluster.
phase
CustomClusterPhase 		(Optional)

Phase represents the current phase of customCluster actuation. E.g. Running, Succeed, Terminating, Failed etc.
apiEndpoint
string 		(Optional)

APIEndpoint is the endpoint to communicate with the apiserver. Format should be: https://host:port
kubeconfigSecretRef
string 		(Optional)

KubeconfigSecretRef represents the secret that contains the credential to access this cluster.

CustomMachineSpec

(Appears on: CustomMachine)

CustomMachineSpec defines kubernetes cluster master and nodes.

Field Description
master
[]Machine
node
[]Machine

CustomMachineStatus

(Appears on: CustomMachine)

CustomMachineStatus represents the current status of the machine.

Field Description
ready
bool

Indicate whether the machines are ready.

Machine

(Appears on: CustomMachineSpec)

Machine defines a node.

Field Description
hostName
string

HostName is the hostname of the machine.
privateIP
string

PrivateIP is the private ip address of the machine.
publicIP
string

PublicIP specifies the public IP.
region
string 		(Optional)

Region specifies the region where the machine resides.
zone
string 		(Optional)

Zone specifies the zone where the machine resides.
sshKey
Kubernetes core/v1.ObjectReference 		(Optional)

SSHKeyName is the name of the ssh key to attach to the instance. Valid values are empty string (do not use SSH keys), a valid SSH key name, or omitted (use the default SSH key name)
labels
map[string]string 		(Optional)

AdditionalTags is an optional set of tags to add to an instance.

This page was automatically generated with gen-crd-api-reference-docs