Create a destination for GCP + GCS + Databricks or Snowflake

For cloud connectivity with Redox, you decide which cloud provider and cloud product(s) to use. Then, you'll need to create a cloud destination in your Redox organization.

You'll need to perform some steps in your cloud product(s) and some in Redox. You can perform Redox setup in our dashboard or with the Redox Platform API.

This article is for this combination of cloud products:

• Google Cloud Platform (GCP)
• Google Cloud Storage (GCS)

or

• Google Cloud Platform (GCP)
• Google Cloud Storage (GCS)
• Databricks or Snowflake

1. Navigate to the GCP dashboard and log in.
2. Create a GCS bucket.
3. Create a service account in your GCP project.
4. Grant the service account read/write access to the GCS bucket.
5. Create a new key for your service account.
6. A new key file is downloaded. Save this file, since you'll need it for Redox setup later.

Next, create a cloud destination in your Redox organization. This destination will be where your data is pushed to.

1. For the select destination step, follow the instructions for creating a cloud destination.
   1. From the Product type field, select Databricks or Snowflake if you're using one of those cloud products with GCS. Your GCS settings will be ingested with the additional cloud product. Select Cloud Storage if you're not also using Databricks or Snowflake.
2. For the configure destination step, populate these fields.
   1. Bucket name: Enter the GCS bucket name. Locate this value in the GCP dashboard.

      Bucket naming requirements

      We validate that the bucket name meets Google's naming requirements. Review bucket naming requirements.

   2. Object filename prefix: Enter any prefix you want prepended to new files when they're created in the GCS bucket. Add / to put the files in a subdirectory. For example, redox/ puts all the files in the redox directory.
3. Click the Next button.
4. For the auth credential step, either a drop-down list of existing auth credentials displays or a new auth credential form opens. Learn how to create an auth credential for OAuth 2.0 2-legged with JWT for GCP.

   Existing or new auth credential

   Your existing auth credentials will only display if they're supported for the cloud product type you selected. If you don't have any supported auth credentials for the cloud type in the current Redox environment, you'll have to create a new auth credential.

5. For the verify step, follow the instructions for verifying a destination.

1. Review the Create auth credential endpoint.
2. In your terminal, prepare the /v1/authcredentials request.
3. Specify these values in the request.
   • Locate the keyId, clientId (value of client_email), and privateKey values in the downloaded key file from GCP.
   • Make sure the auth credential's environment ID matches the environment ID of the destination you intend to link it to.
   • Use the values we provide in the example for authStrategy, grantType, algorithm, url, and scopes. These are fixed values.

     Example: Create auth credential for GCP + GCS + Databricks or Snowflake

     json

     Copy

     1
     curl 'https://api.redoxengine.com/platform/v1/authcredentials' \
     2
     --request POST \
     3
     --header 'Authorization: Bearer $API_TOKEN' \
     4
     --header 'accept: application/json' \
     5
     --header 'content-type: application/json' \
     6
     --data '{
     7
         "organization": "<Redox_organization_id>"
     8
         "name": "<human_readable_name_for_auth_credential>"
     9
         "environmentId": "<Redox_environment_ID>"
     10
         "authStrategy": "OAuth_2.0_JWT_GCP"
     11
         "grantType": "client_credentials"
     12
         "url": "https://oauth2.googleapis.com/token"
     13
         "algorithm": "RS256"
     14
         "clientId": "<client_email>"
     15
         "scopes": "https://www.googleapis.com/auth/devstorage.read_write"
     16
         "keyId": "<keyId_from_GCP>"
     17
         "privateKey": "<privateKey_from_GCP>"
     18
       }
4. You should get a successful response with details for the new auth credential.
5. Review the Create destination endpoint.
6. In your terminal, prepare the /v1/environments/{environmentId}/destinations request.
7. Specify these values in the request.
   • Set authCredential to the auth credential ID from the response you received in step #4.
   • Populate cloudProviderSettings with the settings below.
     • The fileNamePrefix is optional. If specified, the filename format will be the prefix you define appended by the log ID. If not specified, the filename will simply be the log ID.

       Product ID for multiple cloud products with GCP

       If GCS is your only cloud product, set the productId to gcs.

       If you're combining GCS with Databricks or Snowflake, set the productId to the additional cloud product (i.e., databricks or snowflake), depending on your specific setup.

       Example: Values for GCP + Databricks or Snowflake cloudProviderSettings

       json

       Copy

       1
       {
       2
         "cloudProviderSettings": {
       3
           "typeId": "gcp",
       4
           "productId": "<databricks_or_snowflake_or_gcs>", 
       5
           "settings": {
       6
             "bucketName": "<bucket_name_from_GCS>", 
       7
             "fileNamePrefix": "<optional_prefix>",
       8
               //You can append `/` after the prefix name to indicate a directory path"
       9
            }
       10
         }
       11
       }
8. You should get a successful response with details for the new destination for GCP.
9. Your new destination will now be able to receive messages. These messages get stored in your GCS bucket, which can then be picked up by Databricks or Snowflake for further processing.