Mounting buckets to a function

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

Run this command:

yc serverless function version create \
  --function-name=<function_name> \
  --runtime <runtime> \
  --entrypoint <entry_point> \
  --memory <RAM_amount> \
  --execution-timeout <execution_timeout> \
  --source-path <path_to_ZIP_archive> \
  --service-account-id <service_account_ID> \
  --mount type=object-storage,mount-point=<mount_point>,bucket=<bucket_name>,prefix=<folder_name>,mode=<mount_mode>

Where:

• --function-name: Function name.

• --runtime: Function runtime.

• entrypoint: Entry point in <file_name_without_extension>.<handler_name> format, e.g., index.handler.

• --memory: Amount of RAM.

• --execution-timeout: Maximum function execution time before timeout.

• --source-path: Path to the ZIP archive with the function code and required dependencies.

• --service-account-id: Service account ID. The service account needs the storage.viewer role for bucket read access or the storage.uploader role for both read and write access.

• --mount: Object Storage bucket mount settings:

  • type: Mounted storage type. For a bucket, the value is always object-storage.
  • mount-point: Mount point. The directory with the mounted bucket will be accessible at /function/storage/<mount_point>.
  • bucket: Bucket name.
  • prefix: Bucket folder that will be mounted to the function. Skip this field or leave it empty to mount the entire bucket.
  • mode: Bucket mount mode, ro (read-only) or rw (read and write).

  To mount several buckets to a function at the same time, specify --mount as many times as you need.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

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

1. Open the Terraform configuration file and add the mounts section to the function description:

   resource "yandex_function" "bucketfunction" {
     ...
   
     mounts {
       name = "<mount_point>"
       mode = "<mount_mode>"
       object_storage {
         bucket = "<bucket_name>"
         prefix = "<folder_name>"
       }
     }
   
   }
   

   Where:

   • mounts: Object Storage bucket mount settings:

     • name: Mount point. The directory with the mounted bucket will be accessible at /function/storage/<mount_point>.
     • mode: Bucket mount mode, ro (read-only) or rw (read and write).
     • object_storage: Bucket settings:
       • bucket: Bucket name.
       • prefix: Bucket folder that will be mounted to the container. Leave this field empty to mount the entire bucket.

     To mount several buckets to a function at the same time, specify mounts as many times as you need.

   For more information about yandex_function resource properties, see this provider guide.

2. Apply the changes:

   1. In the terminal, navigate to the configuration file directory.

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

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

You can check the function version update and its settings using the management console or this CLI command:

yc serverless function version get <function_version_ID>

Use the createVersion REST API method for the Function resource or the FunctionService/CreateVersion gRPC API call.