Immutable Infrastructure

DCSMachine [infrastructure.cluster.x-k8s.io/v1beta1]

Description
DCSMachine is the Schema for the dcsmachines API.
Type
object

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

DCSMachineSpec defines the desired state of DCSMachine.

statusobject

DCSMachineStatus defines the observed state of DCSMachine.

.spec

Description
DCSMachineSpec defines the desired state of DCSMachine.
Type
object
Required
ipHostPoolRefvmTemplateName
PropertyTypeDescription
ipHostPoolRefobject

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

locationobject
providerIDstring
resourceobject
vmConfigobject
vmTemplateNamestring
vmUrnstring

.spec.ipHostPoolRef

Description
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
Type
object
PropertyTypeDescription
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.location

Type
object
Required
type
PropertyTypeDescription
namestring
typestring
urnstring

.spec.resource

Type
object
Required
type
PropertyTypeDescription
namestring
typestring
urnstring

.spec.vmConfig

Type
object
Required
dcsMachineCpuSpecdcsMachineMemorySpec
PropertyTypeDescription
cdRomDatastoreClusterNamestring
cdRomDatastoreNamestring
dcsMachineCpuSpecobject
dcsMachineDiskSpecarray
dcsMachineMemorySpecobject
dvSwitchNamestring
portGroupNamestring
portGroupUrnstring

.spec.vmConfig.dcsMachineCpuSpec

Type
object
Required
quantity
PropertyTypeDescription
quantityinteger

.spec.vmConfig.dcsMachineDiskSpec

Type
array

.spec.vmConfig.dcsMachineDiskSpec[]

Type
object
Required
quantity
PropertyTypeDescription
datastoreClusterNamestring
datastoreNamestring
datastoreUrnstring
formatstring
mountOptionsarray
optionsarray
pathstring
quantityinteger
systemVolumeboolean
wipeFilesystemboolean

.spec.vmConfig.dcsMachineDiskSpec[].mountOptions

Type
array

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

Type
string

.spec.vmConfig.dcsMachineDiskSpec[].options

Type
array

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

Type
string

.spec.vmConfig.dcsMachineMemorySpec

Type
object
Required
quantity
PropertyTypeDescription
quantityinteger

.status

Description
DCSMachineStatus defines the observed state of DCSMachine.
Type
object
PropertyTypeDescription
additionalNicarray
addressesarray

MachineAddresses is a slice of MachineAddress items to be used by infrastructure providers.

cdRomDatastoreUrnstring
cdRomFilestring
conditionsarray

Conditions provide observations of the operational state of a Cluster API resource.

failureDomainsobject

FailureDomains is a slice of FailureDomains.

networkConfigobject
readyboolean

.status.additionalNic

Type
array

.status.additionalNic[]

Type
object
PropertyTypeDescription
dnsstring
dvSwitchNamestring
gatewaystring
ipstring
ipv6string
maskstring
portGroupNamestring
portGroupUrnstring

.status.addresses

Description
MachineAddresses is a slice of MachineAddress items to be used by infrastructure providers.
Type
array

.status.addresses[]

Description
MachineAddress contains information for the node's address.
Type
object
Required
addresstype
PropertyTypeDescription
addressstring

address is the machine address.

typestring

type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.

.status.conditions

Description
Conditions provide observations of the operational state of a Cluster API resource.
Type
array

.status.conditions[]

Description
Condition defines an observation of a Cluster API resource operational state.
Type
object
Required
lastTransitionTimestatustype
PropertyTypeDescription
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 field may be empty.

reasonstring

reason is the reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may be empty.

severitystring

severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

statusstring

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

typestring

type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.failureDomains

Description
FailureDomains is a slice of FailureDomains.
Type
object

.status.networkConfig

Type
object
PropertyTypeDescription
additionNicarray
dnsstring
dvSwitchNamestring

DVSwitch name for multi-NIC support. If NIC's DVSwitchName or PortGroupName is nil, the VM template's DVSwitchName and PortGroupName will be used as fallback.

gatewaystring
hostnamestring
ipstring
ipv6string
machineNamestring
maskstring
portGroupNamestring
portGroupUrnstring

.status.networkConfig.additionNic

Type
array

.status.networkConfig.additionNic[]

Type
object
PropertyTypeDescription
dnsstring
dvSwitchNamestring
gatewaystring
ipstring
ipv6string
maskstring
portGroupNamestring
portGroupUrnstring

API Endpoints

The following API endpoints are available:

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

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

HTTP method
DELETE
Description
delete collection of DCSMachine
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind DCSMachine
HTTP responses
HTTP codeResponse body
200 - OKDCSMachineList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new DCSMachine
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
bodyDCSMachine schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKDCSMachine schema
201 - CreatedDCSMachine schema
202 - AcceptedDCSMachine schema
401 - UnauthorizedEmpty

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

HTTP method
DELETE
Description
delete the specified DCSMachine
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 DCSMachine
HTTP responses
HTTP codeResponse body
200 - OKDCSMachine schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified DCSMachine
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 - OKDCSMachine schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified DCSMachine
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
bodyDCSMachine schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKDCSMachine schema
201 - CreatedDCSMachine schema
401 - UnauthorizedEmpty

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

HTTP method
GET
Description
read status of the specified DCSMachine
HTTP responses
HTTP codeResponse body
200 - OKDCSMachine schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified DCSMachine
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 - OKDCSMachine schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified DCSMachine
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
bodyDCSMachine schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKDCSMachine schema
201 - CreatedDCSMachine schema
401 - UnauthorizedEmpty