• Русский
  • VSphereCluster [infrastructure.cluster.x-k8s.io/v1beta1]

    Description
    VSphereCluster is the Schema for the vsphereclusters API Deprecated: This type will be removed in one of the next releases.
    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

    VSphereClusterSpec defines the desired state of VSphereCluster.

    statusobject

    VSphereClusterStatus defines the observed state of VSphereClusterSpec.

    .spec

    Description
    VSphereClusterSpec defines the desired state of VSphereCluster.
    Type
    object
    PropertyTypeDescription
    cloudProviderConfigurationobject

    CloudProviderConfiguration holds the cluster-wide configuration for the vSphere cloud provider.

    Deprecated: will be removed in v1alpha4.

    controlPlaneEndpointobject

    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

    identityRefobject

    IdentityRef is a reference to either a Secret or VSphereClusterIdentity that contains the identity to use when reconciling the cluster.

    insecureboolean

    Insecure is a flag that controls whether to validate the vSphere server's certificate.

    Deprecated: will be removed in v1alpha4.

    loadBalancerRefobject

    LoadBalancerRef may be used to enable a control plane load balancer for this cluster. When a LoadBalancerRef is provided, the VSphereCluster.Status.Ready field will not be true until the referenced resource is Status.Ready and has a non-empty Status.Address value.

    Deprecated: will be removed in v1alpha4.

    serverstring

    Server is the address of the vSphere endpoint.

    thumbprintstring

    Thumbprint is the colon-separated SHA-1 checksum of the given vCenter server's host certificate When provided, Insecure should not be set to true

    .spec.cloudProviderConfiguration

    Description
    CloudProviderConfiguration holds the cluster-wide configuration for the vSphere cloud provider. Deprecated: will be removed in v1alpha4.
    Type
    object
    PropertyTypeDescription
    diskobject

    Disk is the vSphere cloud provider's disk configuration.

    globalobject

    Global is the vSphere cloud provider's global configuration.

    labelsobject

    Labels is the vSphere cloud provider's zone and region configuration.

    networkobject

    Network is the vSphere cloud provider's network configuration.

    providerConfigobject

    CPIProviderConfig contains extra information used to configure the vSphere cloud provider.

    virtualCenterobject

    VCenter is a list of vCenter configurations.

    workspaceobject

    Workspace is the vSphere cloud provider's workspace configuration.

    .spec.cloudProviderConfiguration.disk

    Description
    Disk is the vSphere cloud provider's disk configuration.
    Type
    object
    PropertyTypeDescription
    scsiControllerTypestring

    SCSIControllerType defines SCSI controller to be used.

    .spec.cloudProviderConfiguration.global

    Description
    Global is the vSphere cloud provider's global configuration.
    Type
    object
    PropertyTypeDescription
    apiBindPortstring

    APIBindPort configures the vSphere cloud controller manager API port. Defaults to 43001.

    apiDisableboolean

    APIDisable disables the vSphere cloud controller manager API. Defaults to true.

    caFilestring

    CAFile Specifies the path to a CA certificate in PEM format. If not configured, the system's CA certificates will be used.

    datacentersstring

    Datacenters is a CSV string of the datacenters in which VMs are located.

    insecureboolean

    Insecure is a flag that disables TLS peer verification.

    passwordstring

    Password is the password used to access a vSphere endpoint.

    portstring

    Port is the port on which the vSphere endpoint is listening. Defaults to 443.

    roundTripperCountinteger

    RoundTripperCount specifies the SOAP round tripper count (retries = RoundTripper - 1)

    secretNamestring

    SecretName is the name of the Kubernetes secret in which the vSphere credentials are located.

    secretNamespacestring

    SecretNamespace is the namespace for SecretName.

    secretsDirectorystring

    SecretsDirectory is a directory in which secrets may be found. This may be used in the event that:

    1. It is not desirable to use the K8s API to watch changes to secrets
    2. The cloud controller manager is not running in a K8s environment, such as DC/OS. For example, the container storage interface (CSI) is container orchestrator (CO) agnostic, and should support non-K8s COs. Defaults to /etc/cloud/credentials.
    serviceAccountstring

    ServiceAccount is the Kubernetes service account used to launch the cloud controller manager. Defaults to cloud-controller-manager.

    thumbprintstring

    Thumbprint is the cryptographic thumbprint of the vSphere endpoint's certificate.

    usernamestring

    Username is the username used to access a vSphere endpoint.

    .spec.cloudProviderConfiguration.labels

    Description
    Labels is the vSphere cloud provider's zone and region configuration.
    Type
    object
    PropertyTypeDescription
    regionstring

    Region is the region in which VMs are created/located.

    zonestring

    Zone is the zone in which VMs are created/located.

    .spec.cloudProviderConfiguration.network

    Description
    Network is the vSphere cloud provider's network configuration.
    Type
    object
    PropertyTypeDescription
    namestring

    Name is the name of the network to which VMs are connected.

    .spec.cloudProviderConfiguration.providerConfig

    Description
    CPIProviderConfig contains extra information used to configure the vSphere cloud provider.
    Type
    object
    PropertyTypeDescription
    cloudobject
    storageobject

    .spec.cloudProviderConfiguration.providerConfig.cloud

    Type
    object
    PropertyTypeDescription
    controllerImagestring
    extraArgsobject

    ExtraArgs passes through extra arguments to the cloud provider. The arguments here are passed to the cloud provider daemonset specification

    .spec.cloudProviderConfiguration.providerConfig.cloud.extraArgs

    Description
    ExtraArgs passes through extra arguments to the cloud provider. The arguments here are passed to the cloud provider daemonset specification
    Type
    object

    .spec.cloudProviderConfiguration.providerConfig.storage

    Type
    object
    PropertyTypeDescription
    attacherImagestring
    controllerImagestring
    livenessProbeImagestring
    metadataSyncerImagestring
    nodeDriverImagestring
    provisionerImagestring
    registrarImagestring

    .spec.cloudProviderConfiguration.virtualCenter

    Description
    VCenter is a list of vCenter configurations.
    Type
    object

    .spec.cloudProviderConfiguration.workspace

    Description
    Workspace is the vSphere cloud provider's workspace configuration.
    Type
    object
    PropertyTypeDescription
    datacenterstring

    Datacenter is the datacenter in which VMs are created/located.

    datastorestring

    Datastore is the datastore in which VMs are created/located.

    folderstring

    Folder is the folder in which VMs are created/located.

    resourcePoolstring

    ResourcePool is the resource pool in which VMs are created/located.

    serverstring

    Server is the IP address or FQDN of the vSphere endpoint.

    .spec.controlPlaneEndpoint

    Description
    ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
    Type
    object
    Required
    hostport
    PropertyTypeDescription
    hoststring

    The hostname on which the API server is serving.

    portinteger

    The port on which the API server is serving.

    .spec.identityRef

    Description
    IdentityRef is a reference to either a Secret or VSphereClusterIdentity that contains the identity to use when reconciling the cluster.
    Type
    object
    Required
    kindname
    PropertyTypeDescription
    kindstring

    Kind of the identity. Can either be VSphereClusterIdentity or Secret

    namestring

    Name of the identity.

    .spec.loadBalancerRef

    Description
    LoadBalancerRef may be used to enable a control plane load balancer for this cluster. When a LoadBalancerRef is provided, the VSphereCluster.Status.Ready field will not be true until the referenced resource is Status.Ready and has a non-empty Status.Address value. Deprecated: will be removed in v1alpha4.
    Type
    object
    PropertyTypeDescription
    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

    .status

    Description
    VSphereClusterStatus defines the observed state of VSphereClusterSpec.
    Type
    object
    PropertyTypeDescription
    conditionsarray

    Conditions defines current service state of the VSphereCluster.

    failureDomainsobject

    FailureDomains is a list of failure domain objects synced from the infrastructure provider.

    readyboolean

    .status.conditions

    Description
    Conditions defines current service state of the VSphereCluster.
    Type
    array

    .status.conditions[]

    Description
    Condition defines an observation of a Cluster API resource operational state.
    Type
    object
    Required
    statustype
    PropertyTypeDescription
    lastTransitionTimestring

    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

    A human readable message indicating details about the transition. This field may be empty.

    reasonstring

    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 not 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 list of failure domain objects synced from the infrastructure provider.
    Type
    object

    API Endpoints

    The following API endpoints are available:

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

    /apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vsphereclusters

    HTTP method
    DELETE
    Description
    delete collection of VSphereCluster
    HTTP responses
    HTTP codeResponse body
    200 - OKStatus schema
    401 - UnauthorizedEmpty
    HTTP method
    GET
    Description
    list objects of kind VSphereCluster
    HTTP responses
    HTTP codeResponse body
    200 - OKVSphereClusterList schema
    401 - UnauthorizedEmpty
    HTTP method
    POST
    Description
    create a new VSphereCluster
    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
    bodyVSphereCluster schemaapplication/json formatted
    HTTP responses
    HTTP codeResponse body
    200 - OKVSphereCluster schema
    201 - CreatedVSphereCluster schema
    202 - AcceptedVSphereCluster schema
    401 - UnauthorizedEmpty

    /apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vsphereclusters/{name}

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

    /apis/infrastructure.cluster.x-k8s.io/v1alpha3/namespaces/{namespace}/vsphereclusters/{name}/status

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