Immutable Infrastructure
  • 简体中文

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

    描述
    VSphereFailureDomain is the Schema for the vspherefailuredomains 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

    VSphereFailureDomainSpec defines the desired state of VSphereFailureDomain.

    .spec

    描述
    VSphereFailureDomainSpec defines the desired state of VSphereFailureDomain.
    类型
    object
    必填
    regiontopologyzone
    属性类型描述
    regionobject

    Region defines the name and type of a region

    topologyobject

    Topology describes a given failure domain using vSphere constructs

    zoneobject

    Zone defines the name and type of a zone

    .spec.region

    描述
    Region defines the name and type of a region
    类型
    object
    必填
    nametagCategorytype
    属性类型描述
    autoConfigureboolean

    AutoConfigure tags the Type which is specified in the Topology

    Deprecated: This field is going to be removed in a future release.

    namestring

    Name is the name of the tag that represents this failure domain

    tagCategorystring

    TagCategory is the category used for the tag

    typestring

    Type is the type of failure domain, the current values are "Datacenter", "ComputeCluster" and "HostGroup"

    .spec.topology

    描述
    Topology describes a given failure domain using vSphere constructs
    类型
    object
    必填
    datacenter
    属性类型描述
    computeClusterstring

    ComputeCluster as the failure domain

    datacenterstring

    Datacenter as the failure domain.

    datastorestring

    Datastore is the name or inventory path of the datastore in which the virtual machine is created/located.

    hostsobject

    Hosts has information required for placement of machines on VSphere hosts.

    networkConfigurationsarray

    NetworkConfigurations is a list of network configurations within this failure domain.

    networksarray

    Networks is the list of networks within this failure domain

    .spec.topology.hosts

    描述
    Hosts has information required for placement of machines on VSphere hosts.
    类型
    object
    必填
    hostGroupNamevmGroupName
    属性类型描述
    hostGroupNamestring

    HostGroupName is the name of the Host group

    vmGroupNamestring

    VMGroupName is the name of the VM group

    .spec.topology.networkConfigurations

    描述
    NetworkConfigurations is a list of network configurations within this failure domain.
    类型
    array

    .spec.topology.networkConfigurations[]

    描述
    NetworkConfiguration defines a network configuration that should be used when consuming a failure domain.
    类型
    object
    必填
    networkName
    属性类型描述
    addressesFromPoolsarray

    AddressesFromPools is a list of IPAddressPools that should be assigned to IPAddressClaims. The machine's cloud-init metadata will be populated with IPAddresses fulfilled by an IPAM provider.

    dhcp4boolean

    DHCP4 is a flag that indicates whether or not to use DHCP for IPv4.

    dhcp4Overridesobject

    DHCP4Overrides allows for the control over several DHCP behaviors. Overrides will only be applied when the corresponding DHCP flag is set. Only configured values will be sent, omitted values will default to distribution defaults. Dependent on support in the network stack for your distribution. For more information see the netplan reference (https://netplan.io/reference#dhcp-overrides)

    dhcp6boolean

    DHCP6 is a flag that indicates whether or not to use DHCP for IPv6.

    dhcp6Overridesobject

    DHCP6Overrides allows for the control over several DHCP behaviors. Overrides will only be applied when the corresponding DHCP flag is set. Only configured values will be sent, omitted values will default to distribution defaults. Dependent on support in the network stack for your distribution. For more information see the netplan reference (https://netplan.io/reference#dhcp-overrides)

    nameserversarray

    Nameservers is a list of IPv4 and/or IPv6 addresses used as DNS nameservers. Please note that Linux allows only three nameservers (https://linux.die.net/man/5/resolv.conf).

    networkNamestring

    NetworkName is the network name for this machine's VM.

    searchDomainsarray

    SearchDomains is a list of search domains used when resolving IP addresses with DNS.

    .spec.topology.networkConfigurations[].addressesFromPools

    描述
    AddressesFromPools is a list of IPAddressPools that should be assigned to IPAddressClaims. The machine's cloud-init metadata will be populated with IPAddresses fulfilled by an IPAM provider.
    类型
    array

    .spec.topology.networkConfigurations[].addressesFromPools[]

    描述
    TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
    类型
    object
    必填
    kindname
    属性类型描述
    apiGroupstring

    APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    .spec.topology.networkConfigurations[].dhcp4Overrides

    描述
    DHCP4Overrides allows for the control over several DHCP behaviors. Overrides will only be applied when the corresponding DHCP flag is set. Only configured values will be sent, omitted values will default to distribution defaults. Dependent on support in the network stack for your distribution. For more information see the netplan reference (https://netplan.io/reference#dhcp-overrides)
    类型
    object
    属性类型描述
    hostnamestring

    Hostname is the name which will be sent to the DHCP server instead of the machine's hostname.

    routeMetricinteger

    RouteMetric is used to prioritize routes for devices. A lower metric for an interface will have a higher priority.

    sendHostnameboolean

    SendHostname when true, the hostname of the machine will be sent to the DHCP server.

    useDNSboolean

    UseDNS when true, the DNS servers in the DHCP server will be used and take precedence.

    useDomainsstring

    UseDomains can take the values true, false, or route. When true, the domain name from the DHCP server will be used as the DNS search domain for this device. When route, the domain name from the DHCP response will be used for routing DNS only, not for searching.

    useHostnameboolean

    UseHostname when true, the hostname from the DHCP server will be set as the transient hostname of the machine.

    useMTUboolean

    UseMTU when true, the MTU from the DHCP server will be set as the MTU of the device.

    useNTPboolean

    UseNTP when true, the NTP servers from the DHCP server will be used by systemd-timesyncd and take precedence.

    useRoutesstring

    UseRoutes can take the values true, false, or route. When true, the routes from the DHCP server will be installed in the routing table.

    .spec.topology.networkConfigurations[].dhcp6Overrides

    描述
    DHCP6Overrides allows for the control over several DHCP behaviors. Overrides will only be applied when the corresponding DHCP flag is set. Only configured values will be sent, omitted values will default to distribution defaults. Dependent on support in the network stack for your distribution. For more information see the netplan reference (https://netplan.io/reference#dhcp-overrides)
    类型
    object
    属性类型描述
    hostnamestring

    Hostname is the name which will be sent to the DHCP server instead of the machine's hostname.

    routeMetricinteger

    RouteMetric is used to prioritize routes for devices. A lower metric for an interface will have a higher priority.

    sendHostnameboolean

    SendHostname when true, the hostname of the machine will be sent to the DHCP server.

    useDNSboolean

    UseDNS when true, the DNS servers in the DHCP server will be used and take precedence.

    useDomainsstring

    UseDomains can take the values true, false, or route. When true, the domain name from the DHCP server will be used as the DNS search domain for this device. When route, the domain name from the DHCP response will be used for routing DNS only, not for searching.

    useHostnameboolean

    UseHostname when true, the hostname from the DHCP server will be set as the transient hostname of the machine.

    useMTUboolean

    UseMTU when true, the MTU from the DHCP server will be set as the MTU of the device.

    useNTPboolean

    UseNTP when true, the NTP servers from the DHCP server will be used by systemd-timesyncd and take precedence.

    useRoutesstring

    UseRoutes can take the values true, false, or route. When true, the routes from the DHCP server will be installed in the routing table.

    .spec.topology.networkConfigurations[].nameservers

    描述
    Nameservers is a list of IPv4 and/or IPv6 addresses used as DNS nameservers. Please note that Linux allows only three nameservers (https://linux.die.net/man/5/resolv.conf).
    类型
    array

    .spec.topology.networkConfigurations[].nameservers[]

    类型
    string

    .spec.topology.networkConfigurations[].searchDomains

    描述
    SearchDomains is a list of search domains used when resolving IP addresses with DNS.
    类型
    array

    .spec.topology.networkConfigurations[].searchDomains[]

    类型
    string

    .spec.topology.networks

    描述
    Networks is the list of networks within this failure domain
    类型
    array

    .spec.topology.networks[]

    类型
    string

    .spec.zone

    描述
    Zone defines the name and type of a zone
    类型
    object
    必填
    nametagCategorytype
    属性类型描述
    autoConfigureboolean

    AutoConfigure tags the Type which is specified in the Topology

    Deprecated: This field is going to be removed in a future release.

    namestring

    Name is the name of the tag that represents this failure domain

    tagCategorystring

    TagCategory is the category used for the tag

    typestring

    Type is the type of failure domain, the current values are "Datacenter", "ComputeCluster" and "HostGroup"

    API 端点

    可用的 API 端点如下：

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

    /apis/infrastructure.cluster.x-k8s.io/v1beta1/vspherefailuredomains

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

    /apis/infrastructure.cluster.x-k8s.io/v1beta1/vspherefailuredomains/{name}

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