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

描述: UserProvisionedCluster is the Schema for the baremetalclusters API
类型: object

规格

属性	类型	描述
`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

描述: UserProvisionedClusterSpec defines the desired state of UserProvisionedCluster
类型: object
必填: clusterCIDRcredentialRefdnsDomainhahostnameAsNodeNamekubeProxymachinePoolRefnetworkConfignetworkTypeserviceCIDR

属性	类型	描述
`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

类型: object

.spec.clusterCIDR

描述: NetworkRanges represents ranges of network addresses.
类型: object
必填: cidrBlocks

属性	类型	描述
`cidrBlocks`	`array`

.spec.clusterCIDR.cidrBlocks

类型: array

.spec.clusterCIDR.cidrBlocks[]

类型: string

.spec.controlPlaneEndpoint

描述: APIEndpoint represents a reachable Kubernetes API endpoint.
类型: object
必填: hostport

属性	类型	描述
`host`	`string`	The hostname on which the API server is serving.
`port`	`integer`	The port on which the API server is serving.

.spec.controllerManagerExtraArgs

类型: object

.spec.credentialRef

描述: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
类型: object

属性	类型	描述
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.spec.dockerExtraArgs

类型: object

.spec.etcd

类型: object

属性	类型	描述
`local`	`object`

.spec.etcd.local

类型: object

属性	类型	描述
`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

描述: ExtraArgs are extra arguments provided to the etcd binary when run inside a static pod.
类型: object

.spec.etcd.local.peerCertSANs

描述: PeerCertSANs sets extra Subject Alternative Names for the etcd peer signing cert.
类型: array

.spec.etcd.local.peerCertSANs[]

类型: string

.spec.etcd.local.serverCertSANs

描述: ServerCertSANs sets extra Subject Alternative Names for the etcd server signing cert.
类型: array

.spec.etcd.local.serverCertSANs[]

类型: string

.spec.ha

类型: object
必填: configtype

属性	类型	描述
`config`	`object`
`type`	`string`

.spec.ha.config

类型: object
必填: vipvportvrid

属性	类型	描述
`vip`	`string`
`vport`	`integer`
`vrid`	`integer`

.spec.kubeProxy

类型: object
必填: ipvs

属性	类型	描述
`ipvs`	`boolean`

.spec.kubeletExtraArgs

类型: object

.spec.machinePoolRef

描述: LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
类型: object

属性	类型	描述
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.spec.networkConfig

类型: object
必填: devicestack

属性	类型	描述
`device`	`string`
`stack`	`string`

.spec.publicAlternaticenames

类型: array

.spec.publicAlternaticenames[]

类型: string

.spec.schedulerExtraArgs

类型: object

.spec.serviceCIDR

描述: NetworkRanges represents ranges of network addresses.
类型: object
必填: cidrBlocks

属性	类型	描述
`cidrBlocks`	`array`

.spec.serviceCIDR.cidrBlocks

类型: array

.spec.serviceCIDR.cidrBlocks[]

类型: string

.status

描述: UserProvisionedSpecClusterStatus defines the observed state of UserProvisionedCluster
类型: object

属性	类型	描述
`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

类型: array

.status.addresses[]

描述: ClusterAddress contains information for the cluster's address.
类型: object
必填: hostpathporttype

属性	类型	描述
`host`	`string`	The cluster address.
`path`	`string`	path
`port`	`integer`	port
`type`	`string`	Cluster address type, one of Public, ExternalIP or InternalIP.

.status.conditions

类型: array

.status.conditions[]

描述: Condition defines an observation of a Cluster API resource operational state.
类型: object
必填: lastTransitionTimestatustype

属性	类型	描述
`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 端点

可用的 API 端点如下：

/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 方法: DELETE
描述: delete collection of UserProvisionedCluster
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind UserProvisionedCluster
HTTP 响应

HTTP 状态码	响应体
200 - OK	`UserProvisionedClusterList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new UserProvisionedCluster

查询参数

参数	类型	描述
`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`	`UserProvisionedCluster` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
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 方法: DELETE
描述: delete the specified UserProvisionedCluster

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified UserProvisionedCluster
HTTP 响应

HTTP 状态码	响应体
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified UserProvisionedCluster

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified UserProvisionedCluster

查询参数

参数	类型	描述
`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`	`UserProvisionedCluster` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`UserProvisionedCluster` schema
201 - Created	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

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

HTTP 方法: GET
描述: read status of the specified UserProvisionedCluster
HTTP 响应

HTTP 状态码	响应体
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update status of the specified UserProvisionedCluster

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace status of the specified UserProvisionedCluster

查询参数

参数	类型	描述
`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`	`UserProvisionedCluster` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`UserProvisionedCluster` schema
201 - Created	`UserProvisionedCluster` schema
401 - Unauthorized	Empty

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

#规格

#.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 端点#

/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]

规格

.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 端点

/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