NamespaceManagementClustersInfo

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

Properties

NamespaceManagementClustersKubernetesStatus Enum

kubernetes_status Required

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.

Possible values are: READY , WARNING , ERROR

string

api_server_cluster_endpoint Required

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.

string

api_server_management_endpoint Required

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.

array of string

api_servers Required

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

NamespaceManagementClustersStats

stat_summary Required

Basic runtime statistics for the cluster.

NamespaceManagementIpv4Cidr

service_cidr Required

CIDR block from which Kubernetes allocates service cluster IP addresses.

NamespaceManagementClustersNetworkProvider Enum

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

NamespaceManagementClustersConfigStatus Enum

config_status Required

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.

Possible values are: CONFIGURING , REMOVING , RUNNING , ERROR

array of NamespaceManagementClustersMessage

messages Required

Current set of messages associated with the object.

array of NamespaceManagementClustersMessage

kubernetes_status_messages Required

Current set of messages associated with the object.

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.

string

ephemeral_storage_policy Optional

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.

NamespaceManagementClustersImageStorageSpec

image_storage Optional

Specification for storage to be used for container images. This field is optional because it was added in a newer version than its parent node.

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, a default subscribed Content Library will be created. It will sync VMware-supplied images for Tanzu Kubernetes Grid over the internet. 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.

array of NamespaceManagementLoadBalancersInfo

load_balancers Optional

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.

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.

NamespaceManagementClustersNetworkSpec

master_management_network Optional

Specification for the management network on Kubernetes API server. This field is optional because it was added in a newer version than its parent node.

string

master_storage_policy Optional

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.

NamespaceManagementClustersImageRegistry

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.

NamespaceManagementClustersNCPClusterNetworkInfo

ncp_cluster_network_info Optional

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.

array of NamespaceManagementClustersCondition

conditions Optional

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.

NamespaceManagementCNSFileConfig

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, it means the file volume support is not enabled on this Supervisor.

NamespaceManagementSizingHint

size_hint Optional

Current setting for SizingHint. This affects the size and resources allocated to the Kubernetes API server. This field is optional because it was added in a newer version than its parent node.

NamespaceManagementProxyConfiguration

cluster_proxy_config Optional

Proxy configuration that is applied to the Supervisor. The proxy should be reachable from the management network and is used for image pulling and container traffic exiting out of the Supervisor. Note that the proxy password will be removed from the URLs as per Section 3.2.1 of RFC3986 security recommendation. This field is optional because it was added in a newer version than its parent node.

string

tls_endpoint_certificate Optional

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.

string

tls_management_endpoint_certificate Optional

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.

array of string

worker_DNS Optional

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.

NamespaceManagementClustersWorkloadNetworksInfo

workload_networks Optional

Information about workload networks associated with the cluster. This field is optional and it is only relevant when the value of Clusters.Info.network-provider is VSPHERE_NETWORK.

array of string

workload_ntp_servers Optional

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.

JSON Example

Show optional properties

{
	"api_server_cluster_endpoint": "string",
	"api_server_management_endpoint": "string",
	"api_servers": [
		"string"
	],
	"config_status": "CONFIGURING",
	"kubernetes_status": "READY",
	"kubernetes_status_messages": [
		{
			"severity": "INFO"
		}
	],
	"messages": [
		{
			"severity": "INFO"
		}
	],
	"network_provider": "NSXT_CONTAINER_PLUGIN",
	"service_cidr": {
		"address": "string",
		"prefix": 0
	},
	"stat_summary": {
		"cpu_capacity": 0,
		"cpu_used": 0,
		"memory_capacity": 0,
		"memory_used": 0,
		"storage_capacity": 0,
		"storage_used": 0
	}
}

{
	"Master_DNS_names": [
		"string"
	],
	"api_server_cluster_endpoint": "string",
	"api_server_management_endpoint": "string",
	"api_servers": [
		"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"
		]
	},
	"conditions": [
		{
			"description": {
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string",
				"localized": "string",
				"params": {
					"key": {
						"d": 0,
						"dt": "string",
						"format": "SHORT_DATE",
						"i": 0,
						"l": {
							"id": "string",
							"params": "StdLocalizationParam Object"
						},
						"precision": 0,
						"s": "string"
					}
				}
			},
			"last_transition_time": "string",
			"messages": [
				{
					"details": {
						"args": [
							"string"
						],
						"default_message": "string",
						"id": "string",
						"localized": "string",
						"params": {
							"key": {
								"d": 0,
								"dt": "string",
								"format": "SHORT_DATE",
								"i": 0,
								"l": {
									"id": "string",
									"params": "StdLocalizationParam Object"
								},
								"precision": 0,
								"s": "string"
							}
						}
					},
					"severity": "INFO"
				}
			],
			"reason": "string",
			"severity": "INFO",
			"status": "TRUE",
			"type": "string"
		}
	],
	"config_status": "CONFIGURING",
	"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"
	},
	"kubernetes_status": "READY",
	"kubernetes_status_messages": [
		{
			"details": {
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string",
				"localized": "string",
				"params": {
					"key": {
						"d": 0,
						"dt": "string",
						"format": "SHORT_DATE",
						"i": 0,
						"l": {
							"id": "string",
							"params": "StdLocalizationParam Object"
						},
						"precision": 0,
						"s": "string"
					}
				}
			},
			"severity": "INFO"
		}
	],
	"load_balancers": [
		{
			"address_ranges": [
				{
					"address": "string",
					"count": 0
				}
			],
			"avi_info": {
				"certificate_authority_chain": "string",
				"server": {
					"host": "string",
					"port": 0
				},
				"username": "string"
			},
			"ha_proxy_info": {
				"certificate_authority_chain": "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",
	"messages": [
		{
			"details": {
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string",
				"localized": "string",
				"params": {
					"key": {
						"d": 0,
						"dt": "string",
						"format": "SHORT_DATE",
						"i": 0,
						"l": {
							"id": "string",
							"params": "StdLocalizationParam Object"
						},
						"precision": 0,
						"s": "string"
					}
				}
			},
			"severity": "INFO"
		}
	],
	"ncp_cluster_network_info": {
		"cluster_distributed_switch": "string",
		"default_ingress_tls_certificate": "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",
	"stat_summary": {
		"cpu_capacity": 0,
		"cpu_used": 0,
		"memory_capacity": 0,
		"memory_used": 0,
		"storage_capacity": 0,
		"storage_used": 0
	},
	"tls_endpoint_certificate": "string",
	"tls_management_endpoint_certificate": "string",
	"worker_DNS": [
		"string"
	],
	"workload_networks": {
		"network_list": [
			{
				"namespaces": [
					"string"
				],
				"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": {
			"namespaces": [
				"string"
			],
			"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"
	]
}

Returned By

Get Clusters

NamespaceManagementClustersInfo

Properties

JSON Example

Returned By

Was this page helpful?