Immutable Infrastructure
  • 简体中文

    • BaremetalCluster [infrastructure.cluster.x-k8s.io/v1beta1]

    描述
    BaremetalCluster is the Schema for the baremetalclusters API.
    类型
    object

    规格

    属性类型描述
    apiVersionstring

    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

    kindstring

    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

    metadataObjectMeta

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    specobject

    BaremetalClusterSpec describes the cluster-level infrastructure configuration owned by the baremetal provider. See design-doc/api/cr-reference.md §3.

    statusobject

    BaremetalClusterStatus aggregates infra-level readiness for CAPI.

    .spec

    描述
    BaremetalClusterSpec describes the cluster-level infrastructure configuration owned by the baremetal provider. See design-doc/api/cr-reference.md §3.
    类型
    object
    属性类型描述
    controlPlaneEndpointobject

    ControlPlaneEndpoint is the apiserver endpoint exposed to the workload plane. CAPI contract: once set, must not change.

    controlPlaneLoadBalancerobject

    ControlPlaneLoadBalancer describes the VIP / LB fronting the control plane. When set, the reconciler backfills ControlPlaneEndpoint from this value.

    networkTypestring

    NetworkType identifies the CNI implementation the provider should expect. Phase 1 treats this as metadata only.

    .spec.controlPlaneEndpoint

    描述
    ControlPlaneEndpoint is the apiserver endpoint exposed to the workload plane. CAPI contract: once set, must not change.
    类型
    object
    必填
    hostport
    属性类型描述
    hoststring
    portinteger

    .spec.controlPlaneLoadBalancer

    描述
    ControlPlaneLoadBalancer describes the VIP / LB fronting the control plane. When set, the reconciler backfills ControlPlaneEndpoint from this value.
    类型
    object
    必填
    hostport
    属性类型描述
    hoststring
    portinteger
    typestring
    vridinteger

    VRID is the keepalived/vrrp identifier used by the internal load balancer.

    .status

    描述
    BaremetalClusterStatus aggregates infra-level readiness for CAPI.
    类型
    object
    属性类型描述
    conditionsarray
    failureDomainsobject

    FailureDomains is reserved for future Phase 3 work.

    readyboolean

    Ready follows the CAPI infrastructure contract (required).

    .status.conditions

    类型
    array

    .status.conditions[]

    描述
    Condition contains details for one aspect of the current state of this API Resource.
    类型
    object
    必填
    lastTransitionTimemessagereasonstatustype
    属性类型描述
    lastTransitionTimestring

    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.

    messagestring

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

    observedGenerationinteger

    observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

    reasonstring

    reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

    statusstring

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

    typestring

    type of condition in CamelCase or in foo.example.com/CamelCase.

    .status.failureDomains

    描述
    FailureDomains is reserved for future Phase 3 work.
    类型
    object

    API 端点

    可用的 API 端点如下：

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

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

    HTTP 方法
    DELETE
    描述
    delete collection of BaremetalCluster
    HTTP 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    list objects of kind BaremetalCluster
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalClusterList schema
    401 - UnauthorizedEmpty
    HTTP 方法
    POST
    描述
    create a new BaremetalCluster
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    请求体参数
    参数类型描述
    bodyBaremetalCluster schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalCluster schema
    201 - CreatedBaremetalCluster schema
    202 - AcceptedBaremetalCluster schema
    401 - UnauthorizedEmpty

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

    HTTP 方法
    DELETE
    描述
    delete the specified BaremetalCluster
    查询参数
    参数类型描述
    dryRunstringWhen 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 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    read the specified BaremetalCluster
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalCluster schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update the specified BaremetalCluster
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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 - OKBaremetalCluster schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace the specified BaremetalCluster
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    请求体参数
    参数类型描述
    bodyBaremetalCluster schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalCluster schema
    201 - CreatedBaremetalCluster schema
    401 - UnauthorizedEmpty

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

    HTTP 方法
    GET
    描述
    read status of the specified BaremetalCluster
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalCluster schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update status of the specified BaremetalCluster
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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 - OKBaremetalCluster schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace status of the specified BaremetalCluster
    查询参数
    参数类型描述
    dryRunstringWhen 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
    fieldValidationstringfieldValidation 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.
    请求体参数
    参数类型描述
    bodyBaremetalCluster schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalCluster schema
    201 - CreatedBaremetalCluster schema
    401 - UnauthorizedEmpty