Volume
A volume is a file system container in a storage pool that stores application, database, and user data. You can create a volume's capacity using the available capacity in the storage pool and you can define and resize the capacity without disruption to any processes. Storage pool settings apply to the volumes contained within them automatically. To get more information about Volume, see:
How-to Guides
Example Usage
Netapp Volume Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const default = gcp.compute.getNetwork({
name: "test-network",
});
const defaultStoragePool = new gcp.netapp.StoragePool("default", {
name: "test-pool",
location: "us-west2",
serviceLevel: "PREMIUM",
capacityGib: "2048",
network: _default.then(_default => _default.id),
});
const testVolume = new gcp.netapp.Volume("test_volume", {
location: "us-west2",
name: "test-volume",
capacityGib: "100",
shareName: "test-volume",
storagePool: defaultStoragePool.name,
protocols: ["NFSV3"],
deletionPolicy: "DEFAULT",
});
import pulumi
import pulumi_gcp as gcp
default = gcp.compute.get_network(name="test-network")
default_storage_pool = gcp.netapp.StoragePool("default",
name="test-pool",
location="us-west2",
service_level="PREMIUM",
capacity_gib="2048",
network=default.id)
test_volume = gcp.netapp.Volume("test_volume",
location="us-west2",
name="test-volume",
capacity_gib="100",
share_name="test-volume",
storage_pool=default_storage_pool.name,
protocols=["NFSV3"],
deletion_policy="DEFAULT")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = Gcp.Compute.GetNetwork.Invoke(new()
{
Name = "test-network",
});
var defaultStoragePool = new Gcp.Netapp.StoragePool("default", new()
{
Name = "test-pool",
Location = "us-west2",
ServiceLevel = "PREMIUM",
CapacityGib = "2048",
Network = @default.Apply(@default => @default.Apply(getNetworkResult => getNetworkResult.Id)),
});
var testVolume = new Gcp.Netapp.Volume("test_volume", new()
{
Location = "us-west2",
Name = "test-volume",
CapacityGib = "100",
ShareName = "test-volume",
StoragePool = defaultStoragePool.Name,
Protocols = new[]
{
"NFSV3",
},
DeletionPolicy = "DEFAULT",
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/netapp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := compute.LookupNetwork(ctx, &compute.LookupNetworkArgs{
Name: "test-network",
}, nil)
if err != nil {
return err
}
defaultStoragePool, err := netapp.NewStoragePool(ctx, "default", &netapp.StoragePoolArgs{
Name: pulumi.String("test-pool"),
Location: pulumi.String("us-west2"),
ServiceLevel: pulumi.String("PREMIUM"),
CapacityGib: pulumi.String("2048"),
Network: pulumi.String(_default.Id),
})
if err != nil {
return err
}
_, err = netapp.NewVolume(ctx, "test_volume", &netapp.VolumeArgs{
Location: pulumi.String("us-west2"),
Name: pulumi.String("test-volume"),
CapacityGib: pulumi.String("100"),
ShareName: pulumi.String("test-volume"),
StoragePool: defaultStoragePool.Name,
Protocols: pulumi.StringArray{
pulumi.String("NFSV3"),
},
DeletionPolicy: pulumi.String("DEFAULT"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
import com.pulumi.gcp.netapp.StoragePool;
import com.pulumi.gcp.netapp.StoragePoolArgs;
import com.pulumi.gcp.netapp.Volume;
import com.pulumi.gcp.netapp.VolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var default = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
.name("test-network")
.build());
var defaultStoragePool = new StoragePool("defaultStoragePool", StoragePoolArgs.builder()
.name("test-pool")
.location("us-west2")
.serviceLevel("PREMIUM")
.capacityGib("2048")
.network(default_.id())
.build());
var testVolume = new Volume("testVolume", VolumeArgs.builder()
.location("us-west2")
.name("test-volume")
.capacityGib("100")
.shareName("test-volume")
.storagePool(defaultStoragePool.name())
.protocols("NFSV3")
.deletionPolicy("DEFAULT")
.build());
}
}
resources:
defaultStoragePool:
type: gcp:netapp:StoragePool
name: default
properties:
name: test-pool
location: us-west2
serviceLevel: PREMIUM
capacityGib: '2048'
network: ${default.id}
testVolume:
type: gcp:netapp:Volume
name: test_volume
properties:
location: us-west2
name: test-volume
capacityGib: '100'
shareName: test-volume
storagePool: ${defaultStoragePool.name}
protocols:
- NFSV3
deletionPolicy: DEFAULT
variables:
default:
fn::invoke:
Function: gcp:compute:getNetwork
Arguments:
name: test-network
Import
Volume can be imported using any of these accepted formats:
projects/{{project}}/locations/{{location}}/volumes/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}}
When using thepulumi import
command, Volume can be imported using one of the formats above. For example:
$ pulumi import gcp:netapp/volume:Volume default projects/{{project}}/locations/{{location}}/volumes/{{name}}
$ pulumi import gcp:netapp/volume:Volume default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:netapp/volume:Volume default {{location}}/{{name}}
Properties
Reports the resource name of the Active Directory policy being used. Inherited from storage pool.
Backup configuration for the volume. Structure is documented below.
Capacity of the volume (in GiB).
Create time of the volume. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
Policy to determine if the volume should be deleted forcefully. Volumes may have nested snapshot resources. Deleting such a volume will fail. Setting this parameter to FORCE will delete volumes including nested snapshots.
An optional description of this resource.
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Reports the data-at-rest encryption type of the volume. Inherited from storage pool.
Export policy of the volume for NFSV3 and/or NFSV4.1 access. Structure is documented below.
Indicates whether the volume is part of a volume replication relationship.
Flag indicating if the volume is a kerberos volume or not, export policy rules control kerberos security modes (krb5, krb5i, krb5p).
Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" }
. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels
for all of the labels present on the resource.
Flag indicating if the volume is NFS LDAP enabled or not. Inherited from storage pool.
Reports mount instructions for this volume. Structure is documented below.
The combination of labels configured directly on the resource and default labels configured on the provider.
Specifies the replica zone for regional volume.
Used to create this volume from a snapshot (= cloning) or an backup. Structure is documented below.
List of actions that are restricted on this volume. Each value may be one of: DELETE
.
Security Style of the Volume. Use UNIX to use UNIX or NFSV4 ACLs for file permissions. Use NTFS to use NTFS ACLs for file permissions. Can only be set for volumes which use SMB together with NFS as protocol. Possible values are: NTFS
, UNIX
.
Service level of the volume. Inherited from storage pool. Supported values are : PREMIUM, EXTERME, STANDARD, FLEX.
Settings for volumes with SMB access. Each value may be one of: ENCRYPT_DATA
, BROWSABLE
, CHANGE_NOTIFY
, NON_BROWSABLE
, OPLOCKS
, SHOW_SNAPSHOT
, SHOW_PREVIOUS_VERSIONS
, ACCESS_BASED_ENUMERATION
, CONTINUOUSLY_AVAILABLE
.
If enabled, a NFS volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots. Will enable "Previous Versions" support for SMB.
Snapshot policy defines the schedule for automatic snapshot creation. To disable automatic snapshot creation you have to remove the whole snapshot_policy block. Structure is documented below.
State details of the volume.
Name of the storage pool to create the volume in. Pool needs enough spare capacity to accomodate the volume.
Unix permission the mount point will be created with. Default is 0770. Applicable for UNIX security style volumes only.