Enable Clusters
Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}?action=enable
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster on which vSphere Namespaces will be enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
NamespaceManagementClustersEnableSpec of mimetype application/json
Required
Specification for setting up the Kubernetes API server and the worker nodes.
{
"ephemeral_storage_policy": "string",
"image_storage": {
"storage_policy": "string"
},
"master_management_network": {
"mode": "DHCP",
"network": "string"
},
"master_storage_policy": "string",
"network_provider": "NSXT_CONTAINER_PLUGIN",
"service_cidr": {
"address": "string",
"prefix": 0
},
"size_hint": "enum"
}
image_storage
Required
Specification for storage to be used for container images.
size_hint
Required
This affects the size and resources allocated to the Kubernetes API server. It also affects the suggested default serviceCidr and podCidrs.
Possible values are: TINY , SMALL , MEDIUM , LARGE
service_cidr
Required
CIDR block from which Kubernetes allocates service cluster IP addresses. This range should not overlap with those in Clusters.NCPClusterNetworkEnableSpec.pod-cidrs, Clusters.NCPClusterNetworkEnableSpec.ingress-cidrs, Clusters.NCPClusterNetworkEnableSpec.egress-cidrs, or other services running in the datacenter.
network_provider
Required
Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster.
NSXT_CONTAINER_PLUGIN : NSX-T Container Plugin.
VSPHERE_NETWORK : vSphere Networking.
Possible values are: NSXT_CONTAINER_PLUGIN , VSPHERE_NETWORK
string
master_storage_policy
Required
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.
master_management_network
Required
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.
string
ephemeral_storage_policy
Required
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.
array of
string
Master_DNS_names
Optional
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.
load_balancer_config_spec
Optional
The load balancer configuration is derived from the user-provisioned load balancer that will be used to operate a load balancer that fronts vSphere Namespaces cluster servers, Tanzu Kubernetes Grid API servers, and other servers upon request. This configuration is required for network providers that do not have a default load balancer included. This field is optional and it is only relevant when the value of Clusters.EnableSpec.network-provider is VSPHERE_NETWORK.
string
login_banner
Optional
Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, just skip it.
array of
string
master_DNS
Optional
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.
array of
string
master_DNS_search_domains
Optional
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.
array of
string
master_NTP_servers
Optional
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.
string
default_kubernetes_service_content_library
Optional
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 will be automatically generated and configured to the cluster. 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.
string
default_image_repository
Optional
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.
ncp_cluster_network_spec
Optional
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.
default_image_registry
Optional
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.
cns_file_config
Optional
Specification for configuring Cloud Native Storage file volume support on Supervisor. This feature provides support for provisioning ReadWriteMany persistent volumes on this cluster and/or external clusters. If unset, file volume support will not be enabled on this Supervisor.
cluster_proxy_config
Optional
Proxy configuration that will be applied to the Supervisor. The proxy should be reachable from the management network and will be used for image pulling and container traffic exiting out of the Supervisor. If unset the settings will be inherited from the vCenter settings if available.
array of
string
worker_DNS
Optional
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.
workload_networks_spec
Optional
Specification for the workload networks to be associated with the cluster. This field is optional and it is only relevant when the value of Clusters.EnableSpec.network-provider is VSPHERE_NETWORK.
array of
string
workload_ntp_servers
Optional
List of NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference. If unset, NTP server for Kubernetes API servers will be used.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.already_exists : if the cluster already has vSphere Namespaces enabled. | com.vmware.vapi.std.errors.invalid_argument : if spec contain any errors. | com.vmware.vapi.std.errors.unsupported : if the specified cluster is not supported for vSphere Namespaces, the cluster’s hosts do not have the required ESX version, or for any other incompatibilities.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the specified cluster is not licensed or resource pool reservation for control plane VMs fails.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$NamespaceManagementIpv4Cidr = Initialize-NamespaceManagementIpv4Cidr -Address "MyAddress" -Prefix 0
$NamespaceManagementClustersNetworkSpec = Initialize-NamespaceManagementClustersNetworkSpec -Network "MyNetwork" -Mode "DHCP"
$NamespaceManagementClustersImageStorageSpec = Initialize-NamespaceManagementClustersImageStorageSpec -StoragePolicy "MyStoragePolicy"
$NamespaceManagementClustersEnableSpec = Initialize-NamespaceManagementClustersEnableSpec -SizeHint "TINY" -ServiceCidr $NamespaceManagementIpv4Cidr -NetworkProvider "NSXT_CONTAINER_PLUGIN" -MasterManagementNetwork $NamespaceManagementClustersNetworkSpec -MasterStoragePolicy "MyMasterStoragePolicy" -EphemeralStoragePolicy "MyEphemeralStoragePolicy" -ImageStorage $NamespaceManagementClustersImageStorageSpec
Invoke-EnableCluster -Cluster "MyCluster" -NamespaceManagementClustersEnableSpec $NamespaceManagementClustersEnableSpec
PowerCLI Client SDK All Parameters Example
$NamespaceManagementIpv4Cidr = Initialize-NamespaceManagementIpv4Cidr -Address "MyAddress" -Prefix 0
$NamespaceManagementClustersNCPClusterNetworkEnableSpec = Initialize-NamespaceManagementClustersNCPClusterNetworkEnableSpec -PodCidrs $NamespaceManagementIpv4Cidr -IngressCidrs $NamespaceManagementIpv4Cidr -EgressCidrs $NamespaceManagementIpv4Cidr -ClusterDistributedSwitch "MyClusterDistributedSwitch" -NsxEdgeCluster "MyNsxEdgeCluster" -NsxTier0Gateway "MyNsxTier0Gateway" -NamespaceSubnetPrefix 0 -RoutedMode $false
$NamespaceManagementIPRange = Initialize-NamespaceManagementIPRange -Address "MyAddress" -Count 0
$NamespaceManagementNetworksVsphereDVPGNetworkCreateSpec = Initialize-NamespaceManagementNetworksVsphereDVPGNetworkCreateSpec -Portgroup "MyPortgroup" -IpAssignmentMode "DHCP" -AddressRanges $NamespaceManagementIPRange -Gateway "MyGateway" -SubnetMask "MySubnetMask"
$NamespaceManagementNetworksNsxNetworkCreateSpec = Initialize-NamespaceManagementNetworksNsxNetworkCreateSpec -NamespaceNetworkCidrs $NamespaceManagementIpv4Cidr -IngressCidrs $NamespaceManagementIpv4Cidr -EgressCidrs $NamespaceManagementIpv4Cidr -NsxTier0Gateway "MyNsxTier0Gateway" -SubnetPrefixLength 0 -RoutedMode $false -LoadBalancerSize "SMALL"
$NamespaceManagementNetworksCreateSpec = Initialize-NamespaceManagementNetworksCreateSpec -Network "MyNetwork" -NetworkProvider "NSXT_CONTAINER_PLUGIN" -VsphereNetwork $NamespaceManagementNetworksVsphereDVPGNetworkCreateSpec -NsxNetwork $NamespaceManagementNetworksNsxNetworkCreateSpec
$NamespaceManagementClustersWorkloadNetworksEnableSpec = Initialize-NamespaceManagementClustersWorkloadNetworksEnableSpec -SupervisorPrimaryWorkloadNetwork $NamespaceManagementNetworksCreateSpec -NetworkList $NamespaceManagementNetworksCreateSpec
$NamespaceManagementLoadBalancersServer = Initialize-NamespaceManagementLoadBalancersServer -VarHost "MyVarHost" -Port 0
$NamespaceManagementLoadBalancersHAProxyConfigCreateSpec = Initialize-NamespaceManagementLoadBalancersHAProxyConfigCreateSpec -Servers $NamespaceManagementLoadBalancersServer -Username "MyUsername" -Password "MyPassword" -CertificateAuthorityChain "MyCertificateAuthorityChain"
$NamespaceManagementLoadBalancersAviConfigCreateSpec = Initialize-NamespaceManagementLoadBalancersAviConfigCreateSpec -Server $NamespaceManagementLoadBalancersServer -Username "MyUsername" -Password "MyPassword" -CertificateAuthorityChain "MyCertificateAuthorityChain"
$NamespaceManagementLoadBalancersConfigSpec = Initialize-NamespaceManagementLoadBalancersConfigSpec -Id "MyId" -AddressRanges $NamespaceManagementIPRange -Provider "HA_PROXY" -HaProxyConfigCreateSpec $NamespaceManagementLoadBalancersHAProxyConfigCreateSpec -AviConfigCreateSpec $NamespaceManagementLoadBalancersAviConfigCreateSpec
$NamespaceManagementClustersIpv4Range = Initialize-NamespaceManagementClustersIpv4Range -StartingAddress "MyStartingAddress" -AddressCount 0 -SubnetMask "MySubnetMask" -Gateway "MyGateway"
$NamespaceManagementClustersNetworkSpec = Initialize-NamespaceManagementClustersNetworkSpec -FloatingIP "MyFloatingIP" -Network "MyNetwork" -Mode "DHCP" -AddressRange $NamespaceManagementClustersIpv4Range
$NamespaceManagementCNSFileConfig = Initialize-NamespaceManagementCNSFileConfig -VsanClusters "MyVsanClusters"
$NamespaceManagementClustersImageStorageSpec = Initialize-NamespaceManagementClustersImageStorageSpec -StoragePolicy "MyStoragePolicy"
$NamespaceManagementClustersImageRegistry = Initialize-NamespaceManagementClustersImageRegistry -Hostname "MyHostname" -Port 0
$NamespaceManagementProxyConfiguration = Initialize-NamespaceManagementProxyConfiguration -ProxySettingsSource "VC_INHERITED" -HttpsProxyConfig "MyHttpsProxyConfig" -HttpProxyConfig "MyHttpProxyConfig" -NoProxyConfig "MyNoProxyConfig" -TlsRootCaBundle "MyTlsRootCaBundle"
$NamespaceManagementClustersEnableSpec = Initialize-NamespaceManagementClustersEnableSpec -SizeHint "TINY" -ServiceCidr $NamespaceManagementIpv4Cidr -NetworkProvider "NSXT_CONTAINER_PLUGIN" -NcpClusterNetworkSpec $NamespaceManagementClustersNCPClusterNetworkEnableSpec -WorkloadNetworksSpec $NamespaceManagementClustersWorkloadNetworksEnableSpec -WorkloadNtpServers "MyWorkloadNtpServers" -LoadBalancerConfigSpec $NamespaceManagementLoadBalancersConfigSpec -MasterManagementNetwork $NamespaceManagementClustersNetworkSpec -MasterDNS "MyMasterDNS" -WorkerDNS "MyWorkerDNS" -MasterDNSSearchDomains "MyMasterDNSSearchDomains" -MasterNTPServers "MyMasterNTPServers" -MasterStoragePolicy "MyMasterStoragePolicy" -EphemeralStoragePolicy "MyEphemeralStoragePolicy" -CnsFileConfig $NamespaceManagementCNSFileConfig -LoginBanner "MyLoginBanner" -MasterDNSNames "MyMasterDNSNames" -ImageStorage $NamespaceManagementClustersImageStorageSpec -DefaultImageRegistry $NamespaceManagementClustersImageRegistry -DefaultImageRepository "MyDefaultImageRepository" -DefaultKubernetesServiceContentLibrary "MyDefaultKubernetesServiceContentLibrary" -ClusterProxyConfig $NamespaceManagementProxyConfiguration
Invoke-EnableCluster -Cluster "MyCluster" -NamespaceManagementClustersEnableSpec $NamespaceManagementClustersEnableSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"Master_DNS_names":["string"],"cluster_proxy_config":{"http_proxy_config":"string","https_proxy_config":"string","no_proxy_config":["string"],"proxy_settings_source":"VC_INHERITED","tls_root_ca_bundle":"string"},"cns_file_config":{"vsan_clusters":["string"]},"default_image_registry":{"hostname":"string","port":0},"default_image_repository":"string","default_kubernetes_service_content_library":"string","ephemeral_storage_policy":"string","image_storage":{"storage_policy":"string"},"load_balancer_config_spec":{"address_ranges":[{"address":"string","count":0}],"avi_config_create_spec":{"certificate_authority_chain":"string","password":"string","server":{"host":"string","port":0},"username":"string"},"ha_proxy_config_create_spec":{"certificate_authority_chain":"string","password":"string","servers":[{"host":"string","port":0}],"username":"string"},"id":"string","provider":"HA_PROXY"},"login_banner":"string","master_DNS":["string"],"master_DNS_search_domains":["string"],"master_NTP_servers":["string"],"master_management_network":{"address_range":{"address_count":0,"gateway":"string","starting_address":"string","subnet_mask":"string"},"floating_IP":"string","mode":"DHCP","network":"string"},"master_storage_policy":"string","ncp_cluster_network_spec":{"cluster_distributed_switch":"string","egress_cidrs":[{"address":"string","prefix":0}],"ingress_cidrs":[{"address":"string","prefix":0}],"namespace_subnet_prefix":0,"nsx_edge_cluster":"string","nsx_tier0_gateway":"string","pod_cidrs":[{"address":"string","prefix":0}],"routed_mode":false},"network_provider":"NSXT_CONTAINER_PLUGIN","service_cidr":{"address":"string","prefix":0},"size_hint":"enum","worker_DNS":["string"],"workload_networks_spec":{"network_list":[{"network":"string","network_provider":"enum","nsx_network":{"egress_cidrs":[{"address":"string","prefix":0}],"ingress_cidrs":[{"address":"string","prefix":0}],"load_balancer_size":"SMALL","namespace_network_cidrs":[{"address":"string","prefix":0}],"nsx_tier0_gateway":"string","routed_mode":false,"subnet_prefix_length":0},"vsphere_network":{"address_ranges":[{"address":"string","count":0}],"gateway":"string","ip_assignment_mode":"DHCP","portgroup":"string","subnet_mask":"string"}}],"supervisor_primary_workload_network":{"network":"string","network_provider":"enum","nsx_network":{"egress_cidrs":[{"address":"string","prefix":0}],"ingress_cidrs":[{"address":"string","prefix":0}],"load_balancer_size":"SMALL","namespace_network_cidrs":[{"address":"string","prefix":0}],"nsx_tier0_gateway":"string","routed_mode":false,"subnet_prefix_length":0},"vsphere_network":{"address_ranges":[{"address":"string","count":0}],"gateway":"string","ip_assignment_mode":"DHCP","portgroup":"string","subnet_mask":"string"}}},"workload_ntp_servers":["string"]}' https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}?action=enable
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: enable
Availability
Added in 7.0.0.0
On This Page
Clusters Operations
get
get
put
patch
post
post
