NamespaceManagement_Clusters_Info
The Clusters.Info structure contains detailed information about the cluster statistics and status related to vSphere Namespaces.
{
"size_hint": "string",
"stat_summary": {
"cpu_used": 0,
"cpu_capacity": 0,
"memory_used": 0,
"memory_capacity": 0,
"storage_used": 0,
"storage_capacity": 0
},
"config_status": "string",
"conditions": [
{
"type": "string",
"description": {
"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"
},
"status": "string",
"last_transition_time": "string",
"reason": "string",
"severity": "string",
"messages": [
{
"severity": "string",
"details": "Std_LocalizableMessage Object",
"kb_article_link": "string",
"id": "string"
}
]
}
],
"messages": [
{
"severity": "string",
"details": "Std_LocalizableMessage Object",
"kb_article_link": "string",
"id": "string"
}
],
"kubernetes_status": "string",
"kubernetes_status_messages": [
{
"severity": "string",
"details": "Std_LocalizableMessage Object",
"kb_article_link": "string",
"id": "string"
}
],
"api_server_management_endpoint": "string",
"api_server_cluster_endpoint": "string",
"api_servers": [
"string"
],
"tls_management_endpoint_certificate": "string",
"tls_endpoint_certificate": "string",
"network_provider": "string",
"ncp_cluster_network_info": {
"pod_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"ingress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"egress_cidrs": [
{
"address": "string",
"prefix": 0
}
],
"cluster_distributed_switch": "string",
"nsx_edge_cluster": "string",
"default_ingress_tls_certificate": "string",
"nsx_tier0_gateway": "string",
"namespace_subnet_prefix": 0,
"routed_mode": false
},
"workload_networks": {
"supervisor_primary_workload_network": {
"network": "string",
"network_provider": "NamespaceManagement_Clusters_NetworkProvider Object",
"vsphere_network": {
"portgroup": "string",
"ip_assignment_mode": "string",
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"subnet_mask": "string"
},
"nsx_network": {
"namespace_network_cidrs": [
"NamespaceManagement_Ipv4Cidr Object"
],
"ingress_cidrs": [
"NamespaceManagement_Ipv4Cidr Object"
],
"egress_cidrs": [
"NamespaceManagement_Ipv4Cidr Object"
],
"nsx_tier0_gateway": "string",
"subnet_prefix_length": 0,
"routed_mode": false,
"load_balancer_size": "string"
},
"namespaces": [
"string"
]
},
"network_list": [
{
"network": "string",
"network_provider": "NamespaceManagement_Clusters_NetworkProvider Object",
"vsphere_network": {
"portgroup": "string",
"ip_assignment_mode": "string",
"address_ranges": [
{
"address": "string",
"count": 0
}
],
"gateway": "string",
"subnet_mask": "string"
},
"nsx_network": {
"namespace_network_cidrs": [
"NamespaceManagement_Ipv4Cidr Object"
],
"ingress_cidrs": [
"NamespaceManagement_Ipv4Cidr Object"
],
"egress_cidrs": [
"NamespaceManagement_Ipv4Cidr Object"
],
"nsx_tier0_gateway": "string",
"subnet_prefix_length": 0,
"routed_mode": false,
"load_balancer_size": "string"
},
"namespaces": [
"string"
]
}
]
},
"workload_ntp_servers": [
"string"
],
"load_balancers": [
{
"id": "string",
"address_ranges": [
"NamespaceManagement_IPRange Object"
],
"provider": "string",
"ha_proxy_info": {
"servers": [
{
"host": "string",
"port": 0
}
],
"username": "string",
"certificate_authority_chain": "string"
},
"avi_info": {
"server": "NamespaceManagement_LoadBalancers_Server Object",
"username": "string",
"certificate_authority_chain": "string",
"cloud_name": "string"
}
}
],
"service_cidr": {
"address": "string",
"prefix": 0
},
"master_management_network": {
"floating_IP": "string",
"network": "string",
"network_segment": {
"networks": [
"string"
]
},
"mode": "string",
"address_range": {
"starting_address": "string",
"address_count": 0,
"subnet_mask": "string",
"gateway": "string"
}
},
"master_DNS": [
"string"
],
"worker_DNS": [
"string"
],
"master_storage_policy": "string",
"ephemeral_storage_policy": "string",
"cns_file_config": {
"vsan_clusters": [
"string"
]
},
"login_banner": "string",
"Master_DNS_names": [
"string"
],
"image_storage": {
"storage_policy": "string"
},
"default_image_registry": {
"hostname": "string",
"port": 0
},
"default_image_repository": "string",
"master_DNS_search_domains": [
"string"
],
"master_NTP_servers": [
"string"
],
"default_kubernetes_service_content_library": "string",
"cluster_proxy_config": {
"proxy_settings_source": "string",
"https_proxy_config": "string",
"http_proxy_config": "string",
"no_proxy_config": [
"string"
],
"tls_root_ca_bundle": "string"
},
"content_libraries": [
{
"content_library": "string"
}
]
}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'.
The Clusters.Stats structure contains the basic runtime statistics about a vSphere Namespaces-enabled cluster.
The Clusters.ConfigStatus enumerated type describes the status of reaching the desired state configuration for the cluster.
CONFIGURING : The Namespace configuration is being applied to the cluster.
REMOVING : The Namespace configuration is being removed from the cluster.
RUNNING : The cluster is configured correctly with the Namespace configuration.
ERROR : Failed to apply the Namespace configuration to the cluster, user intervention needed.
The conditions that need to be met for the cluster to reach the desired state. This field is optional because it was added in a newer version than its parent node.
Current set of messages associated with the object.
The Clusters.KubernetesStatus enumerated type describes the cluster's ability to deploy pods.
READY : The cluster is able to accept pods.
WARNING : The cluster may be able to accept pods, but has warning messages.
ERROR : The cluster may not be able to accept pods and has error messages.
Current set of messages associated with the object.
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.
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.
Identifier of the Kubernetes API servers. These are the IP addresses of the VM instances for the Kubernetes control plane on the management network.
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. set only when Clusters.Info.api-server-management-endpoint is used.
PEM-encoded x509 certificate(s) used by TLS endpoint on Kubernetes API servers when accessed via the load balancer, e.g. devops user on corporate network. In case of a certificates chain, the order of the certificates in this field is important. The first certificate must be the leaf certificate for your domain name, the second the intermediate certificate(s) and the last one must be the root certificate.
set only when Clusters.Info.api-server-management-endpoint is used.
Identifies the network plugin that cluster networking functionalities for this vSphere Namespaces Cluster.
NSXT_CONTAINER_PLUGIN : NSX-T Container Plugin.
VSPHERE_NETWORK : vSphere Networking.
The Clusters.NCPClusterNetworkInfo structure contains the NSX Container Plugin-specific cluster networking configuration.
The Clusters.WorkloadNetworksInfo contains information related to configuration of vSphere Namespaces Network objects.
Information about NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference. unset when NTP server for Kubernetes API servers is used.
Information related to the Load balancer used for provisioning virtual servers in the namespace. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is VSPHERE_NETWORK.
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.
The Clusters.NetworkSpec contains information related to network configuration for one or more interfaces.
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.
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). If unset, no default DNS servers are set.
Identifier of storage policy associated with Kubernetes API server. This field is optional because it was added in a newer version than its parent node. 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.
Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. This field is optional because it was added in a newer version than its parent node. 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.
The CNSFileConfig structure contains the specification required to set the configuration for Cloud Native Storage file volume support on Supervisor.
Disclaimer to be displayed prior to login via the Kubectl plugin. If unset, just skip it.
List of 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 DNS names are embedded in the TLS certificate.
The Clusters.ImageStorageSpec structure contains the specification required to configure storage used for container images.
The Clusters.ImageRegistry structure contains the specification required to configure container image registry endpoint.
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.
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.
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.
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, no Content Library set for vSphere Kubernetes Service. 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.
The ProxyConfiguration structure defines proxy configuration to be used by the Supervisor.
List of Content Libraries associated with a Supervisor. This list refers to existing Content Libraries in the vSphere inventory. These Content Libraries and the Content Library items belonging to them are read-only across all vSphere Namespaces. This list does not overlap with the #defaultKubernetesServiceContentLibrary. If unset, no additional Content Libraries are set for the Supervisor apart from the default Kubernetes Service Content Library.