Developer Documentation

ClustersEnableSpec

The Clusters.EnableSpec structure contains the specification required to enable vSphere Namespaces on a cluster.


Properties

Required Property Name Type Description
optional Master_DNS_names array of string

List of additional DNS names to associate with the Kubernetes API server. These DNS names are embedded in the TLS certificate presented by the API server. If unset, no additional DNS names are embedded in the TLS certificate.

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, defaults 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, defaults to Docker Hub official repository in case of Docker Hub image registry, otherwise defaults 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. If unset, the Content Library identifier will not be set. 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, just skip it.

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, no default DNS servers are set.

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, no default DNS search domains are set.

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.

required master_management_network ClustersNetworkSpec

Specification for the management network on Kubernetes API server. Clusters.NetworkSpec.mode must be STATICRANGE as we require Kubernetes API server to have a stable address.

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 ClustersNCPClusterNetworkEnableSpec

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

required network_provider ClustersNetworkProvider Enum

The provider of cluster networking for this vSphere Namespaces cluster.

required service_cidr NamespaceManagementIpv4Cidr

CIDR block from which Kubernetes allocates service cluster IP addresses. This range should not overlap with those in com.vmware.vcenter.namespace_management.NCPClusterNetworkEnableSpec#podCidrs, com.vmware.vcenter.namespace_management.NCPClusterNetworkEnableSpec#ingressCidrs, com.vmware.vcenter.namespace_management.NCPClusterNetworkEnableSpec#egressCidrs, or other services running in the datacenter.

required size_hint NamespaceManagementSizingHint Enum

This affects the size and resources allocated to the Kubernetes API server and the worker nodes. It also affects the suggested default serviceCidr and podCidrs.

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, no default DNS servers are set.

Parameter To


Enable Clusters
Feedback

Was this page helpful?