Immutable Infrastructure
  • 简体中文

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

    描述
    DCSMachineTemplate is the Schema for the dcsmachinetemplates 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

    DCSMachineTemplateSpec defines the desired state of DCSMachineTemplate.

    statusobject

    DCSMachineTemplateStatus defines the observed state of DCSMachineTemplate.

    .spec

    描述
    DCSMachineTemplateSpec defines the desired state of DCSMachineTemplate.
    类型
    object
    必填
    template
    属性类型描述
    templateobject

    .spec.template

    类型
    object
    必填
    spec
    属性类型描述
    metadataObjectMeta

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. This is a copy of customizable fields from metav1.ObjectMeta.

    ObjectMeta is embedded in Machine.Spec, MachineDeployment.Template and MachineSet.Template, which are not top-level Kubernetes objects. Given that metav1.ObjectMeta has lots of special cases and read-only fields which end up in the generated CRD validation, having it as a subset simplifies the API and some issues that can impact user experience.

    During the upgrade to controller-tools@v2 for v1alpha2, we noticed a failure would occur running Cluster API test suite against the new CRDs, specifically spec.metadata.creationTimestamp in body must be of type string: "null". The investigation showed that controller-tools@v2 behaves differently than its previous version when handling types from metav1 package.

    In more details, we found that embedded (non-top level) types that embedded metav1.ObjectMeta had validation properties, including for creationTimestamp (metav1.Time). The metav1.Time type specifies a custom json marshaller that, when IsZero() is true, returns null which breaks validation because the field isn't marked as nullable.

    In future versions, controller-tools@v2 might allow overriding the type and validation for embedded types. When that happens, this hack should be revisited.

    specobject

    DCSMachineSpec defines the desired state of DCSMachine.

    .spec.template.spec

    描述
    DCSMachineSpec defines the desired state of DCSMachine.
    类型
    object
    必填
    ipHostPoolRefvmTemplateName
    属性类型描述
    ipHostPoolRefobject

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

    locationobject
    providerIDstring
    resourceobject
    vmConfigobject
    vmTemplateNamestring
    vmUrnstring

    .spec.template.spec.ipHostPoolRef

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

    Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    .spec.template.spec.location

    类型
    object
    必填
    type
    属性类型描述
    namestring
    typestring
    urnstring

    .spec.template.spec.resource

    类型
    object
    必填
    type
    属性类型描述
    namestring
    typestring
    urnstring

    .spec.template.spec.vmConfig

    类型
    object
    必填
    dcsMachineCpuSpecdcsMachineMemorySpec
    属性类型描述
    cdRomDatastoreClusterNamestring
    cdRomDatastoreNamestring
    dcsMachineCpuSpecobject
    dcsMachineDiskSpecarray
    dcsMachineMemorySpecobject
    dvSwitchNamestring
    portGroupNamestring
    portGroupUrnstring

    .spec.template.spec.vmConfig.dcsMachineCpuSpec

    类型
    object
    必填
    quantity
    属性类型描述
    quantityinteger

    .spec.template.spec.vmConfig.dcsMachineDiskSpec

    类型
    array

    .spec.template.spec.vmConfig.dcsMachineDiskSpec[]

    类型
    object
    必填
    quantity
    属性类型描述
    datastoreClusterNamestring
    datastoreNamestring
    datastoreUrnstring
    formatstring
    mountOptionsarray
    optionsarray
    pathstring
    quantityinteger
    systemVolumeboolean
    wipeFilesystemboolean

    .spec.template.spec.vmConfig.dcsMachineDiskSpec[].mountOptions

    类型
    array

    .spec.template.spec.vmConfig.dcsMachineDiskSpec[].mountOptions[]

    类型
    string

    .spec.template.spec.vmConfig.dcsMachineDiskSpec[].options

    类型
    array

    .spec.template.spec.vmConfig.dcsMachineDiskSpec[].options[]

    类型
    string

    .spec.template.spec.vmConfig.dcsMachineMemorySpec

    类型
    object
    必填
    quantity
    属性类型描述
    quantityinteger

    .status

    描述
    DCSMachineTemplateStatus defines the observed state of DCSMachineTemplate.
    类型
    object

    API 端点

    可用的 API 端点如下：

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

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

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

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

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

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

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