Developer Documentation

ClustersUpdateSpec

The Clusters.UpdateSpec structure contains the specification required to update the configuration on the Cluster. This structure is applied partially, and only the specified fields will replace or modify their existing counterparts.


Properties

Required Property Name Type Description
optional default_image_registry ClustersImageRegistry

Default image registry to use when Kubernetes Pod container specification does not specify it as part of the container image name. If unset, default image registry will not be modified.

optional default_image_repository string

Default image repository to use when Kubernetes Pod container specification does not specify it as part of the container image name. If unset, default image repository will not be modified.

optional default_kubernetes_service_content_library string

Identifier of the Content Library which holds the VM Images for vSphere Kubernetes Service. This Content Library should be subscribed to VMware’s hosted vSphere Kubernetes Service Repository. Modifying or clearing the Content Library identifier will not affect existing vSphere Kubernetes Service clusters. However, upgrades or scale-out of existing clusters may be affected if the new Content Library doesn’t have the necessary VM Images. If unset, the Content Library identifier will not be modified. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.content.Library.

optional ephemeral_storage_policy string

Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. If unset, storage policy associated with ephemeral disks of all the Kubernetes Pods will not be modified. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.

optional image_storage ClustersImageStorageSpec

Specification for storage to be used for container images. If unset, configuration of storage used for container images is not modified.

optional login_banner string

Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, disclaimer to be displayed prior to login via the Kubectl plugin will not be modified.

optional master_DNS array of string

List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. If set, DNS servers set on Kubernetes API server will be replaced. Otherwise, they will not be modified.

optional master_DNS_search_domains array of string

List of domains (for example “vmware.com”) to be searched when trying to lookup a host name on Kubernetes API server, specified in order of preference. If set, DNS search domains on Kubernetes API server will be replaced. Otherwise, they will not be modified.

optional master_NTP_servers array of string

List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference. If set, NTP servers on Kubernetes API server will be replaced. Otherwise, they will not be modified.

optional master_storage_policy string

Identifier of storage policy associated with Kubernetes API server. If unset, storage policy associated with Kubernetes API server will not be modified. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.

optional ncp_cluster_network_spec ClustersNCPClusterNetworkUpdateSpec

Updated specification for the cluster network configuration. If unset, existing effective value will not be modified If unset, the existing effective cluster network specification will not be modified.

optional network_provider ClustersNetworkProvider Enum

The provider of cluster networking for this vSphere Namespaces cluster. If unset, the existing effective cluster network specification will not be modified.

optional size_hint NamespaceManagementSizingHint Enum

This affects the size and resources allocated to the Kubernetes API server. If unset, size and resources allocated to Kubernetes API server will not be modified.

optional tls_endpoint_certificate string

Certificate issued for Kubernetes API Server. Certificate used must be created by signing the Certificate Signing Request obtained from com.vmware.vcenter.namespace_management.certificates.Request.create Because a CertificateSigningRequest is created on an existing Namespaces-enabled Cluster, you must use the Clusters.UpdateSpec to specify this tlsEndpointCertificate on an existing Cluster rather than during initially enabling Namespaces on a Cluster. If unset, Kubernetes API Server certificate will not be modified.

optional worker_DNS array of string

List of DNS server IP addresses to use on the worker nodes, specified in order of preference. If set, DNS servers set on worker nodes will be replaced. Otherwise, they will not be modified.

Parameter To


Update Clusters
Feedback

Was this page helpful?