Enable Cluster

Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.

Request

URI

POST

https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}__action=enable

COPY

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.

Request Body

NamespaceManagement_Clusters_EnableSpec of type(s) application/json

Required

Show optional properties

{
    "size_hint": "string",
    "service_cidr": {
        "address": "string",
        "prefix": 0
    },
    "network_provider": "string",
    "master_management_network": {
        "network": "string",
        "mode": "string"
    },
    "master_storage_policy": "string",
    "ephemeral_storage_policy": "string",
    "image_storage": {
        "storage_policy": "string"
    }
}

{
    "size_hint": "string",
    "service_cidr": {
        "address": "string",
        "prefix": 0
    },
    "network_provider": "string",
    "ncp_cluster_network_spec": {
        "pod_cidrs": [
            "NamespaceManagement_Ipv4Cidr Object"
        ],
        "ingress_cidrs": [
            "NamespaceManagement_Ipv4Cidr Object"
        ],
        "egress_cidrs": [
            "NamespaceManagement_Ipv4Cidr Object"
        ],
        "cluster_distributed_switch": "string",
        "nsx_edge_cluster": "string"
    },
    "workload_networks_spec": {
        "supervisor_primary_workload_network": {
            "network": "string",
            "network_provider": "NamespaceManagement_Clusters_NetworkProvider Object",
            "vsphere_network": {
                "portgroup": "string",
                "address_ranges": [
                    {
                        "address": "string",
                        "count": 0
                    }
                ],
                "gateway": "string",
                "subnet_mask": "string"
            }
        },
        "network_list": [
            {
                "network": "string",
                "network_provider": "NamespaceManagement_Clusters_NetworkProvider Object",
                "vsphere_network": {
                    "portgroup": "string",
                    "address_ranges": [
                        {
                            "address": "string",
                            "count": 0
                        }
                    ],
                    "gateway": "string",
                    "subnet_mask": "string"
                }
            }
        ]
    },
    "workload_ntp_servers": [
        "string"
    ],
    "load_balancer_config_spec": {
        "id": "string",
        "address_ranges": [
            "NamespaceManagement_IPRange Object"
        ],
        "provider": "string",
        "ha_proxy_config_create_spec": {
            "servers": [
                {
                    "host": "string",
                    "port": 0
                }
            ],
            "username": "string",
            "password": "string",
            "certificate_authority_chain": "string"
        },
        "avi_config_create_spec": {
            "server": "NamespaceManagement_LoadBalancers_Server Object",
            "username": "string",
            "password": "string",
            "certificate_authority_chain": "string"
        }
    },
    "master_management_network": {
        "floating_IP": "string",
        "network": "string",
        "mode": "string",
        "address_range": {
            "starting_address": "string",
            "address_count": 0,
            "subnet_mask": "string",
            "gateway": "string"
        }
    },
    "master_DNS": [
        "string"
    ],
    "worker_DNS": [
        "string"
    ],
    "master_DNS_search_domains": [
        "string"
    ],
    "master_NTP_servers": [
        "string"
    ],
    "master_storage_policy": "string",
    "ephemeral_storage_policy": "string",
    "login_banner": "string",
    "Master_DNS_names": [
        "string"
    ],
    "image_storage": {
        "storage_policy": "string"
    },
    "default_image_registry": {
        "hostname": "string",
        "port": 0
    },
    "default_image_repository": "string",
    "default_kubernetes_service_content_library": "string"
}

NamespaceManagement_SizingHint

size_hint

Required

The SizingHint enumerated type determines the configuration of Kubernetes API server and the worker nodes. It also determines the default values associated with the maximum number of pods and services. Use ClusterSizeInfo.get to get information associated with a SizingHint.
TINY : Cluster size of 'tiny'.
SMALL : Cluster size of 'small'.
MEDIUM : Cluster size of 'medium'.
LARGE : Cluster size of 'large'.

NamespaceManagement_Ipv4Cidr

service_cidr

Required

The Ipv4Cidr structure contains the specification for representing CIDR notation of IP range. For example, this can be used to represent 256 IP addresses using 10.10.10.0/24.

NamespaceManagement_Clusters_NetworkProvider

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.

NamespaceManagement_Clusters_NCPClusterNetworkEnableSpec

ncp_cluster_network_spec

Optional

The Clusters.NCPClusterNetworkEnableSpec structure encapsulates the NSX Container Plugin-specific cluster networking configuration parameters for the vSphere Namespaces Cluster Enable operation.

NamespaceManagement_Clusters_WorkloadNetworksEnableSpec

workload_networks_spec

Optional

The Clusters.WorkloadNetworksEnableSpec contains the specification required to configure workload networks for a vSphere Namespaces Cluster during Enable operation. These workload networks will be used as backing network for Tanzu Kubernetes Cluster VMs and Kubernetes control plane VMs.

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.

NamespaceManagement_LoadBalancers_ConfigSpec

load_balancer_config_spec

Optional

The LoadBalancers.ConfigSpec encapsulates load balancer configuration on vSphere Namespaces.

NamespaceManagement_Clusters_NetworkSpec

master_management_network

Required

The Clusters.NetworkSpec contains information related to network configuration for one or more interfaces.

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

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.

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

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.

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.

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_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.

NamespaceManagement_Clusters_ImageStorageSpec

image_storage

Required

The Clusters.ImageStorageSpec structure contains the specification required to configure storage used for container images.

NamespaceManagement_Clusters_ImageRegistry

default_image_registry

Optional

The Clusters.ImageRegistry structure contains the specification required to configure container image registry endpoint.

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.

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

Authentication

This operation uses the following authentication methods.

api_key

Responses

204

Operation doesn't return any data structure

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.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

Stack of one or more localizable messages for human error consumers. The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully. Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports. The ArgumentLocations, FileLocations, and TransientIndication structures are intended as possible values for this field. DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some services may provide their own specific structures for use as the value of this field when reporting errors from their operations.

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

Enumeration of all standard errors. Used as discriminator in protocols that have no standard means for transporting the error type, e.g. REST.
ERROR : Discriminator for the Error type.
ALREADY_EXISTS : Discriminator for the AlreadyExists type.
ALREADY_IN_DESIRED_STATE : Discriminator for the AlreadyInDesiredState type.
CANCELED : Discriminator for the Canceled type.
CONCURRENT_CHANGE : Discriminator for the ConcurrentChange type.
FEATURE_IN_USE : Discriminator for the FeatureInUse type.
INTERNAL_SERVER_ERROR : Discriminator for the InternalServerError type.
INVALID_ARGUMENT : Discriminator for the InvalidArgument type.
INVALID_ELEMENT_CONFIGURATION : Discriminator for the InvalidElementConfiguration type.
INVALID_ELEMENT_TYPE : Discriminator for the InvalidElementType type.
INVALID_REQUEST : Discriminator for the InvalidRequest type.
NOT_ALLOWED_IN_CURRENT_STATE : Discriminator for the NotAllowedInCurrentState type.
NOT_FOUND : Discriminator for the NotFound type.
OPERATION_NOT_FOUND : Discriminator for the OperationNotFound type.
RESOURCE_BUSY : Discriminator for the ResourceBusy type.
RESOURCE_IN_USE : Discriminator for the ResourceInUse type.
RESOURCE_INACCESSIBLE : Discriminator for the ResourceInaccessible type.
SERVICE_UNAVAILABLE : Discriminator for the ServiceUnavailable type.
TIMED_OUT : Discriminator for the TimedOut type.
UNABLE_TO_ALLOCATE_RESOURCE : Discriminator for the UnableToAllocateResource type.
UNAUTHENTICATED : Discriminator for the Unauthenticated type.
UNAUTHORIZED : Discriminator for the Unauthorized type.
UNEXPECTED_INPUT : Discriminator for the UnexpectedInput type.
UNSUPPORTED : Discriminator for the Unsupported type.
UNVERIFIED_PEER : Discriminator for the UnverifiedPeer type.

401

com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

403

com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

404

com.vmware.vapi.std.errors.not_found : if resources/objects could not be located.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional

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.

Returns Std_Errors_Error of type(s) application/json

{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": {
                        "id": "string",
                        "params": {
                            "params": "Std_LocalizationParam Object"
                        }
                    },
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

array of Std_LocalizableMessage

messages

Required

object

data

Optional

Some operations will not set this field when reporting errors.

Std_Errors_Error_Type

error_type

Optional