Developer Documentation

ClustersSetSpec

The Clusters.SetSpec structure contains the specification required to set a new configuration on the Cluster. This structure is applied in entirety, replacing the current specification fully.


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 be set to Docker Hub.

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 be set to Docker Hub official repository in case of Docker Hub image registry, otherwise will be set to empty string.

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 be cleared. 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.

required ephemeral_storage_policy string

Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. 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.

required image_storage ClustersImageStorageSpec

Specification for storage to be used for container images.

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 be cleared.

optional master_DNS array of string

List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. If unset, DNS servers set on Kubernetes API server will be cleared.

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 unset, DNS search domains set on Kubernetes API server will be cleared.

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 unset, VMware Tools based time synchronization is enabled and any set NTP servers are cleared.

required master_storage_policy string

Identifier of storage policy associated with Kubernetes API server. 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 ClustersNCPClusterNetworkSetSpec

Specification for the NSX Container Plugin cluster network. This field is optional and it is only relevant when the value of Clusters.SetSpec.network-provider is NSXT_CONTAINER_PLUGIN.

required network_provider ClustersNetworkProvider Enum

The provider of cluster networking for this vSphere Namespaces cluster.

required size_hint NamespaceManagementSizingHint Enum

This affects the size and resources allocated to the Kubernetes API server.

optional worker_DNS array of string

List of DNS server IP addresses to use on the worker nodes, specified in order of preference. If unset, DNS servers set on worker nodes will be cleared.

Parameter To


Set Clusters
Feedback

Was this page helpful?