Developer Documentation

ClustersInfo

The Clusters.Info structure contains detailed information about the cluster statistics and status related to vSphere Namespaces.


Properties

Required Property Name Type Description
required api_server_cluster_endpoint string

Kubernetes API Server IP address via cluster network. This is the IP address of the Kubernetes LoadBalancer type service fronting the apiservers. This endpoint is the one configured in kubeconfig after login, and used for most human and application interaction with Kubernetes.

required api_server_management_endpoint string

Kubernetes API Server IP address on the management network. This is a floating IP and assigned to one of the control plane VMs on the management network. This endpoint is used by vSphere components.

required api_servers array of string

Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network.

required config_status ClustersConfigStatus Enum

Current setting for Clusters.ConfigStatus.

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. 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 kubernetes_status ClustersKubernetesStatus Enum

Current setting for Clusters.KubernetesStatus.

required kubernetes_status_messages array of ClustersMessage

Current set of messages associated with the object.

optional master_DNS array of string

List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference.

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.

required messages array of ClustersMessage

Current set of messages associated with the object.

optional ncp_cluster_network_info ClustersNCPClusterNetworkInfo

Specification for the NSX Container Plugin cluster network. This field is optional and it is only relevant when the value of Clusters.Info.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.

required stat_summary ClustersStats

Basic runtime statistics for the cluster.

optional tls_endpoint_certificate string

PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API servers when accessed via the load balancer, e.g. devops user on corporate network. This certificate is only valid for use with the apiServerClusterEndpoint.

optional tls_management_endpoint_certificate string

PEM-encoded x509 certificate used by TLS endpoint on Kubernetes API servers when accessed from the management network, e.g. from ESX servers or VCSA. This certificate is only valid for use with the apiServerManagementEndpoint.

optional worker_DNS array of string

List of DNS server IP addresses to use for pods that execute on the worker nodes (which are native pods on ESXi hosts in the vSphere Namespaces Supervisor).

Returned By


Get Clusters
Feedback

Was this page helpful?