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

Description: UserProvisionedCluster is the Schema for the baremetalclusters API
Type: object

Specification

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	UserProvisionedClusterSpec defines the desired state of UserProvisionedCluster
`status`	`object`	UserProvisionedSpecClusterStatus defines the observed state of UserProvisionedCluster

.spec

Description: UserProvisionedClusterSpec defines the desired state of UserProvisionedCluster
Type: object
Required: clusterCIDRcredentialRefdnsDomainhahostnameAsNodeNamekubeProxymachinePoolRefnetworkConfignetworkTypeserviceCIDR

Property	Type	Description
`apiserverExtraArgs`	`object`
`clusterCIDR`	`object`	NetworkRanges represents ranges of network addresses.
`controlPlaneEndpoint`	`object`	APIEndpoint represents a reachable Kubernetes API endpoint.
`controllerManagerExtraArgs`	`object`
`credentialRef`	`object`	LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
`dnsDomain`	`string`
`dockerExtraArgs`	`object`
`etcd`	`object`
`ha`	`object`
`hostnameAsNodeName`	`boolean`
`kubeProxy`	`object`
`kubeletExtraArgs`	`object`
`machinePoolRef`	`object`	LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
`maxNodePodNum`	`integer`
`networkConfig`	`object`
`networkType`	`string`
`publicAlternaticenames`	`array`
`schedulerExtraArgs`	`object`
`serviceCIDR`	`object`	NetworkRanges represents ranges of network addresses.
`version`	`string`

.spec.apiserverExtraArgs

Type: object

.spec.clusterCIDR

Description: NetworkRanges represents ranges of network addresses.
Type: object
Required: cidrBlocks

Property	Type	Description
`cidrBlocks`	`array`

.spec.clusterCIDR.cidrBlocks

Type: array

.spec.clusterCIDR.cidrBlocks[]

Type: string

.spec.controlPlaneEndpoint

Description: APIEndpoint represents a reachable Kubernetes API endpoint.
Type: object
Required: hostport

Property	Type	Description
`host`	`string`	The hostname on which the API server is serving.
`port`	`integer`	The port on which the API server is serving.

.spec.controllerManagerExtraArgs

Type: object

.spec.credentialRef

Description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Type: object

Property	Type	Description
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.spec.dockerExtraArgs

Type: object

.spec.etcd

Type: object

Property	Type	Description
`local`	`object`

.spec.etcd.local

Type: object

Property	Type	Description
`dataDir`	`string`	DataDir is the directory etcd will place its data. Defaults to "/var/lib/etcd".
`extraArgs`	`object`	ExtraArgs are extra arguments provided to the etcd binary when run inside a static pod.
`peerCertSANs`	`array`	PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert.
`serverCertSANs`	`array`	ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert.

.spec.etcd.local.extraArgs

Description: ExtraArgs are extra arguments provided to the etcd binary when run inside a static pod.
Type: object

.spec.etcd.local.peerCertSANs

Description: PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert.
Type: array

.spec.etcd.local.peerCertSANs[]

Type: string

.spec.etcd.local.serverCertSANs

Description: ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert.
Type: array

.spec.etcd.local.serverCertSANs[]

Type: string

.spec.ha

Type: object
Required: configtype

Property	Type	Description
`config`	`object`
`type`	`string`

.spec.ha.config

Type: object
Required: vipvportvrid

Property	Type	Description
`vip`	`string`
`vport`	`integer`
`vrid`	`integer`

.spec.kubeProxy

Type: object
Required: ipvs

Property	Type	Description
`ipvs`	`boolean`

.spec.kubeletExtraArgs

Type: object

.spec.machinePoolRef

Description: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Type: object

Property	Type	Description
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.spec.networkConfig

Type: object
Required: devicestack

Property	Type	Description
`device`	`string`
`stack`	`string`

.spec.publicAlternaticenames

Type: array

.spec.publicAlternaticenames[]

Type: string

.spec.schedulerExtraArgs

Type: object

.spec.serviceCIDR

Description: NetworkRanges represents ranges of network addresses.
Type: object
Required: cidrBlocks

Property	Type	Description
`cidrBlocks`	`array`

.spec.serviceCIDR.cidrBlocks

Type: array

.spec.serviceCIDR.cidrBlocks[]

Type: string

.status

Description: UserProvisionedSpecClusterStatus defines the observed state of UserProvisionedCluster
Type: object

Property	Type	Description
`addresses`	`array`
`clusterCIDR`	`string`
`conditions`	`array`
`dnsIP`	`string`
`initialized`	`boolean`
`nodeCIDRMaskSize`	`integer`
`nodeCIDRMaskSizeIPv4`	`integer`
`nodeCIDRMaskSizeIPv6`	`integer`
`phase`	`string`
`ready`	`boolean`
`secondaryClusterCIDR`	`string`
`secondaryServiceCIDR`	`string`
`serviceCIDR`	`string`
`version`	`string`

.status.addresses

Type: array

.status.addresses[]

Description: ClusterAddress contains information for the cluster's address.
Type: object
Required: hostpathporttype

Property	Type	Description
`host`	`string`	The cluster address.
`path`	`string`	path
`port`	`integer`	port
`type`	`string`	Cluster address type, one of Public, ExternalIP or InternalIP.

.status.conditions

Type: array

.status.conditions[]

Description: Condition defines an observation of a Cluster API resource operational state.
Type: object
Required: lastTransitionTimestatustype

Property	Type	Description
`lastTransitionTime`	`string`	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`	A human readable message indicating details about the transition. This field may be empty.
`reason`	`string`	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 not 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`	Status of the condition, one of True, False, Unknown.
`type`	`string`	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.

API Endpoints

The following API endpoints are available:

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters
- DELETE: delete collection of UserProvisionedCluster
- GET: list objects of kind UserProvisionedCluster
- POST: create a new UserProvisionedCluster
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}
- DELETE: delete the specified UserProvisionedCluster
- GET: read the specified UserProvisionedCluster
- PATCH: partially update the specified UserProvisionedCluster
- PUT: replace the specified UserProvisionedCluster
/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}/status
- GET: read status of the specified UserProvisionedCluster
- PATCH: partially update status of the specified UserProvisionedCluster
- PUT: replace status of the specified UserProvisionedCluster

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters

HTTP method: DELETE
Description: delete collection of UserProvisionedCluster
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind UserProvisionedCluster
HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedClusterList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new UserProvisionedCluster

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`UserProvisionedCluster` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedCluster` schema
201 - Created	`UserProvisionedCluster` schema
202 - Accepted	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}

HTTP method: DELETE
Description: delete the specified UserProvisionedCluster

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified UserProvisionedCluster
HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified UserProvisionedCluster

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified UserProvisionedCluster

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`UserProvisionedCluster` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedCluster` schema
201 - Created	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}/status

HTTP method: GET
Description: read status of the specified UserProvisionedCluster
HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified UserProvisionedCluster

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified UserProvisionedCluster

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`UserProvisionedCluster` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`UserProvisionedCluster` schema
201 - Created	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

#UserProvisionedCluster [infrastructure.cluster.x-k8s.io/v1beta1]

Specification#

.spec#

.spec.apiserverExtraArgs#

.spec.clusterCIDR#

.spec.clusterCIDR.cidrBlocks#

.spec.clusterCIDR.cidrBlocks[]#

.spec.controlPlaneEndpoint#

.spec.controllerManagerExtraArgs#

.spec.credentialRef#

.spec.dockerExtraArgs#

.spec.etcd#

.spec.etcd.local#

.spec.etcd.local.extraArgs#

.spec.etcd.local.peerCertSANs#

.spec.etcd.local.peerCertSANs[]#

.spec.etcd.local.serverCertSANs#

.spec.etcd.local.serverCertSANs[]#

.spec.ha#

.spec.ha.config#

.spec.kubeProxy#

.spec.kubeletExtraArgs#

.spec.machinePoolRef#

.spec.networkConfig#

.spec.publicAlternaticenames#

.spec.publicAlternaticenames[]#

.spec.schedulerExtraArgs#

.spec.serviceCIDR#

.spec.serviceCIDR.cidrBlocks#

.spec.serviceCIDR.cidrBlocks[]#

.status#

.status.addresses#

.status.addresses[]#

.status.conditions#

.status.conditions[]#

API Endpoints#

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters#

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}#

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}/status#

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

Specification

.spec

.spec.apiserverExtraArgs

.spec.clusterCIDR

.spec.clusterCIDR.cidrBlocks

.spec.clusterCIDR.cidrBlocks[]

.spec.controlPlaneEndpoint

.spec.controllerManagerExtraArgs

.spec.credentialRef

.spec.dockerExtraArgs

.spec.etcd

.spec.etcd.local

.spec.etcd.local.extraArgs

.spec.etcd.local.peerCertSANs

.spec.etcd.local.peerCertSANs[]

.spec.etcd.local.serverCertSANs

.spec.etcd.local.serverCertSANs[]

.spec.ha

.spec.ha.config

.spec.kubeProxy

.spec.kubeletExtraArgs

.spec.machinePoolRef

.spec.networkConfig

.spec.publicAlternaticenames

.spec.publicAlternaticenames[]

.spec.schedulerExtraArgs

.spec.serviceCIDR

.spec.serviceCIDR.cidrBlocks

.spec.serviceCIDR.cidrBlocks[]

.status

.status.addresses

.status.addresses[]

.status.conditions

.status.conditions[]

API Endpoints

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/userprovisionedclusters/{name}/status