Transmitting a secret to Yandex Cloud Functions

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To transmit a Yandex Lockbox secret to a function, run this command:

yc serverless function version create \
  --function-name=test \
  --runtime nodejs16 \
  --entrypoint index.main \
  --memory 128m \
  --execution-timeout 5s \
  --source-version-id vfdsdeqa1s2d3******** \
  --service-account-id bfbtfcp0o9i8******** \
  --secret environment-variable=KEY,id=fc3q4aq3w5e6********,version-id=fc3gvvz4x5c6********,key=secret-key

Where:

• --function-name: Function name.

• --runtime: Runtime environment.

• --entrypoint: Entry point in <function_file_name>.<handler_name> format.

• --memory: Amount of RAM.

• --execution-timeout: Maximum function running time before the timeout is reached.

• --source-version-id: ID of the function version from which you want to copy the code.

• --service-account-id: ID of the service account with the lockbox.payloadViewer role.

• --secret:

  • environment-variable: Name of the environment variable that will store the secret.
  • id: Secret ID.
  • version-id: Secret version ID.
  • key: Key of one of the key-value pairs in the secret version.

  You can transmit multiple secrets to a function. To do this, specify the --secret parameter as many times as needed.

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

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

   resource "yandex_function" "test-function" {
     name               = "test-function"
     description        = "Test function"
     user_hash          = "first-function"
     runtime            = "python37"
     entrypoint         = "main"
     memory             = "128"
     execution_timeout  = "10"
     service_account_id = "<service_account_ID>"
     tags               = ["my_tag"]
     secrets {
       id                   = "<secret_ID>"
       version_id           = "<secret_version_ID>"
       key                  = "<secret_1_key>"
       environment_variable = "<environment_variable_1_name>"
     }
     secrets {
       id                   = "<secret_ID>"
       version_id           = "<secret_version_ID>"
       key                  = "<secret_2_key>"
       environment_variable = "<environment_variable_2_name>"
     }
   
      content {
        zip_filename = "<path_to_ZIP_archive>"
      }
   }
   

   Where:

   • secrets: Section with secret settings. It contains the following parameters:
     • id: Secret ID. This is a required parameter.
     • version_id: Secret version ID. This is a required parameter.
     • key: Key of one of the secret version's key-value pairs that will be stored in the environment variable. This is a required parameter.
     • environment_variable: Name of the environment variable that will store the secret. This is a required parameter.

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

2. Apply the changes:

   1. In the terminal, go to the directory where you edited the configuration file.

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

      terraform validate
      

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

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

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

You can check the function's update settings in the management console.

To transmit a Yandex Lockbox secret to a function, use the createVersion REST API method for the Function resource or the FunctionsService/CreateVersion gRPC API call.