/** * The Cluster model module. * @module Ntnx/Cluster * @version 4.3.1 * @class Cluster * @extends ExternalizableAbstractModel * * @param { string } name Name of the cluster. */ export default class Cluster extends ExternalizableAbstractModel { /** * Constructs a new Cluster. * A model that represents a Service Cluster for Micro Services Platform(MSP). * @alias module:Ntnx/Cluster * @extends module:Ntnx/ExternalizableAbstractModel * * @param { string } name Name of the cluster. */ constructor(name: string); name: string; /** * Returns Name of the cluster. * @return {string} */ getName(): string; /** * Sets Name of the cluster. * @param {string} name Name of the cluster. */ setName(name: string): void; /** * Returns Brief description about the cluster. * @return {string} */ getDescription(): string; /** * Sets Brief description about the cluster. * @param {string} description Brief description about the cluster. */ setDescription(description: string): void; description: string; /** * Returns The status of deployed cluster. * @return {string} */ getStatus(): string; /** * Sets The status of deployed cluster. * @param {string} status The status of deployed cluster. */ setStatus(status: string): void; status: string; /** * @return {ClusterType} */ getClusterType(): ClusterType; /** * @param {ClusterType} clusterType */ setClusterType(clusterType: ClusterType): void; clusterType: any; /** * @return {FQDN} */ getDomain(): FQDN; /** * @param {FQDN} domain */ setDomain(domain: FQDN): void; domain: FQDN; /** * @return {ClusterDeploymentType} */ getDeploymentType(): ClusterDeploymentType; /** * @param {ClusterDeploymentType} deploymentType */ setDeploymentType(deploymentType: ClusterDeploymentType): void; deploymentType: string; /** * @return {ClusterManagementIps} */ getManagementIps(): ClusterManagementIps; /** * @param {ClusterManagementIps} managementIps */ setManagementIps(managementIps: ClusterManagementIps): void; managementIps: ClusterManagementIps; /** * @return {Config[]} */ getWorkerConfigs(): Config[]; /** * @param {Config[]} workerConfigs */ setWorkerConfigs(workerConfigs: Config[]): void; workerConfigs: Config[]; /** * @return {Config} */ getControlPlaneConfig(): Config; /** * @param {Config} controlPlaneConfig */ setControlPlaneConfig(controlPlaneConfig: Config): void; controlPlaneConfig: any; /** * Returns Configuration for the control plane nodes of the cluster. * @return {Config[]} */ getControlPlaneConfigs(): Config[]; /** * Sets Configuration for the control plane nodes of the cluster. * @param {Config[]} controlPlaneConfigs Configuration for the control plane nodes of the cluster. */ setControlPlaneConfigs(controlPlaneConfigs: Config[]): void; controlPlaneConfigs: Config[]; /** * @return {LoadBalancerConfig} */ getLoadBalancerConfigs(): LoadBalancerConfig; /** * @param {LoadBalancerConfig} loadBalancerConfigs */ setLoadBalancerConfigs(loadBalancerConfigs: LoadBalancerConfig): void; loadBalancerConfigs: LoadBalancerConfig; /** * Returns The storage class specification used for creation of volumes needed for stateful services. * @return {ClusterStorageClass[]} */ getStorageClasses(): ClusterStorageClass[]; /** * Sets The storage class specification used for creation of volumes needed for stateful services. * @param {ClusterStorageClass[]} storageClasses The storage class specification used for creation of volumes needed for stateful services. */ setStorageClasses(storageClasses: ClusterStorageClass[]): void; storageClasses: ClusterStorageClass[]; /** * Returns Configuration of the default volume to be attached to a node for logging purpose. * @return {LoggingVolumeConfig[]} */ getLoggingVolumeConfig(): LoggingVolumeConfig[]; /** * Sets Configuration of the default volume to be attached to a node for logging purpose. * @param {LoggingVolumeConfig[]} loggingVolumeConfig Configuration of the default volume to be attached to a node for logging purpose. */ setLoggingVolumeConfig(loggingVolumeConfig: LoggingVolumeConfig[]): void; loggingVolumeConfig: LoggingVolumeConfig[]; /** * Returns Client spec needed for VM/Network CRUD operations. * @return {ClientConfig[]} */ getClientConfigs(): ClientConfig[]; /** * Sets Client spec needed for VM/Network CRUD operations. * @param {ClientConfig[]} clientConfigs Client spec needed for VM/Network CRUD operations. */ setClientConfigs(clientConfigs: ClientConfig[]): void; clientConfigs: ClientConfig[]; /** * Returns Resource configuration list for the VM resources. * @return {ClusterResourceConfig[]} */ getResourceConfigs(): ClusterResourceConfig[]; /** * Sets Resource configuration list for the VM resources. * @param {ClusterResourceConfig[]} resourceConfigs Resource configuration list for the VM resources. */ setResourceConfigs(resourceConfigs: ClusterResourceConfig[]): void; resourceConfigs: ClusterResourceConfig[]; /** * Returns Network configuration of the cluster. * @return {ClusterNetworkConfig[]} */ getNetworkConfigs(): ClusterNetworkConfig[]; /** * Sets Network configuration of the cluster. * @param {ClusterNetworkConfig[]} networkConfigs Network configuration of the cluster. */ setNetworkConfigs(networkConfigs: ClusterNetworkConfig[]): void; networkConfigs: ClusterNetworkConfig[]; /** * Returns Key Value pairs that can be used to customize cluster deployment configuration. Supported annotations are - - Select storage provisioner service. Accepted values are csi/volume_provisioner. Key: \"msp/storage/service\" Value: \"volume_provisioner/csi\" - Disable logging add-ons on the cluster. Key: \"msp/logging/disable\" Value: \"true\" - Disable monitoring add-ons on the cluster. Key: \"msp/monitoring/disable\" Value: \"true\" * @return {KVStringPair[]} */ getAnnotations(): KVStringPair[]; /** * Sets Key Value pairs that can be used to customize cluster deployment configuration. Supported annotations are - - Select storage provisioner service. Accepted values are csi/volume_provisioner. Key: \"msp/storage/service\" Value: \"volume_provisioner/csi\" - Disable logging add-ons on the cluster. Key: \"msp/logging/disable\" Value: \"true\" - Disable monitoring add-ons on the cluster. Key: \"msp/monitoring/disable\" Value: \"true\" * @param {KVStringPair[]} annotations Key Value pairs that can be used to customize cluster deployment configuration. Supported annotations are - - Select storage provisioner service. Accepted values are csi/volume_provisioner. Key: \"msp/storage/service\" Value: \"volume_provisioner/csi\" - Disable logging add-ons on the cluster. Key: \"msp/logging/disable\" Value: \"true\" - Disable monitoring add-ons on the cluster. Key: \"msp/monitoring/disable\" Value: \"true\" */ setAnnotations(annotations: KVStringPair[]): void; annotations: KVStringPair[]; /** * Returns The controller version with which the cluster was deployed. * @return {string} */ getControllerVersion(): string; /** * Sets The controller version with which the cluster was deployed. * @param {string} controllerVersion The controller version with which the cluster was deployed. */ setControllerVersion(controllerVersion: string): void; controllerVersion: string; /** * Returns The envoy nodes ips. * @return {string[]} */ getEnvoyIps(): string[]; /** * Sets The envoy nodes ips. * @param {string[]} envoyIps The envoy nodes ips. */ setEnvoyIps(envoyIps: string[]): void; envoyIps: string[]; /** * Returns The etcd nodes ips. * @return {string[]} */ getEtcdIps(): string[]; /** * Sets The etcd nodes ips. * @param {string[]} etcdIps The etcd nodes ips. */ setEtcdIps(etcdIps: string[]): void; etcdIps: string[]; /** * Returns The external master ip. * @return {string} */ getExternalMasterIp(): string; /** * Sets The external master ip. * @param {string} externalMasterIp The external master ip. */ setExternalMasterIp(externalMasterIp: string): void; externalMasterIp: string; /** * Returns Boolean value indicating if cluster is locked or not. * @return {boolean} */ getIsLockedDown(): boolean; /** * Sets Boolean value indicating if cluster is locked or not. * @param {boolean} isLockedDown Boolean value indicating if cluster is locked or not. */ setIsLockedDown(isLockedDown: boolean): void; isLockedDown: boolean; /** * Returns The control plane node ips. * @return {string[]} */ getMasterIps(): string[]; /** * Sets The control plane node ips. * @param {string[]} masterIps The control plane node ips. */ setMasterIps(masterIps: string[]): void; masterIps: string[]; /** * Returns The worker nodes ips. * @return {string[]} */ getWorkerIps(): string[]; /** * Sets The worker nodes ips. * @param {string[]} workerIps The worker nodes ips. */ setWorkerIps(workerIps: string[]): void; workerIps: string[]; /** * @return {DNSConfig} */ getDnsConfig(): DNSConfig; /** * @param {DNSConfig} dnsConfig */ setDnsConfig(dnsConfig: DNSConfig): void; dnsConfig: DNSConfig; /** * Returns The version of the cluster. * @return {string} */ getVersion(): string; /** * Sets The version of the cluster. * @param {string} version The version of the cluster. */ setVersion(version: string): void; version: string; /** * @return {BundleArtifactRef} */ getArtifactRef(): BundleArtifactRef; /** * @param {BundleArtifactRef} artifactRef */ setArtifactRef(artifactRef: BundleArtifactRef): void; artifactRef: BundleArtifactRef; #private; } import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel"; import FQDN from "../../../common/v1/config/FQDN"; import ClusterDeploymentType from "./ClusterDeploymentType"; import ClusterManagementIps from "./ClusterManagementIps"; import LoadBalancerConfig from "./LoadBalancerConfig"; import ClusterStorageClass from "./ClusterStorageClass"; import LoggingVolumeConfig from "./LoggingVolumeConfig"; import ClientConfig from "./ClientConfig"; import ClusterResourceConfig from "./ClusterResourceConfig"; import ClusterNetworkConfig from "./ClusterNetworkConfig"; import KVStringPair from "../../../common/v1/config/KVStringPair"; import DNSConfig from "./DNSConfig"; import BundleArtifactRef from "./BundleArtifactRef";