com.vmware.vcenter.namespace_management

Class ClustersTypes.UpdateSpec.Builder

java.lang.Object

com.vmware.vcenter.namespace_management.ClustersTypes.UpdateSpec.Builder

Enclosing class:

ClustersTypes.UpdateSpec

public static final class ClustersTypes.UpdateSpec.Builder
extends java.lang.Object

Builder class for ClustersTypes.UpdateSpec.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of ClustersTypes.UpdateSpec.

Method Summary

Modifier and Type	Method and Description
ClustersTypes.UpdateSpec	build()
ClustersTypes.UpdateSpec.Builder	setClusterProxyConfig(ProxyConfiguration clusterProxyConfig) Proxy configuration that will be applied to the Supervisor.
ClustersTypes.UpdateSpec.Builder	setCnsFileConfig(CNSFileConfig cnsFileConfig) Specification for configuring Cloud Native Storage file volume support on Supervisor.
ClustersTypes.UpdateSpec.Builder	setContentLibraries(java.util.List<ClustersTypes.ContentLibrarySpec> contentLibraries) List of Content Libraries that will be associated with a Supervisor.
ClustersTypes.UpdateSpec.Builder	setDefaultImageRegistry(ClustersTypes.ImageRegistry defaultImageRegistry) Default image registry to use when Kubernetes Pod container specification does not specify it as part of the container image name.
ClustersTypes.UpdateSpec.Builder	setDefaultImageRepository(java.lang.String defaultImageRepository) Default image repository to use when Kubernetes Pod container specification does not specify it as part of the container image name.
ClustersTypes.UpdateSpec.Builder	setDefaultKubernetesServiceContentLibrary(java.lang.String defaultKubernetesServiceContentLibrary) Identifier of the Content Library which holds the VM Images for vSphere Kubernetes Service.
ClustersTypes.UpdateSpec.Builder	setEphemeralStoragePolicy(java.lang.String ephemeralStoragePolicy) Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster.
ClustersTypes.UpdateSpec.Builder	setFloatingIP(java.lang.String floatingIP) Optionally, you can edit the floating IP address that is assigned to the Supervisor in case the DHCP server fails during the Supervisor enablement process.
ClustersTypes.UpdateSpec.Builder	setImageStorage(ClustersTypes.ImageStorageSpec imageStorage) Specification for storage to be used for container images.
ClustersTypes.UpdateSpec.Builder	setLoginBanner(java.lang.String loginBanner) Disclaimer to be displayed prior to login via the Kubectl plugin.
ClustersTypes.UpdateSpec.Builder	setMasterDNS(java.util.List<java.lang.String> masterDNS) List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference.
ClustersTypes.UpdateSpec.Builder	setMasterDNSNames(java.util.List<java.lang.String> masterDNSNames) List of DNS names to associate with the Kubernetes API server.
ClustersTypes.UpdateSpec.Builder	setMasterDNSSearchDomains(java.util.List<java.lang.String> masterDNSSearchDomains) 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.
ClustersTypes.UpdateSpec.Builder	setMasterNTPServers(java.util.List<java.lang.String> masterNTPServers) List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference.
ClustersTypes.UpdateSpec.Builder	setMasterStoragePolicy(java.lang.String masterStoragePolicy) Identifier of storage policy associated with Kubernetes API server.
ClustersTypes.UpdateSpec.Builder	setNcpClusterNetworkSpec(ClustersTypes.NCPClusterNetworkUpdateSpec ncpClusterNetworkSpec) Updated specification for the cluster network configuration.
ClustersTypes.UpdateSpec.Builder	setNetworkProvider(ClustersTypes.NetworkProvider networkProvider) The provider of cluster networking for this vSphere Namespaces cluster.
ClustersTypes.UpdateSpec.Builder	setSizeHint(SizingHint sizeHint) This affects the size and resources allocated to the Kubernetes API server.
ClustersTypes.UpdateSpec.Builder	setTlsEndpointCertificate(java.lang.String tlsEndpointCertificate) PEM-encoded x509 certificate(s) issued for Kubernetes API Server.
ClustersTypes.UpdateSpec.Builder	setWorkerDNS(java.util.List<java.lang.String> workerDNS) List of DNS server IP addresses to use on the worker nodes, specified in order of preference.
ClustersTypes.UpdateSpec.Builder	setWorkloadNtpServers(java.util.List<java.lang.String> workloadNtpServers) List of NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of ClustersTypes.UpdateSpec.

Method Detail

setSizeHint

public ClustersTypes.UpdateSpec.Builder setSizeHint(SizingHint sizeHint)

This affects the size and resources allocated to the Kubernetes API server. If null, size and resources allocated to Kubernetes API server will not be modified.

Parameters:

sizeHint - New value for the property.

setFloatingIP

public ClustersTypes.UpdateSpec.Builder setFloatingIP(java.lang.String floatingIP)

Optionally, you can edit the floating IP address that is assigned to the Supervisor in case the DHCP server fails during the Supervisor enablement process. The field is only relevant when the DHCP mode of the Supervisor management network is set with ClustersTypes.EnableSpec.getMasterManagementNetwork(). Set this floating IP parameter to remediate a supervisor enablement failure in the case where it was detected that the DHCP server does not support DHCP client identifiers. This property was added in vSphere API 7.0.3.0. If null, the existing effective management network floating IP will not be modified.

Parameters:

floatingIP - New value for the property.

setNetworkProvider

public ClustersTypes.UpdateSpec.Builder setNetworkProvider(ClustersTypes.NetworkProvider networkProvider)

The provider of cluster networking for this vSphere Namespaces cluster. If null, the existing effective cluster network specification will not be modified.

Parameters:

networkProvider - New value for the property.

setNcpClusterNetworkSpec

public ClustersTypes.UpdateSpec.Builder setNcpClusterNetworkSpec(ClustersTypes.NCPClusterNetworkUpdateSpec ncpClusterNetworkSpec)

Updated specification for the cluster network configuration. If null, the existing effective cluster network specification will not be modified.

Parameters:

ncpClusterNetworkSpec - New value for the property.

setMasterDNS

public ClustersTypes.UpdateSpec.Builder setMasterDNS(java.util.List<java.lang.String> masterDNS)

List of DNS server IP addresses to use on Kubernetes API server, specified in order of preference. If Set, DNS servers set on Kubernetes API server will be replaced. Otherwise, they will not be modified.

Parameters:

masterDNS - New value for the property.

setWorkerDNS

public ClustersTypes.UpdateSpec.Builder setWorkerDNS(java.util.List<java.lang.String> workerDNS)

List of DNS server IP addresses to use on the worker nodes, specified in order of preference. If Set, DNS servers set on worker nodes will be replaced. Otherwise, they will not be modified.

Parameters:

workerDNS - New value for the property.

setMasterDNSSearchDomains

public ClustersTypes.UpdateSpec.Builder setMasterDNSSearchDomains(java.util.List<java.lang.String> masterDNSSearchDomains)

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 Set, DNS search domains on Kubernetes API server will be replaced. Otherwise, they will not be modified.

Parameters:

masterDNSSearchDomains - New value for the property.

setMasterNTPServers

public ClustersTypes.UpdateSpec.Builder setMasterNTPServers(java.util.List<java.lang.String> masterNTPServers)

List of NTP server DNS names or IP addresses to use on Kubernetes API server, specified in order of preference. If Set, NTP servers on Kubernetes API server will be replaced. Otherwise, they will not be modified.

Parameters:

masterNTPServers - New value for the property.

setMasterStoragePolicy

public ClustersTypes.UpdateSpec.Builder setMasterStoragePolicy(java.lang.String masterStoragePolicy)

Identifier of storage policy associated with Kubernetes API server. If null, storage policy associated with Kubernetes API server will not be modified.

Parameters:

masterStoragePolicy - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: SpsStorageProfile. When methods return a value of this class as a return value, the property will be an identifier for the resource type: SpsStorageProfile.

setEphemeralStoragePolicy

public ClustersTypes.UpdateSpec.Builder setEphemeralStoragePolicy(java.lang.String ephemeralStoragePolicy)

Identifier of storage policy associated with ephemeral disks of all the Kubernetes Pods in the cluster. If null, storage policy associated with ephemeral disks of all the Kubernetes Pods will not be modified.

Parameters:

ephemeralStoragePolicy - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: SpsStorageProfile. When methods return a value of this class as a return value, the property will be an identifier for the resource type: SpsStorageProfile.

setCnsFileConfig

public ClustersTypes.UpdateSpec.Builder setCnsFileConfig(CNSFileConfig cnsFileConfig)

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. This property was added in vSphere API 7.0.3.0. If null, configuration for file volumes will remain unchanged.

Parameters:

cnsFileConfig - New value for the property.

setLoginBanner

public ClustersTypes.UpdateSpec.Builder setLoginBanner(java.lang.String loginBanner)

Disclaimer to be displayed prior to login via the Kubectl plugin. If null, disclaimer to be displayed prior to login via the Kubectl plugin will not be modified.

Parameters:

loginBanner - New value for the property.

setMasterDNSNames

public ClustersTypes.UpdateSpec.Builder setMasterDNSNames(java.util.List<java.lang.String> masterDNSNames)

List of DNS names to associate with the Kubernetes API server. These DNS names are embedded in the CSR for TLS certificate presented by the API server. The provided value will replace existing DNS names. This property was added in vSphere API 8.0.2.00300. If null, existing DNS names will not be modified.

Parameters:

masterDNSNames - New value for the property.

setImageStorage

public ClustersTypes.UpdateSpec.Builder setImageStorage(ClustersTypes.ImageStorageSpec imageStorage)

Specification for storage to be used for container images. If null, configuration of storage used for container images is not modified.

Parameters:

imageStorage - New value for the property.

setDefaultImageRegistry

public ClustersTypes.UpdateSpec.Builder setDefaultImageRegistry(ClustersTypes.ImageRegistry defaultImageRegistry)

Default image registry to use when Kubernetes Pod container specification does not specify it as part of the container image name. If null, default image registry will not be modified.

Parameters:

defaultImageRegistry - New value for the property.

setDefaultImageRepository

public ClustersTypes.UpdateSpec.Builder setDefaultImageRepository(java.lang.String defaultImageRepository)

Default image repository to use when Kubernetes Pod container specification does not specify it as part of the container image name. If null, default image repository will not be modified.

Parameters:

defaultImageRepository - New value for the property.

setTlsEndpointCertificate

public ClustersTypes.UpdateSpec.Builder setTlsEndpointCertificate(java.lang.String tlsEndpointCertificate)

PEM-encoded x509 certificate(s) issued for Kubernetes API Server. Certificate(s) used must be created by signing the Certificate Signing Request obtained from the Namespace Certificate Management API.

Because a Kubernetes CertificateSigningRequest is created on an existing Namespaces-enabled cluster, you must use the UpdateSpec to specify this ClustersTypes.UpdateSpec.getTlsEndpointCertificate() on an existing cluster rather than during initially enabling Namespaces on a cluster.

In case of providing the trust chain, the certificates should be simply concatenated into a single string.

If null, Kubernetes API Server certificate(s) will not be modified.

Parameters:

tlsEndpointCertificate - New value for the property.

setDefaultKubernetesServiceContentLibrary

public ClustersTypes.UpdateSpec.Builder setDefaultKubernetesServiceContentLibrary(java.lang.String defaultKubernetesServiceContentLibrary)

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.

Modifying or clearing the Content Library identifier will not affect existing vSphere Kubernetes Service clusters. However, upgrades or scale-out of existing clusters may be affected if the new Content Library doesn't have the necessary VM Images.

If null, the Content Library will not be modified.

Parameters:

defaultKubernetesServiceContentLibrary - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When methods return a value of this class as a return value, the property will be an identifier for the resource type: com.vmware.content.Library.

setWorkloadNtpServers

public ClustersTypes.UpdateSpec.Builder setWorkloadNtpServers(java.util.List<java.lang.String> workloadNtpServers)

List of NTP server DNS names or IP addresses to use for workloads such as Tanzu Kubernetes Grid VMs, specified in order of preference. This property was added in vSphere API 7.0.1.0. If null, NTP servers for workloads will be unmodified.

Parameters:

workloadNtpServers - New value for the property.

setClusterProxyConfig

public ClustersTypes.UpdateSpec.Builder setClusterProxyConfig(ProxyConfiguration clusterProxyConfig)

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.

Modifying these settings will result in a restart of the container runtime. Workloads might fail to pull their images for a short period of time.

There will be no effect on the currently running containers.

. This property was added in vSphere API 7.0.3.00100. If null no change will be made to the cluster.

Parameters:

clusterProxyConfig - New value for the property.

setContentLibraries

public ClustersTypes.UpdateSpec.Builder setContentLibraries(java.util.List<ClustersTypes.ContentLibrarySpec> contentLibraries)

List of Content Libraries that will be associated with a Supervisor. This list should refer to existing Content Libraries in the vSphere inventory. These Content Libraries and the Content Library items belonging to them will be read-only across all vSphere Namespaces. This list does not overlap with the ClustersTypes.UpdateSpec.getDefaultKubernetesServiceContentLibrary(). . This property was added in vSphere API 8.0.2.0. If null, no additional Content Libraries will be set for the Supervisor apart from the default Kubernetes Service Content Library.

Parameters:

contentLibraries - New value for the property.

build

public ClustersTypes.UpdateSpec build()