Immutable Infrastructure
  • 简体中文

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

    描述
    SSHHost is the Schema for the sshhosts 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

    SSHHostSpec defines the desired state of SSHHost.

    statusobject

    SSHHostStatus defines the observed state of SSHHost.

    .spec

    描述
    SSHHostSpec defines the desired state of SSHHost.
    类型
    object
    属性类型描述
    authCredentialobject

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

    ipstring
    ipv6string
    portinteger
    publicIpstring
    reUseboolean

    .spec.authCredential

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

    描述
    SSHHostStatus defines the observed state of SSHHost.
    类型
    object
    属性类型描述
    conditionsarray

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

    failureMessagestring
    nodeInfoobject

    NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

    nodeRefobject

    ObjectReference contains enough information to let you inspect or modify the referred object.

    phasestring

    .status.conditions

    描述
    Conditions provide observations of the operational state of a Cluster API resource.
    类型
    array

    .status.conditions[]

    描述
    Condition defines an observation of a Cluster API resource operational state.
    类型
    object
    必填
    lastTransitionTimestatustype
    属性类型描述
    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.nodeInfo

    描述
    NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
    类型
    object
    必填
    architecturebootIDcontainerRuntimeVersionkernelVersionkubeProxyVersionkubeletVersionmachineIDoperatingSystemosImagesystemUUID
    属性类型描述
    architecturestring

    The Architecture reported by the node

    bootIDstring

    Boot ID reported by the node.

    containerRuntimeVersionstring

    ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).

    kernelVersionstring

    Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).

    kubeProxyVersionstring

    Deprecated: KubeProxy Version reported by the node.

    kubeletVersionstring

    Kubelet Version reported by the node.

    machineIDstring

    MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html

    operatingSystemstring

    The Operating System reported by the node

    osImagestring

    OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

    swapobject

    Swap Info reported by the node.

    systemUUIDstring

    SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid

    .status.nodeInfo.swap

    描述
    Swap Info reported by the node.
    类型
    object
    属性类型描述
    capacityinteger

    Total amount of swap memory in bytes.

    .status.nodeRef

    描述
    ObjectReference contains enough information to let you inspect or modify the referred object.
    类型
    object
    属性类型描述
    apiVersionstring

    API version of the referent.

    fieldPathstring

    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

    kindstring

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

    namestring

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

    namespacestring

    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

    resourceVersionstring

    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

    uidstring

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

    API 端点

    可用的 API 端点如下：

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

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

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

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

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

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

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