HCSCluster [infrastructure.cluster.x-k8s.io/v1beta1]
- Description
- HCSCluster is the Schema for the hcsclusters API
- Type
object- Required
spec
Specification
.spec
- Description
- spec defines the desired state of HCSCluster
- Type
object- Required
identityRefnetworknetworkType
.spec.controlPlaneEndpoint
- Description
- ControlPlaneEndpoint specifies the API endpoint where the control plane can be accessed.
- Type
object- Required
hostport
.spec.controlPlaneLoadBalancer
- Type
object
.spec.controlPlaneLoadBalancer.elbVirsubnetL4Ips
- Type
array
.spec.controlPlaneLoadBalancer.elbVirsubnetL4Ips[]
- Type
object
.spec.controlPlaneLoadBalancer.elbVirsubnetL4Ips[].ips
- Description
- IPs is a list of IP addresses associated with the virtual subnet, serialized as a JSON array of strings and optional.
- Type
array
.spec.controlPlaneLoadBalancer.elbVirsubnetL4Ips[].ips[]
- Type
string
.spec.controlPlaneLoadBalancer.elbVirsubnetL7Ips
- Type
array
.spec.controlPlaneLoadBalancer.elbVirsubnetL7Ips[]
- Type
object
.spec.controlPlaneLoadBalancer.elbVirsubnetL7Ips[].ips
- Description
- IPs is a list of IP addresses associated with the virtual subnet, serialized as a JSON array of strings and optional.
- Type
array
.spec.controlPlaneLoadBalancer.elbVirsubnetL7Ips[].ips[]
- Type
string
.spec.controlPlaneLoadBalancer.liseners
- Type
array
.spec.controlPlaneLoadBalancer.liseners[]
- Type
object
.spec.controlPlaneLoadBalancer.pools
- Type
array
.spec.controlPlaneLoadBalancer.pools[]
- Type
object
.spec.controlPlaneLoadBalancer.publicIpOption
- Description
- PublicIpOption specifies configuration options for the public IP of the control plane load balancer, optional in JSON output.
- Type
object- Required
ipVersionnetworkType
.spec.identityRef
- Description
- IdentityRef is a reference to the identity used to provision the cluster.
- Type
object
.spec.network
- Description
- Network is the network configuration of the cluster.
- Type
object
.spec.network.securityGroup
- Description
- SecurityGroups represents the security group configuration of the cluster, optional in JSON output.
- Type
object
.spec.network.subnets
- Description
- Subnets represents the subnet configuration of the cluster, optional in JSON output.
- Type
array
.spec.network.subnets[]
- Type
object
.spec.network.vpc
- Description
- Vpc represents the VPC configuration of the cluster, optional in JSON output.
- Type
object
.spec.network.vpc.externalGatewayInfo
- Description
- 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.
- Type
object
.status
- Description
- status defines the observed state of HCSCluster
- Type
object
.status.conditions
- Description
- Conditions defines current service state of the cluster.
- Type
array
.status.conditions[]
- Description
- Condition defines an observation of a Cluster API resource operational state.
- Type
object- Required
lastTransitionTimestatustype
API Endpoints
The following API endpoints are available:
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/hcsclustersDELETE: delete collection of HCSClusterGET: list objects of kind HCSClusterPOST: create a new HCSCluster
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/hcsclusters/{name}DELETE: delete the specified HCSClusterGET: read the specified HCSClusterPATCH: partially update the specified HCSClusterPUT: replace the specified HCSCluster
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/hcsclusters/{name}/statusGET: read status of the specified HCSClusterPATCH: partially update status of the specified HCSClusterPUT: replace status of the specified HCSCluster
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/hcsclusters
- HTTP method
DELETE- Description
- delete collection of HCSCluster
- HTTP responses
- HTTP method
GET- Description
- list objects of kind HCSCluster
- HTTP responses
- HTTP method
POST- Description
- create a new HCSCluster
- Query parameters
- Body parameters
- HTTP responses
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/hcsclusters/{name}
- HTTP method
DELETE- Description
- delete the specified HCSCluster
- Query parameters
- HTTP responses
- HTTP method
GET- Description
- read the specified HCSCluster
- HTTP responses
- HTTP method
PATCH- Description
- partially update the specified HCSCluster
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace the specified HCSCluster
- Query parameters
- Body parameters
- HTTP responses
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/hcsclusters/{name}/status
- HTTP method
GET- Description
- read status of the specified HCSCluster
- HTTP responses
- HTTP method
PATCH- Description
- partially update status of the specified HCSCluster
- Query parameters
- HTTP responses
- HTTP method
PUT- Description
- replace status of the specified HCSCluster
- Query parameters
- Body parameters
- HTTP responses