Immutable Infrastructure

HCSCluster [infrastructure.cluster.x-k8s.io/v1beta1]

infrastructure.cluster.x-k8s.io group

HCSCluster is the Schema for the hcsclusters API

v1beta1 version
spec object required

spec defines the desired state of HCSCluster

controlPlaneEndpoint object

ControlPlaneEndpoint specifies the API endpoint where the control plane can be accessed.

host string required

host is the hostname on which the API server is serving.

port integer required

port is the port on which the API server is serving.

controlPlaneLoadBalancer object
elbVirsubnetL4Ips []object
ips []string

IPs is a list of IP addresses associated with the virtual subnet, serialized as a JSON array of strings and optional.

subnetName string

SubnetName is a pointer to a string that specifies the name of the subnet, optionally included in JSON output.

elbVirsubnetL7Ips []object
ips []string

IPs is a list of IP addresses associated with the virtual subnet, serialized as a JSON array of strings and optional.

subnetName string

SubnetName is a pointer to a string that specifies the name of the subnet, optionally included in JSON output.

id string
liseners []object
id string
protocolPort integer
name string

Name represents the name of the load balancer as a pointer to a string, used for identification and optionally included in JSON output.

pools []object
id string
protocolPort integer
publicIpOption object

PublicIpOption specifies configuration options for the public IP of the control plane load balancer, optional in JSON output.

ipVersion string required

IpVersion represents the IP version of the public IP address as a pointer to a string, used for identification and optionally included in JSON output.

networkType string required

NetworkType specifies the type of network configuration for the control plane load balancer, serialized as a JSON string.

selector string

Selector specifies a label query used to identify resources, represented as a pointer to a string, and is optional in JSON output.

vipAddress string
vipDomainName string
vipSubnetId string
vipSubnetName string
vpcId string

VpcId is a pointer to a string that specifies the unique ID of the VPC, optionally included in JSON output.

vpcName string

VpcName is a pointer to a string representing the name of the VPC, optionally included in JSON output.

identityRef object required

IdentityRef is a reference to the identity used to provision the cluster.

name string

Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

network object required

Network is the network configuration of the cluster.

securityGroup object

SecurityGroups represents the security group configuration of the cluster, optional in JSON output.

id string

ID represents the unique ID of the security group as a pointer to a string, used for identification and optionally included in JSON output.

name string

Name represents the name of the security group as a pointer to a string, used for identification and optionally included in JSON output.

subnets []object
cidr string

Cidr represents the CIDR block of the subnet as a pointer to a string, used for identification and optionally included in JSON output.

dhcp boolean

DHCP represents the DHCP flag of the subnet as a pointer to a bool, used for identification and optionally included in JSON output.

gatewayIp string
id string
managed boolean
name string

Name represents the name of the subnet as a pointer to a string, used for identification and optionally included in JSON output.

neutronSubnetId string
primaryDNS string

PrimaryDNS represents the primary DNS of the subnet as a pointer to a string, used for identification and optionally included in JSON output.

secondaryDNS string

SecondaryDNS represents the secondary DNS of the subnet as a pointer to a string, used for identification and optionally included in JSON output.

vpc object

Vpc represents the VPC configuration of the cluster, optional in JSON output.

cidr string

Cidr specifies the CIDR block of the VPC as a pointer to a string, used for identification and optionally included in JSON output.

externalGatewayInfo object

ExternalGatewayInfo specifies the external gateway information of the VPC as a pointer to a ExternalGatewayConfig struct, used for identification and optionally included in JSON output.

networkId string

NetworkId represents the id of the network as a pointer to a string, optionally included in JSON serialization.

networkName string

NetworkName represents the name of the network as a pointer to a string, optionally included in JSON serialization.

id string

ID specifies the unique ID of the VPC as a pointer to a string, used for identification and optionally included in JSON output.

managed boolean

Managed represents the managed flag of the VPC as a pointer to a bool, used for identification and optionally included in JSON output.

name string

Name specifies the name of the VPC as a pointer to a string, used for identification and optionally included in JSON output.

networkType string required

NetworkType is the network type of the cluster(kube-ovn only supported now).

status object

status defines the observed state of HCSCluster

conditions []object

Condition defines an observation of a Cluster API resource operational state.

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message string

message is a human readable message indicating details about the transition. This field may be empty.

reason string

reason is the reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may be empty.

severity string

severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

status string required

status of the condition, one of True, False, Unknown.

type string required

type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

ready boolean

Ready indicates whether the cluster is in a ready state. It is an optional field that can be nil.