VM Launcher configuration file for data encryption
This is the description of the JSON configuration file for a VM Launcher data encryption data operation.
Last updated
This is the description of the JSON configuration file for a VM Launcher data encryption data operation.
Last updated
The configuration file is in JSON format. It contains the following sections:
Global parameters: General information about the data operation.
Working directory parameters: Information about the input/output directories.
Credential parameters: Information about the credentials for the input/output buckets and the PGP public key.
Here is an example of VM Launcher configuration file for data encryption:
Information about the script location and instructions to execute it.
Information related to the Google Cloud Compute Engine VM where the script will be executed.
Parameter | Description |
---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|---|
Parameter | Description |
---|---|
configuration_type
type: string
mandatory
Type of data operation.
For an STS data operation, the value is always "storage-to-storage".
configuration_id
type: string
mandatory
ID of the data operation.
You can pick any name you want, but is has to be unique for this data operation type.
Note that in case of conflict, the newly deployed data operation will overwrite the previous one. To guarantee its uniqueness, the best practice is to name your data operation by concatenating:
your account ID,
the source bucket name,
and the source directory name.
environment
type: string
mandatory
Deployment context.
Values: PROD, PREPROD, STAGING, DEV.
account
type: string
mandatory
Your account ID is a 6-digit number assigned to you by your Tailer Platform administrator.
activated
type: boolean
optional
Flag used to enable/disable the execution of the data operation.
If not specified, the default value will be "true".
archived
type: boolean
optional
Flag used to enable/disable the visibility of the data operation's configuration and runs in Tailer Studio.
If not specified, the default value will be "false".
pgp_mode
type: string
optional
PGP mode.
For data encryption, the value is always "ENCRYPT".
gcp_project_id
type: string
mandatory
Google Cloud Platform project ID for the bucket containing the script.
gcs_source_bucket
type: string
mandatory
Name of the GCS bucket containing the files to encrypt.
gcs_source_prefix
type: string
mandatory
Path in the GCS bucket containing the files to encrypt, e.g. "some/sub/dir".
destination_gcs_bucket
type: dict
mandatory
Name of the GCS bucket containing the encrypted files.
destination_gcs_path
type: array
mandatory
Path in the GCS bucket containing the encrypted files, e.g. "some/sub/dir".
vm_delete
type: string
mandatory
If set to "true", this parameter will force the deletion of the VM at the end of the data operation. Running Compute Engine VMs will incur extra costs, so it is recommended to leave this parameter on "true".
Default value: true
vm_core_number
type: string
mandatory
Virtual CPU (vCPU) count. It is recommended to leave the default parameter, as this should allow sufficient performance to run a standard script.
Default value: 2
vm_memory_amount
type: string
mandatory
System memory size (in GB).
It is recommended to leave the default parameter, as this should allow sufficient performance to run a standard script.
Default value: 4
vm_disk_size
type: string
mandatory
Persistent disk size (in GB).
It is recommended to leave the default parameter, as this should provide enough space to store the data to process.
Default value: 20
credentials
type:array
mandatory
Array containing three entities: input credentials for the input bucket, output credentials for the output bucket, and the public PGP key.