Attaching a file storage to a VM

If you do not have the Yandex Cloud CLI 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 attaching a file storage to a VM:

   yc compute instance attach-filesystem --help
   

2. Get a list of file storages in the default folder:

   yc compute filesystem list
   

   Result:

   +----------------------+-------------------+------------+---------------+--------+-------------+
   |          ID          |        NAME       |    SIZE    |     ZONE      | STATUS | DESCRIPTION |
   +----------------------+-------------------+------------+---------------+--------+-------------+
   | epdtcr9blled******** | first-filesystem  | 1073741824 | ru-central1-a | READY  |             |
   | epd3f4gv8bs4******** | second-filesystem | 1073741824 | ru-central1-a | READY  |             |
   +----------------------+-------------------+------------+---------------+--------+-------------+
   

3. Get a list of VMs in the default folder:

   yc compute instance list
   

   Result:

   +----------------------+-------+---------------+---------+--------------+-------------+
   |          ID          | NAME  |    ZONE ID    | STATUS  |  EXTERNAL IP | INTERNAL IP |
   +----------------------+-------+---------------+---------+--------------+-------------+
   | epdj4upltbiv******** | vm-01 | ru-central1-a | RUNNING | 51.250.**.** | 192.168.*.* |
   | 1pc3088tkv4m******** | vm-02 | ru-central1-a | RUNNING | 84.201.**.** | 192.168.*.* |
   +----------------------+-------+---------------+---------+--------------+-------------+
   

4. Attach the file storage to the VM:

   yc compute instance attach-filesystem \
     --id <VM_ID> \
     --filesystem-id <file_storage_ID> \
     --device-name <device_name>
   

   Where:

   • --id: VM ID.

     Instead of the ID, you can specify the VM name in the --name parameter.

   • --filesystem-id: File storage ID.

     Instead of the ID, you can specify the file storage name in the --filesystem-name parameter.

   • --device-name: Device name to represent the file storage in the VM. This is an optional parameter.

     By default, the file storage ID is used as the device name.

   Result:

   id: epdj4upltbiv********
   folder_id: b1g681qpemb4********
   created_at: "2024-04-29T15:50:19Z"
   name: vm-01
   ...
   filesystems:
   - mode: READ_WRITE
     device_name: attached-filesystem
     filesystem_id: epdtcr9blled********
   ...
   

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

Set the allow_stopping_for_update parameter to true on your VM, if you have not done it yet.

To attach a file storage to your VM, add the filesystem section with the filesystem_id parameter to the VM description (see the example below).

1. Open the Terraform configuration file and add a section specifying the storage to the VM description:

   Example of specifying a storage in the VM configuration using Terraform

   ...
   resource "yandex_compute_instance" "vm-1" {
     name        = "test-vm"
     platform_id = "standard-v3"
     zone        = "ru-central1-a"
   
     filesystem {
       filesystem_id = "fhmaikp755gr********"
     }
   }
   ...
   

2. Apply the changes:

   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.

You can check whether the storage has been attached to the VM using the management console or this CLI command:

yc compute instance get <VM_name>

Use the attachFilesystem REST API method for the Instance resource or the InstanceService/AttachFilesystem gRPC API call.