Configure your Google Cloud project using the setup application

This document describes configuring Google Cloud permissions and Cloud Storage using the Appliance Cloud Setup Application.

The Appliance Cloud Setup Application prompts you for information, such as your transfer session ID, destination Cloud Storage bucket and Cloud Key Management Service (Cloud KMS) preferences. Using the information you provide, the Appliance Cloud Setup Application configures your Google Cloud permissions, preferred Cloud Storage bucket, and Cloud KMS key for your transfer.

Before you begin

Ensure that you have the following:

• The name of the project and the business location used for ordering the appliance.

• The Appliance ID, session ID, bucket name, bucket prefix, and encryption key specified when ordering the appliance. These can be found in the email titled Google Transfer Appliance Prepare Permissions and Storage.

• The Storage Transfer Service service agent listed in the email titled Google Transfer Appliance Prepare Permissions and Storage. It looks similar to the following example:

  [e-mail]

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

  We use Storage Transfer Service to transfer data from the appliance to your Cloud Storage bucket.

Assign IAM roles

You must have the correct IAM roles on the project and Cloud Storage bucket.

If you are the project owner, roles/owner is sufficient. Skip to the next section, Download the Appliance Cloud Setup Application.

If you don't have roles/owner you must have the following roles:

• roles/serviceusage.serviceUsageAdmin: To enable the required APIs in the project.
• roles/iam.serviceAccountCreator: To create new service accounts.
• roles/iam.serviceAccountKeyAdmin: To create and download service account keys. Can be granted at the project level, or can be granted to the Appliance service account once it's been created by the permissions app.
• roles/storagetransfer.admin: To create the Storage Transfer Service service account.
• roles/transferappliance.viewer: To fetch Cloud Storage bucket and Cloud Key Management Service key details.
• roles/storage.admin: Can be granted at the project level if you haven't created a Cloud Storage bucket, or can be granted at the bucket level if you're using an existing Cloud Storage bucket.
• roles/cloudkms.admin: Can be granted at the project level if you haven't created a Cloud KMS key, or can be granted at the key level if you're using an existing Cloud KMS key.

Viewing roles

To view IAM roles that your principals have for a project and its resources, do the following:

1. In the Google Cloud console, go to the IAM page.

   Go to the IAM page

2. The page displays all the principals that have IAM roles on your project.

Download the Appliance Cloud Setup Application

To download the Appliance Cloud Setup Application:

1. Open the Google Cloud console Welcome page.

   Open the Google Cloud console Welcome page

2. Verify that the name of the project used for the transfer is displayed in the project selector. The project selector tells you what project you are currently working in.

   

   If you don't see the name of the project you are using for the transfer, click the project selector, then select the correct project.

3. Click Activate Cloud Shell.

   

4. In Cloud Shell, use the wget command to download the Appliance Cloud Setup Application:

   wget https://storage.googleapis.com/transferappliance/cloudsetup/ta_cloudsetup_x86_64-linux -O ta_cloudsetup_x86_64-linux
   

Run the Appliance Cloud Setup Application

In Cloud Shell, run the following command to start the Appliance Cloud Setup Application:

chmod 0777 ta_cloudsetup_x86_64-linux && ./ta_cloudsetup_x86_64-linux

The app walks you through the steps required to configure your project.

Application output

The Appliance Cloud Setup Application completes the following actions:

• Grants permissions to the Appliance service accounts used to transfer data to your Cloud Storage bucket.
• If you chose to use a customer-managed encryption key, grants permission to the Appliance service accounts to access Cloud KMS key data.

• Displays the following information:

  • The Google Cloud cryptographic key resource name, if you chose to use a customer-managed Cloud KMS encryption key.
  • The Google Cloud Cloud Storage destination bucket name.
  • A Google Cloud Cloud Storage destination bucket prefix, if you supplied one.
  • If applicable, the Online Transfer service account name, and the Storage Transfer Service service agent name.

The information displayed is also stored within the home directory on Cloud Shell, named SESSION_ID-output.txt, where SESSION_ID is the session ID for this particular transfer.

The names of the service accounts granted permission for this particular transfer are stored within the home directory on Cloud Shell, named cloudsetup.log.

Send CMEK information to Google

If you specified a customer-managed encryption key, send us the key information by completing the form linked from the email titled Google Transfer Appliance Prepare Permissions and Storage.

Download service account keys

Download and save a service account key for the Online Transfer Service Account.

gcloud iam service-accounts keys create key.json \
  --iam-account=APPLIANCE_SERVICE_ACCOUNT_EMAIL

The value of APPLIANCE_SERVICE_ACCOUNT_EMAIL is displayed in the output of the permissions app:

...

Appliance Service Account Name:
[e-mail]

When you receive your appliance, upload the key to the /tmp directory on the appliance.

Troubleshooting

Error 400: Service account does not exist

Issue:

Appliance Cloud Setup Application displays the following message:

Service account [e-mail]
does not exist.

Where SESSION_ID is the session ID provided to Appliance Cloud Setup Application.

Solution:

Verify the session ID for your transfer. The session ID is unique to each transfer session and shared by the Transfer Appliance Team. If you haven't received a session ID, contact [e-mail].

Error: Listing KMS locations

Issue:

Appliance Cloud Setup Application displays the following message:

Error: listing kms locations

Solution:

Do the following within Cloud Shell:

1. Re-authenticate by running gcloud auth login.

2. Retry Appliance Cloud Setup Application.

If the error persists, contact the Transfer Appliance Team at [e-mail].

Error: Creating Cloud KMS key constraint error

Issue:

Appliance Cloud Setup Application displays a message similar to the following:

Error: creating cloud kms key violates constraint error: code = FailedPrecondition
desc= europe-west6 violates constraint 'constraints/gcp.resourceLocations' on
the resource 'projects/test/locations/europe-west6'

Solution:

Your Google Cloud project may have organization policies that disallow creating Cloud Key Management Service keys in certain locations. The following are possible solutions:

• Choose a different location to create the Cloud Key Management Service key.
• Update the organization policy to allow Cloud Key Management Service key creation in the location you desire.

For more information see Restricting Resource Locations.