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

描述
SSHMachineTemplate is the Schema for the sshmachinetemplates 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

SSHMachineTemplateSpec defines the desired state of SSHMachineTemplate.

statusobject

SSHMachineTemplateStatus defines the observed state of SSHMachineTemplate.

.spec

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

.spec.template

类型
object
属性类型描述
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

SSHMachineSpec defines the desired state of SSHMachine.

.spec.template.spec

描述
SSHMachineSpec defines the desired state of SSHMachine.
类型
object
属性类型描述
containerRuntimeobject
hostLabelSelectorobject

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

hostReferenceobject

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

providerIDstring

.spec.template.spec.containerRuntime

类型
object
必填
typeversion
属性类型描述
typestring
versionstring

.spec.template.spec.hostLabelSelector

描述
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
类型
object
属性类型描述
matchExpressionsarray

matchExpressions is a list of label selector requirements. The requirements are ANDed.

matchLabelsobject

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

.spec.template.spec.hostLabelSelector.matchExpressions

描述
matchExpressions is a list of label selector requirements. The requirements are ANDed.
类型
array

.spec.template.spec.hostLabelSelector.matchExpressions[]

描述
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
类型
object
必填
keyoperator
属性类型描述
keystring

key is the label key that the selector applies to.

operatorstring

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

valuesarray

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.template.spec.hostLabelSelector.matchExpressions[].values

描述
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
类型
array

.spec.template.spec.hostLabelSelector.matchExpressions[].values[]

类型
string

.spec.template.spec.hostLabelSelector.matchLabels

描述
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
类型
object

.spec.template.spec.hostReference

描述
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

.status

描述
SSHMachineTemplateStatus defines the observed state of SSHMachineTemplate.
类型
object

API 端点

可用的 API 端点如下:

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

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

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

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

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

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

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