Immutable Infrastructure
  • 简体中文

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

    描述
    BaremetalMachine is the Schema for the baremetalmachines 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

    BaremetalMachineSpec follows design-doc/api/resource-model.md §8. Role / version / upgrade image deliberately absent: role is inferred from the owning KubeadmControlPlane / MachineDeployment, version comes from the owner Machine, and the elemental upgrade image is resolved at reprovision time via the provider image catalog.

    statusobject

    BaremetalMachineStatus tracks provider-internal allocation and the reprovision pipeline.

    .spec

    描述
    BaremetalMachineSpec follows design-doc/api/resource-model.md §8. Role / version / upgrade image deliberately absent: role is inferred from the owning KubeadmControlPlane / MachineDeployment, version comes from the owner Machine, and the elemental upgrade image is resolved at reprovision time via the provider image catalog.
    类型
    object
    必填
    machineInventoryPoolRef
    属性类型描述
    machineInventoryPoolRefobject

    MachineInventoryPoolRef pins which pool this machine draws from. The field is immutable once set (see webhook).

    providerIDstring

    ProviderID is the CAPI contract field populated once the node is bound to a MachineInventory. Format: baremetal:///

    .spec.machineInventoryPoolRef

    描述
    MachineInventoryPoolRef pins which pool this machine draws from. The field is immutable once set (see webhook).
    类型
    object
    必填
    name
    属性类型描述
    namestring

    .status

    描述
    BaremetalMachineStatus tracks provider-internal allocation and the reprovision pipeline.
    类型
    object
    属性类型描述
    addressesarray

    Addresses surfaces addresses reported by the MachineInventory (Phase 1: unused).

    conditionsarray
    failureMessagestring

    FailureMessage is a CAPI-contract human-readable message.

    failureReasonstring

    FailureReason is a CAPI-contract terse reason for a terminal failure.

    lastAppliedBootstrapHashstring

    LastAppliedBootstrapHash tracks the sha256 of the bootstrap user-data that was last rendered into a reprovision plan. It prevents redundant patches.

    lastAppliedPlanChecksumstring

    LastAppliedPlanChecksum tracks the sha256 of the last plan body we wrote, used to detect Applied/Failed transitions from MachineInventory.status.plan.

    machineInventoryRefobject

    MachineInventoryRef is the inventory selected from the pool.

    phasestring

    Phase is the coarse state; see BaremetalMachinePhase constants.

    planSecretRefobject

    PlanSecretRef is the elemental plan secret currently driven by the provider.

    readyboolean

    Ready indicates CAPI-contract readiness (node joined and healthy).

    .status.addresses

    描述
    Addresses surfaces addresses reported by the MachineInventory (Phase 1: unused).
    类型
    array

    .status.addresses[]

    描述
    NodeAddress contains information for the node's address.
    类型
    object
    必填
    addresstype
    属性类型描述
    addressstring

    The node address.

    typestring

    Node address type, one of Hostname, ExternalIP or InternalIP.

    .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.machineInventoryRef

    描述
    MachineInventoryRef is the inventory selected from the pool.
    类型
    object
    必填
    name
    属性类型描述
    namestring

    .status.planSecretRef

    描述
    PlanSecretRef is the elemental plan secret currently driven by the provider.
    类型
    object
    必填
    name
    属性类型描述
    namestring

    API 端点

    可用的 API 端点如下：

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

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

    HTTP 方法
    DELETE
    描述
    delete collection of BaremetalMachine
    HTTP 响应
    HTTP 状态码响应体
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP 方法
    GET
    描述
    list objects of kind BaremetalMachine
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalMachineList schema
    401 - UnauthorizedEmpty
    HTTP 方法
    POST
    描述
    create a new BaremetalMachine
    查询参数
    参数类型描述
    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.
    请求体参数
    参数类型描述
    bodyBaremetalMachine schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalMachine schema
    201 - CreatedBaremetalMachine schema
    202 - AcceptedBaremetalMachine schema
    401 - UnauthorizedEmpty

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

    HTTP 方法
    DELETE
    描述
    delete the specified BaremetalMachine
    查询参数
    参数类型描述
    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 BaremetalMachine
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalMachine schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PATCH
    描述
    partially update the specified BaremetalMachine
    查询参数
    参数类型描述
    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 - OKBaremetalMachine schema
    401 - UnauthorizedEmpty
    HTTP 方法
    PUT
    描述
    replace the specified BaremetalMachine
    查询参数
    参数类型描述
    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.
    请求体参数
    参数类型描述
    bodyBaremetalMachine schemaapplication/json formatted
    HTTP 响应
    HTTP 状态码响应体
    200 - OKBaremetalMachine schema
    201 - CreatedBaremetalMachine schema
    401 - UnauthorizedEmpty

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

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