@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A cluster in a private cloud. * * To get more information about Cluster, see: * * * [API documentation](https://cloud.google.com/vmware-engine/docs/reference/rest/v1/projects.locations.privateClouds.clusters) * * ## Example Usage * * ### Vmware Engine Cluster Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cluster_nw = new gcp.vmwareengine.Network("cluster-nw", { * name: "pc-nw", * type: "STANDARD", * location: "global", * description: "PC network description.", * }); * const cluster_pc = new gcp.vmwareengine.PrivateCloud("cluster-pc", { * location: "us-west1-a", * name: "sample-pc", * description: "Sample test PC.", * networkConfig: { * managementCidr: "192.168.30.0/24", * vmwareEngineNetwork: cluster_nw.id, * }, * managementCluster: { * clusterId: "sample-mgmt-cluster", * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * }], * }, * }); * const vmw_engine_ext_cluster = new gcp.vmwareengine.Cluster("vmw-engine-ext-cluster", { * name: "ext-cluster", * parent: cluster_pc.id, * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * }], * }); * ``` * ### Vmware Engine Cluster Full * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const cluster_nw = new gcp.vmwareengine.Network("cluster-nw", { * name: "pc-nw", * type: "STANDARD", * location: "global", * description: "PC network description.", * }); * const cluster_pc = new gcp.vmwareengine.PrivateCloud("cluster-pc", { * location: "us-west1-a", * name: "sample-pc", * description: "Sample test PC.", * networkConfig: { * managementCidr: "192.168.30.0/24", * vmwareEngineNetwork: cluster_nw.id, * }, * managementCluster: { * clusterId: "sample-mgmt-cluster", * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * customCoreCount: 32, * }], * }, * }); * const vmw_ext_cluster = new gcp.vmwareengine.Cluster("vmw-ext-cluster", { * name: "ext-cluster", * parent: cluster_pc.id, * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * customCoreCount: 32, * }], * autoscalingSettings: { * autoscalingPolicies: [{ * autoscalePolicyId: "autoscaling-policy", * nodeTypeId: "standard-72", * scaleOutSize: 1, * cpuThresholds: { * scaleOut: 80, * scaleIn: 15, * }, * consumedMemoryThresholds: { * scaleOut: 75, * scaleIn: 20, * }, * storageThresholds: { * scaleOut: 80, * scaleIn: 20, * }, * }], * minClusterNodeCount: 3, * maxClusterNodeCount: 8, * coolDownPeriod: "1800s", * }, * }); * ``` * ### Vmware Engine Cluster Nfs Datastore Filestore * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as std from "@pulumi/std"; * * // Use this network for filestore instance * const fsNetwork = gcp.compute.getNetwork({ * name: "filestore_nw", * }); * // Create a filestore instance with delete protection enabled * //### Use ip range of private cloud service subnet in the 'nfs_export_options' * const testInstance = new gcp.filestore.Instance("test_instance", { * name: "test-fs-filestore", * location: "", * tier: "ZONAL", * deletionProtectionEnabled: "yes" === "true", * fileShares: { * capacityGb: 1024, * name: "share101", * nfsExportOptions: [{ * ipRanges: ["10.0.0.0/24"], * }], * }, * networks: [{ * network: fsNetwork.then(fsNetwork => fsNetwork.id), * modes: ["MODE_IPV4"], * connectMode: "PRIVATE_SERVICE_ACCESS", * }], * }); * const cluster_nw = new gcp.vmwareengine.Network("cluster-nw", { * name: "pc-nw", * type: "STANDARD", * location: "global", * description: "PC network description.", * }); * const cluster_pc = new gcp.vmwareengine.PrivateCloud("cluster-pc", { * location: "", * name: "sample-pc", * description: "Sample test PC.", * networkConfig: { * managementCidr: "192.168.30.0/24", * vmwareEngineNetwork: cluster_nw.id, * }, * managementCluster: { * clusterId: "sample-mgmt-cluster", * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * customCoreCount: 32, * }], * }, * }); * // Update service subnet * //### Service subnet is used by nfs datastore mounts * //### ip_cidr_range configured on subnet must also be allowed in filestore instance's 'nfs_export_options' * const cluster_pc_subnet = new gcp.vmwareengine.Subnet("cluster-pc-subnet", { * name: "service-1", * parent: cluster_pc.id, * ipCidrRange: "10.0.0.0/24", * }); * // Read network peering * //### This peering is created by filestore instance * const snPeering = fsNetwork.then(fsNetwork => gcp.compute.getNetworkPeering({ * name: "servicenetworking-googleapis-com", * network: fsNetwork.id, * })); * // Create vmware engine network peering * //## vmware network peering is required for filestore mount on cluster * const psaNetworkPeering = new gcp.vmwareengine.NetworkPeering("psa_network_peering", { * name: "tf-test-psa-network-peering", * description: "test description", * vmwareEngineNetwork: cluster_nw.id, * peerNetwork: snPeering.then(snPeering => std.trimprefix({ * input: snPeering.peerNetwork, * prefix: "https://www.googleapis.com/compute/v1", * })).then(invoke => invoke.result), * peerNetworkType: "PRIVATE_SERVICES_ACCESS", * }); * const testFsDatastore = new gcp.vmwareengine.Datastore("test_fs_datastore", { * name: "ext-fs-datastore", * location: "", * description: "test description", * nfsDatastore: { * googleFileService: { * filestoreInstance: testInstance.id, * }, * }, * }); * const vmw_ext_cluster = new gcp.vmwareengine.Cluster("vmw-ext-cluster", { * name: "ext-cluster", * parent: cluster_pc.id, * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * }], * datastoreMountConfigs: [{ * datastore: testFsDatastore.id, * datastoreNetwork: { * subnet: cluster_pc_subnet.id, * connectionCount: 4, * mtu: 1500, * }, * nfsVersion: "NFS_V3", * accessMode: "READ_WRITE", * ignoreColocation: false, * }], * }, { * dependsOn: [psaNetworkPeering], * }); * ``` * ### Vmware Engine Cluster Nfs Datastore Netapp * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as std from "@pulumi/std"; * * // Use this network for netapp volume * const npNetwork = gcp.compute.getNetwork({ * name: "netapp_nw", * }); * const cluster_nw = new gcp.vmwareengine.Network("cluster-nw", { * name: "pc-nw", * type: "STANDARD", * location: "global", * description: "PC network description.", * }); * // Read network peering * //### This peering is created by netapp volume * const snPeering = npNetwork.then(npNetwork => gcp.compute.getNetworkPeering({ * name: "sn-netapp-prod", * network: npNetwork.id, * })); * // Create vmware engine network peering * //### vmware network peering is required for netapp mount on cluster * const gcnvNetworkPeering = new gcp.vmwareengine.NetworkPeering("gcnv_network_peering", { * name: "tf-test-gcnv-network-peering", * description: "test description", * vmwareEngineNetwork: cluster_nw.id, * peerNetwork: snPeering.then(snPeering => std.trimprefix({ * input: snPeering.peerNetwork, * prefix: "https://www.googleapis.com/compute/v1", * })).then(invoke => invoke.result), * peerNetworkType: "GOOGLE_CLOUD_NETAPP_VOLUMES", * }); * const cluster_pc = new gcp.vmwareengine.PrivateCloud("cluster-pc", { * location: "", * name: "sample-pc", * description: "Sample test PC.", * networkConfig: { * managementCidr: "192.168.30.0/24", * vmwareEngineNetwork: cluster_nw.id, * }, * managementCluster: { * clusterId: "sample-mgmt-cluster", * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * customCoreCount: 32, * }], * }, * }); * // Update service subnet * //### Service subnet is used by nfs datastore mounts * //### ip_cidr_range configured on subnet must also be allowed in in netapp volumes's 'export_policy' * const cluster_pc_subnet = new gcp.vmwareengine.Subnet("cluster-pc-subnet", { * name: "service-1", * parent: cluster_pc.id, * ipCidrRange: "10.0.0.0/24", * }); * const _default = new gcp.netapp.StoragePool("default", { * name: "tf-test-test-pool", * location: "us-west1", * serviceLevel: "PREMIUM", * capacityGib: "2048", * network: npNetwork.then(npNetwork => npNetwork.id), * }); * // Create a netapp volume with delete protection enabled * //## Use ip range of private cloud service subnet in the 'export_policy' * const testVolume = new gcp.netapp.Volume("test_volume", { * location: "us-west1", * name: "tf-test-test-volume", * capacityGib: "100", * shareName: "tf-test-test-volume", * storagePool: _default.name, * protocols: ["NFSV3"], * exportPolicy: { * rules: [{ * accessType: "READ_WRITE", * allowedClients: "10.0.0.0/24", * hasRootAccess: "true", * kerberos5ReadOnly: false, * kerberos5ReadWrite: false, * kerberos5iReadOnly: false, * kerberos5iReadWrite: false, * kerberos5pReadOnly: false, * kerberos5pReadWrite: false, * nfsv3: true, * nfsv4: false, * }], * }, * restrictedActions: ["DELETE"], * }); * const testFsDatastore = new gcp.vmwareengine.Datastore("test_fs_datastore", { * name: "ext-fs-datastore", * location: "us-west1", * description: "example google_file_service.netapp datastore.", * nfsDatastore: { * googleFileService: { * netappVolume: testVolume.id, * }, * }, * }); * const vmw_ext_cluster = new gcp.vmwareengine.Cluster("vmw-ext-cluster", { * name: "ext-cluster", * parent: cluster_pc.id, * nodeTypeConfigs: [{ * nodeTypeId: "standard-72", * nodeCount: 3, * }], * datastoreMountConfigs: [{ * datastore: testFsDatastore.id, * datastoreNetwork: { * subnet: cluster_pc_subnet.id, * connectionCount: 4, * mtu: 1500, * }, * nfsVersion: "NFS_V3", * accessMode: "READ_WRITE", * ignoreColocation: true, * }], * }, { * dependsOn: [gcnvNetworkPeering], * }); * ``` * * ## Import * * Cluster can be imported using any of these accepted formats: * * * `{{parent}}/clusters/{{name}}` * * When using the `pulumi import` command, Cluster can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:vmwareengine/cluster:Cluster default {{parent}}/clusters/{{name}} * ``` */ export declare class Cluster extends pulumi.CustomResource { /** * Get an existing Cluster resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster; /** * Returns true if the given object is an instance of Cluster. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Cluster; /** * Configuration of the autoscaling applied to this cluster * Structure is documented below. */ readonly autoscalingSettings: pulumi.Output<outputs.vmwareengine.ClusterAutoscalingSettings | undefined>; /** * Creation time of this resource. * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and * up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". */ readonly createTime: pulumi.Output<string>; /** * Optional. Configuration to mount a datastore. * Mount can be done along with cluster create or during cluster update * Since service subnet is not configured with ip range on mgmt cluster creation, mount on management cluster is done as update only * for unmount remove 'datastore_mount_config' config from the update of cluster resource * Structure is documented below. */ readonly datastoreMountConfigs: pulumi.Output<outputs.vmwareengine.ClusterDatastoreMountConfig[] | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ readonly deletionPolicy: pulumi.Output<string>; /** * True if the cluster is a management cluster; false otherwise. * There can only be one management cluster in a private cloud and it has to be the first one. */ readonly management: pulumi.Output<boolean>; /** * The ID of the Cluster. */ readonly name: pulumi.Output<string>; /** * The map of cluster node types in this cluster, * where the key is canonical identifier of the node type (corresponds to the NodeType). * Structure is documented below. */ readonly nodeTypeConfigs: pulumi.Output<outputs.vmwareengine.ClusterNodeTypeConfig[] | undefined>; /** * The resource name of the private cloud to create a new cluster in. * Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. * For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud */ readonly parent: pulumi.Output<string>; /** * State of the Cluster. */ readonly state: pulumi.Output<string>; /** * System-generated unique identifier for the resource. */ readonly uid: pulumi.Output<string>; /** * Last updated time of this resource. * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine * fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". */ readonly updateTime: pulumi.Output<string>; /** * Create a Cluster resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Cluster resources. */ export interface ClusterState { /** * Configuration of the autoscaling applied to this cluster * Structure is documented below. */ autoscalingSettings?: pulumi.Input<inputs.vmwareengine.ClusterAutoscalingSettings | undefined>; /** * Creation time of this resource. * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and * up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". */ createTime?: pulumi.Input<string | undefined>; /** * Optional. Configuration to mount a datastore. * Mount can be done along with cluster create or during cluster update * Since service subnet is not configured with ip range on mgmt cluster creation, mount on management cluster is done as update only * for unmount remove 'datastore_mount_config' config from the update of cluster resource * Structure is documented below. */ datastoreMountConfigs?: pulumi.Input<pulumi.Input<inputs.vmwareengine.ClusterDatastoreMountConfig>[] | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * True if the cluster is a management cluster; false otherwise. * There can only be one management cluster in a private cloud and it has to be the first one. */ management?: pulumi.Input<boolean | undefined>; /** * The ID of the Cluster. */ name?: pulumi.Input<string | undefined>; /** * The map of cluster node types in this cluster, * where the key is canonical identifier of the node type (corresponds to the NodeType). * Structure is documented below. */ nodeTypeConfigs?: pulumi.Input<pulumi.Input<inputs.vmwareengine.ClusterNodeTypeConfig>[] | undefined>; /** * The resource name of the private cloud to create a new cluster in. * Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. * For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud */ parent?: pulumi.Input<string | undefined>; /** * State of the Cluster. */ state?: pulumi.Input<string | undefined>; /** * System-generated unique identifier for the resource. */ uid?: pulumi.Input<string | undefined>; /** * Last updated time of this resource. * A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine * fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". */ updateTime?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a Cluster resource. */ export interface ClusterArgs { /** * Configuration of the autoscaling applied to this cluster * Structure is documented below. */ autoscalingSettings?: pulumi.Input<inputs.vmwareengine.ClusterAutoscalingSettings | undefined>; /** * Optional. Configuration to mount a datastore. * Mount can be done along with cluster create or during cluster update * Since service subnet is not configured with ip range on mgmt cluster creation, mount on management cluster is done as update only * for unmount remove 'datastore_mount_config' config from the update of cluster resource * Structure is documented below. */ datastoreMountConfigs?: pulumi.Input<pulumi.Input<inputs.vmwareengine.ClusterDatastoreMountConfig>[] | undefined>; /** * Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. * When a 'terraform destroy' or 'pulumi up' would delete the resource, * the command will fail if this field is set to "PREVENT" in Terraform state. * When set to "ABANDON", the command will remove the resource from Terraform * management without updating or deleting the resource in the API. * When set to "DELETE", deleting the resource is allowed. */ deletionPolicy?: pulumi.Input<string | undefined>; /** * The ID of the Cluster. */ name?: pulumi.Input<string | undefined>; /** * The map of cluster node types in this cluster, * where the key is canonical identifier of the node type (corresponds to the NodeType). * Structure is documented below. */ nodeTypeConfigs?: pulumi.Input<pulumi.Input<inputs.vmwareengine.ClusterNodeTypeConfig>[] | undefined>; /** * The resource name of the private cloud to create a new cluster in. * Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. * For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud */ parent: pulumi.Input<string>; } //# sourceMappingURL=cluster.d.ts.map