Creating a file storage

If you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

1. See the description of the CLI command for creating a file storage:

   yc compute filesystem create --help
   

2. Create a file storage in the default folder:

   yc compute filesystem create \
     --name <file_storage_name> \
     --type <file_storage_type> \
     --zone <availability_zone> \
     --size <file_storage_size> \
     --labels <key>=<value>
   

   Where:

   • --name: File storage name. The naming requirements are as follows:

     • It must be from 2 to 63 characters long.
     • It may contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • --type: File storage type. The possible values are network-hdd or network-ssd.

   • --zone: Availability zone.

   • --size: File storage size. This is an optional parameter. The default value is 150 GB.

     By default, the value is specified in bytes. To specify the size in megabytes or gigabytes, use the M and G suffixes, e.g., 2048M or 2G.

   • --labels: File storage labels in <key>=<value> format. This is an optional parameter.

     To specify multiple labels, list them separated by commas: <key_1>=<value_1>,<key_2>=<value_2>,...,<key_n>=<value_n>.

   Result:

   done (11s)
   id: epdcago8e5lr********
   folder_id: b1gt6g8ht345********
   created_at: "2024-05-02T05:56:39Z"
   name: my-sample-fs
   labels:
     key1: value1
     key2: value2
     key3: value3
   type_id: network-hdd
   zone_id: ru-central1-a
   size: "1073741824"
   status: READY
   

If you do not have Terraform yet, install it and configure its Yandex Cloud provider.

1. In the configuration file, define the parameters of the resources you want to create:

   provider "yandex" {
     zone = "ru-central1-a"
   }
   
   resource "yandex_compute_filesystem" "default" {
     name   = "<file_storage_name>"
     type   = "<file_storage_type>"
     zone   = "<availability_zone>"
     size   = <file_storage_size>
     labels = {
       <label_1_key> = "<label_1_value>"
       <label_2_key> = "<label_2_value>"
     }
   }
   

   Where:

   • name: File storage name. This is a required parameter.
   • type: File storage type. The possible values are network-hdd or network-ssd. The default file storage type is network-hdd. This is an optional parameter.
   • zone: Availability zone. This is an optional parameter.
   • size: File storage size in GB. This is an optional parameter. The default value is 150 GB.
   • labels: Resource label in <key> = "<value>" format. This is an optional parameter.

   For more information about the yandex_compute_filesystem resource parameters in Terraform, see the relevant provider documentation.

2. Create the resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

This will create a file storage in the specified folder. You can check the new file storage and its settings using the management console or this CLI command:

yc compute filesystem get <file_storage_name>

Use the create REST API method for the Filesystem resource or the FilesystemService/Create gRPC API call.