Immutable Infrastructure
  • Русский

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

    Description
    HCSMachineConfigPool is the Schema for the hcsmachineconfigpools API. It provides a pool of pre-defined machine configurations (hostname, network settings) that can be claimed by HCSMachine resources.
    Type
    object
    Required
    spec

    Specification

    PropertyTypeDescription
    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

    spec defines the desired state of HCSMachineConfigPool

    statusobject

    status defines the observed state of HCSMachineConfigPool

    .spec

    Description
    spec defines the desired state of HCSMachineConfigPool
    Type
    object
    PropertyTypeDescription
    configsarray

    Configs is the list of machine configurations available in this pool. Each config can be claimed by a HCSMachine.

    .spec.configs

    Description
    Configs is the list of machine configurations available in this pool. Each config can be claimed by a HCSMachine.
    Type
    array

    .spec.configs[]

    Description
    MachineConfig defines the configuration for a single machine in the pool.
    Type
    object
    Required
    hostnamenetworks
    PropertyTypeDescription
    hostnamestring

    Hostname is the hostname to assign to the machine.

    networksarray

    Networks is the list of network configurations for the machine.

    .spec.configs[].networks

    Description
    Networks is the list of network configurations for the machine.
    Type
    array

    .spec.configs[].networks[]

    Description
    MachineConfigNetworkConfig defines the network configuration for a machine.
    Type
    object
    Required
    ipAddress
    PropertyTypeDescription
    ipAddressstring

    IpAddress is the static IP address to assign to the machine.

    subenetNamestring

    SubenetName is the deprecated legacy key kept for backward compatibility. Use subnetName instead.

    subnetIdstring

    SubnetId is the ID of the subnet to use.

    subnetNamestring

    SubnetName is the name of the subnet to use.

    .status

    Description
    status defines the observed state of HCSMachineConfigPool
    Type
    object
    PropertyTypeDescription
    availableCountinteger

    AvailableCount is the number of available configurations in the pool.

    totalCountinteger

    TotalCount is the total number of configurations in the pool.

    usedConfigsarray

    UsedConfigs is the list of configurations that have been claimed by HCSMachines.

    .status.usedConfigs

    Description
    UsedConfigs is the list of configurations that have been claimed by HCSMachines.
    Type
    array

    .status.usedConfigs[]

    Description
    UsedConfig represents a machine configuration that has been claimed by a HCSMachine.
    Type
    object
    Required
    hostnamemachineRef
    PropertyTypeDescription
    hostnamestring

    HostName is the hostname of the claimed configuration.

    machineRefstring

    MachineRef is the name of the HCSMachine that claimed this configuration.

    API Endpoints

    The following API endpoints are available:

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

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

    HTTP method
    DELETE
    Description
    delete collection of HCSMachineConfigPool
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind HCSMachineConfigPool
    HTTP responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPoolList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new HCSMachineConfigPool
    Query parameters
    ParameterTypeDescription
    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.
    Body parameters
    ParameterTypeDescription
    bodyHCSMachineConfigPool schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPool schema
    201 - CreatedHCSMachineConfigPool schema
    202 - AcceptedHCSMachineConfigPool schema
    401 - UnauthorizedEmpty

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

    HTTP method
    DELETE
    Description
    delete the specified HCSMachineConfigPool
    Query parameters
    ParameterTypeDescription
    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 responses
    HTTP codeResponse body
    200 - OKStatus schema
    202 - AcceptedStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    read the specified HCSMachineConfigPool
    HTTP responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPool schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update the specified HCSMachineConfigPool
    Query parameters
    ParameterTypeDescription
    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 responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPool schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace the specified HCSMachineConfigPool
    Query parameters
    ParameterTypeDescription
    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.
    Body parameters
    ParameterTypeDescription
    bodyHCSMachineConfigPool schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPool schema
    201 - CreatedHCSMachineConfigPool schema
    401 - UnauthorizedEmpty

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

    HTTP method
    GET
    Description
    read status of the specified HCSMachineConfigPool
    HTTP responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPool schema
    401 - UnauthorizedEmpty
    HTTP method
    PATCH
    Description
    partially update status of the specified HCSMachineConfigPool
    Query parameters
    ParameterTypeDescription
    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 responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPool schema
    401 - UnauthorizedEmpty
    HTTP method
    PUT
    Description
    replace status of the specified HCSMachineConfigPool
    Query parameters
    ParameterTypeDescription
    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.
    Body parameters
    ParameterTypeDescription
    bodyHCSMachineConfigPool schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKHCSMachineConfigPool schema
    201 - CreatedHCSMachineConfigPool schema
    401 - UnauthorizedEmpty