Configuring Google Cloud permissions and Cloud Storage for data export from Cloud Storage to appliance step-by-step

This document describes configuring Google Cloud permissions and Cloud Storage step-by-step, including:

• Preparing your Cloud Storage bucket.
• Preparing a Cloud Key Management Service key to secure your data.
• Providing the Transfer Appliance Team your Cloud Storage bucket configuration data.

Before you begin

Ensure that you have an email from the Transfer Appliance Team titled Google Transfer Appliance Permissions. This email contains:

• The names of the service accounts required for your transfer.

• A session ID that you'll need to configure your appliance.

• A form that you'll complete once you've configured your account.

Prepare the permissions on Cloud Storage bucket

We use two service accounts to transfer your data. Service accounts are special accounts that are used by an application, not a person, to do work. In this case, the service accounts allow Transfer Appliance to use Cloud Storage resources on your behalf to transfer data between Cloud Storage and the appliance. You grant these accounts the necessary roles to transfer data.

To prepare the Cloud Storage bucket, follow these steps:

1. In an email titled Google Transfer Appliance Permissions, the Transfer Appliance Team provides you the following service accounts:

   • A session service account that is tied to this particular transfer. It looks like the following example:

     [e-mail]

     In this example, SESSION_ID is the session ID for this particular transfer.

   • A service agent that is tied to the Transfer service for on-premises data service, which we use to transfer data between Cloud Storage and the appliance. It looks similar to the following example:

     [e-mail]

     In this example, TENANT_IDENTIFIER is a generated number specific to this particular project.

   Note the service accounts for the next steps.

   The service accounts allow Transfer Appliance to manipulate Google Cloud resources on your behalf, namely to transfer data between Cloud Storage and the appliance. You grant these accounts the necessary roles to transfer data between Cloud Storage and the appliance.

2. Cloud Storage buckets are tied to Google Cloud projects. The bucket you select must be in the same project as was used to order the appliance.

3. To grant the Transfer Appliance service accounts permission to use your Cloud Storage bucket, do the following:

   Google Cloud Console

   1. In the Google Cloud console, go to the Cloud Storage Buckets page.
      

      Go to Buckets

   2. Click the Bucket overflow menu () associated with the bucket to which you are granting principal a role.

   3. Choose Edit bucket permissions.

   4. Click the + Add principals button.

   5. In the New principals field, enter the following identities:

      • The session service account. It looks like the following example:

        [e-mail]

        In this example, SESSION_ID is the session ID for this particular transfer.

      • The Transfer service for on-premises data service agent. It looks similar to the following example:

        [e-mail]

        In this example, TENANT_IDENTIFIER is a generated number specific to this particular project.

   6. From the Select a role drop-down menu, select the Storage Admin role.

      The roles you select appear in the pane with a short description of the permissions they grant.

   7. Click Save.

   Command line

   Use the gsutil iam ch command:

   gsutil iam ch \
   serviceAccount:[e-mail]:roles/storage.admin \
   serviceAccount:[e-mail]:roles/storage.admin \
   gs://BUCKET_NAME
   

   In this example:

   • SESSION_ID: The session ID for this particular transfer.
   • TENANT_IDENTIFIER: A generated number specific to this particular project.
   • BUCKET_NAME: The name of the bucket you're creating.

Prepare the Cloud KMS key

Transfer Appliance secures your data on the appliance by encrypting the data. A Cloud Key Management Service (Cloud KMS) public key is used to encrypt your data on Transfer Appliance, and a private key is used to decrypt your data.

We use the session service account from Prepare the permissions on Cloud Storage bucket to upload the data from your Cloud Storage bucket to the appliance.

You have the following option for managing encryption keys:

• Create and manage encryption keys yourself. You create and manage the encryption keys used for your transfer, by following the directions below. You prepare a Cloud KMS asymmetric decryption key and add the session service account to the key.

To prepare Cloud KMS keys, do the following:

1. If you don't have a Cloud Key Management Service key ring, do the following to create one:

   Google Cloud Console

   1. Go to the Cryptographic Keys page in the Google Cloud console.

      Go to the Cryptographic Keys page

   2. Click Create key ring.

   3. In the Key ring name field, enter the desired name for your key ring.

   4. From the Key ring location dropdown, select a location like "us-east1".

   5. Click Create.

   Command line

   gcloud kms keyrings create KEY_RING --location=LOCATION --project=PROJECT_ID
   

   In this example:

   • LOCATION: The Cloud Key Management Service location for the key ring. For example, global.
   • KEY_RING: The key ring's name.
   • PROJECT_ID: The Google Cloud project ID that your storage bucket is under.

2. Create an asymmetric decryption key by doing the following:

   Note: If your project uses VPC Service Controls, verify that the Cloud Storage bucket and the Cloud KMS key that you provide are within the same project. For more information, see List and describe service perimeters.

   Google Cloud Console

   1. Go to the Cryptographic Keys page in the Google Cloud console.

      Go to the Cryptographic Keys page

   2. Click the name of the key ring that you want to create a key for.

   3. Click Create key.

   4. In the What type of key do you want to create? section, choose Generated key.

   5. In the Key name field, enter the name for your key.

   6. Click the Protection level dropdown and select Software.

   7. Click the Purpose dropdown and select Asymmetric decrypt.

   8. Click the Algorithm dropdown and select 4096-bit RSA - OAEP Padding - SHA256 Digest

   9. Click Create.

   Command line

   Run the following command to create an asymmetric decryption key:

   gcloud kms keys create KEY --keyring=KEY_RING \
   --location=LOCATION --purpose=asymmetric-encryption \
   --default-algorithm=rsa-decrypt-oaep-4096-sha256 \
   --project=PROJECT_ID
   

   In this example:

   • KEY: The name of the Cloud Key Management Service key. For example, ta-key.
   • KEY_RING: The key ring's name.
   • LOCATION: The Cloud Key Management Service location for the key ring. For example, global.
   • PROJECT_ID: The Google Cloud project ID that your storage bucket is under.

3. Add the session service account as a principal to the asymmetric key by doing the following:

   Google Cloud Console

   1. Go to the Cryptographic Keys page in Google Cloud console.

      Go to the Cryptographic Keys page

   2. Click the key ring that contains your asymmetric key.

   3. Select the checkbox for the asymmetric key.

   4. In the Info panel, click Add principal.

      Add principals is displayed.

   5. In the New principals field, enter the session service account provided by the Transfer Appliance Team. It looks like the following example:

      [e-mail]

      In this example, SESSION_ID is the session ID for this particular transfer.

   6. In the Select a role field, add the Cloud KMS CryptoKey Public Key Viewer role.

   7. Click Add another role.

   8. In the Select a role field, add the Cloud KMS CryptoKey Decrypter role.

   9. Click Save.

   Command line

   1. Run the following command to grant the session service account the roles/cloudkms.cryptoKeyDecrypter role:

      gcloud kms keys add-iam-policy-binding KEY \
      --keyring=KEY_RING --location=LOCATION \
      --member=serviceAccount:[e-mail] \
      --role=roles/cloudkms.cryptoKeyDecrypter
      

      In this example:

      • KEY: The name of the Cloud Key Management Service key. For example, ta-key.
      • KEY_RING: The key ring's name.
      • LOCATION: The Cloud Key Management Service location for the key ring. For example, global.
      • SESSION_ID: The session ID for this particular transfer.

   2. Run the following command to grant the session service account the roles/cloudkms.publicKeyViewer role:

      gcloud kms keys add-iam-policy-binding KEY \
      --keyring=KEY_RING --location=LOCATION \
      --member=serviceAccount:[e-mail] \
      --role=roles/cloudkms.publicKeyViewer
      

      In this example:

      • KEY: The name of the Cloud Key Management Service key. For example, ta-key.
      • KEY_RING: The key ring's name.
      • LOCATION: The Cloud Key Management Service location for the key ring. For example, global.
      • SESSION_ID: The session ID for this particular transfer.

4. Obtain your asymmetric key's path by doing the following:

   Google Cloud Console

   1. Go to the Cryptographic Keys page in the Google Cloud console.

      Go to the Cryptographic Keys page

   2. Click the key ring that contains your asymmetric decryption key.

   3. Click the asymmetric decryption key's name.

   4. Select the key version that you want, and click More .

   5. Click Copy Resource Name.

      An example of the key format is:

      projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY/cryptoKeyVersions/VERSION_NUMBER

      In this example:

      • PROJECT_ID: The Google Cloud project ID that your storage bucket is under.
      • LOCATION: The Cloud Key Management Service location for the key ring.
      • KEY_RING: The key ring's name.
      • KEY: The name of the Cloud Key Management Service key.
      • VERSION_NUMBER: The key's version number.

      The Transfer Appliance Team requires the entire key path, including the version number, so they can apply the correct key to your data.

   Command line

   Run the following command to list your asymmetric key's full path, including its version number:

   gcloud kms keys versions list --keyring=KEY_RING \
   --key=KEY --location=LOCATION \
   --project=PROJECT_ID
   

   In this example:

   • KEY_RING: The name of your key ring.
   • KEY: The name of your asymmetric key.
   • LOCATION: The Google Cloud location of the key ring.
   • PROJECT_ID: The Google Cloud project ID that your storage bucket is under.

   The following sample response resembles the output that is returned:

   NAME STATE
   projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY/cryptoKeyVersions/VERSION_NUMBER
   ENABLED
   

   In this example:

   • PROJECT_ID: The Google Cloud project ID that your storage bucket is under.
   • LOCATION: The Cloud Key Management Service location for the key ring.
   • KEY_RING: The key ring's name.
   • KEY: The name of the Cloud Key Management Service key.
   • VERSION_NUMBER: The key's version number.

   The Transfer Appliance Team requires the string under NAME that ends in /cryptoKeyVersions/VERSION_NUMBER, where VERSION_NUMBER is your key's version number.

Provide the Transfer Appliance Team with bucket configuration data

We send an email titled Google Transfer Appliance Permissions to collect information about your Cloud Storage bucket. We use the information you provide to configure the transfer data between Cloud Storage and the Transfer Appliance..

In the form linked from that email, enter the following information:

• The Google Cloud project ID.
• Select your choice for Encryption:
  • Customer-managed encryption key, select the encryption key from the Select a customer-managed encryption-key drop-down menu.
• The Google Cloud Cloud Storage bucket name used for this transfer.

What's next?

Configure IP network ports for Transfer Appliance to work on your network.