Scale capacity

This page shows you how to increase or decrease the capacity of your Filestore instances.

When using Filestore, we recommend that you monitor the utilization of your Filestore instances so that you can adjust capacity as needed. For example, if you notice that a zonal-tier instance with a higher capacity range (previously high scale SSD) no longer needs all of its allocated capacity, you may consider scaling it down. Similarly, if you notice that you are running out of capacity, you may want to scale up capacity to prevent your applications from breaking. If the file system runs out of inodes, you also need to add capacity. To check the inode usage, run:

df -i

The command returns something similar to the following:

Filesystem           Inodes  IUsed      IFree  IUse%  Mounted on
10.0.0.2:/vol1    134217728     13  134217715     1%  /mnt/test

Each file stored on the file share consumes one inode. If the file system runs out of inodes, you are not able to store more files on the file share even if you haven't reached the maximum allocated capacity. The only way to add inodes is by adding capacity. However, reaching the maximum inodes is rare and is only a concern if you need to store many small files.

Differences in scaling behavior by service tier

Scaling an instance does not affect its availability and can be performed while the instance is in use. The following table shows how file share capacity can be scaled based on the service tier:

Service tier	Basic HDD	Basic SSD	Zonal with a lower capacity range	Zonal with a higher capacity range	Enterprise
Scaling direction	Up only	Up only	Up and down	Up and down	Up and down
Scaling increment	`1GiB`	`1GiB`	`256GiB`	`2.5TiB`	`256GiB`
Minimum capacity	`1TiB`	`2.5TiB`	`1TiB`	`10TiB`	`1TiB`
Maximum capacity	`63.9TiB`	`63.9TiB`	`9.75TiB`	`100TiB`	`10TiB`

Scaling the capacity of a zonal tier instance with a higher capacity range can take longer than enterprise and basic tier instances. The actual time required varies depending on the amount of data stored in the instance and the load on the Filestore instance. To ensure that your instances don't run out of capacity, perform these operations in advance.

When a scaling operation is taking place, you cannot cancel the operation or make any other edits to the instance, but read and write operations are uninterrupted. You also cannot scale an enterprise-tier and zonal-tier instance to a capacity level that's lower than what's needed for storing its existing file data and metadata. Attempting to do so results in an error.

Instructions for editing an instance

Google Cloud console

To edit Filestore instances using the Google Cloud console, navigate to the Edit instance page, where you can edit the instance description, manage IP-based access control rules, and scale the file share performance:

In the Google Cloud console, go to the Filestore Instances page.

Go to the Filestore instances page
Click the instance ID of the instance you want to edit.
On the Instance details page, click Edit to go to the Edit instance page.
In the Edit capacity field, enter the new capacity value.
Click Save.

gcloud

Before you begin

To use the gcloud CLI, you must either install the Cloud SDK or use the Cloud Shell that's built into the Google Cloud console:

Go to the Google Cloud console

`gcloud` command for editing an instance

You can edit a Filestore instance by running the instances update command.

 gcloud filestore instances update instance-id \
     --project="project-id" \
     --location=location \
     --file-share=name="file-share-name",capacity=file-share-size

where:

instance-id is the instance ID of the Filestore instance you want to edit.
project-id is the project ID of the Google Cloud project that contains the Filestore instance. You can skip this flag if the Filestore instance is in the gcloud default project. You can set the default project by running:
```
 gcloud config set project project-id
```
location is the location where the Filestore instance resides. For enterprise instances, specify a region. For all other instances, specify a zone. For example, us-central1-a.

Run the gcloud filestore zones list command to get a list of supported zones. You can skip this flag if the Filestore instance is in the gcloud default zone. You can set the default zone by running:
```
 gcloud config set filestore/zone zone
```
file-share-name is the name of the file share that is served from the Filestore instance. File share names cannot be changed after instance creation.
file-share-size is the new size you want for the file share. You can specify the file share size in whole numbers using either GiB (default) or TiB. For example, 10TiB.

To see your available quota, go to the Quotas page in the Google Cloud console:

Go to the Quotas page
Optional: For a detailed list of available flags, see the gcloud filestore instances update reference page.