Mounting a bucket to a function

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

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To mount a bucket to a function, run this command:

yc serverless function version create \
  --function-name=<function_name> \
  --runtime <runtime_environment> \
  --entrypoint <entry_point> \
  --memory <RAM_size> \
  --execution-timeout <execution_timeout> \
  --source-path <path_to_ZIP_archive> \
  --service-account-id <service_account_ID>
  --storage-mounts mount-point=<mount_point>,bucket=<bucket_name>,prefix=<folder_name>,read-only=false

Where:

• --function-name: Function name.
• --runtime: Runtime environment.
• --entrypoint: Entry point in the following format: <file_name_without_extension>.<listener_name>.
• --memory: Amount of RAM.
• --execution-timeout: Maximum function running time before the timeout is reached.
• --source-path: ZIP archive with the function code and required dependencies.
• --service-account-id: Service account ID. The account must have the storage.viewer role to read data from the bucket or the storage.uploader role to write data.
• --storage-mounts: Object Storage bucket mounting parameters:
  • mount-point: Name of the mount point. Use this path to access the directory in which the bucket is mounted: /function/storage/<mount_point>.
  • bucket: Bucket.
  • prefix: Folder within the bucket. Leave this field empty to mount the entire bucket.
  • read-only: Disables writing to the bucket. If this option is enabled, data from the mounted bucket is available as read-only. The possible values are true and false.

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 documentation on the Terraform website or mirror website.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To mount a bucket to a function:

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

   resource "yandex_function" "bucketfunction" {
     name               = "<bucket_name>"
     user_hash          = "<function_hash>"
     runtime            = "<runtime_environment>"
     entrypoint         = "<entry_point>"
     memory             = "<RAM_size>"
     execution_timeout  = "<execution_timeout>"
     service_account_id = "<service_account_ID>"
     content {
       zip_filename = "<path_to_ZIP_archive>"
     }
   
     storage_mounts {
       mount_point_name = "<mount_point>"
       bucket           = "<bucket_name>"
       prefix           = "<folder_name>"
       read_only        = <read_only_flag>
     }
   }
   

   Where:

   • storage_mounts: Bucket mounting parameters:
     • mount_point_name: Name of the mount point. Use this path to access the directory in which the bucket is mounted: /function/storage/<mount_point>.
     • bucket: Bucket.
     • prefix: Folder within the bucket. Leave this field empty to mount the entire bucket.
     • read_only: Disables writing to the bucket. If this option is enabled, data from the mounted bucket is available as read-only. The possible values are true and false.

   For more information about the yandex_function resource parameters, see the provider documentation.

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 the function update and its settings using the management console or this CLI command:

yc serverless function version get <function_version_ID>

To mount a bucket to a function, use the createVersion REST API method for the Function resource or the FunctionService/CreateVersion gRPC API call.