GCP integration

Create a Google Cloud Platform (GCP) integration with SuperAnnotate to add items from your GCP storage to SuperAnnotate. SuperAnnotate will have read-only access to your data; your items are stored in your storage and are only displayed in SuperAnnotate.

🚧

Permissions

Only Team Owners and Team Admins can create and manage integrations.

Create a GCP integration

🚧

Enable CORS for Text Projects

You’ll need to enable CORS in your storage to add items in your Text Projects. Learn more.

Step 1: Go to the integrations page

700
  1. In Integrations, click New Integration.
  2. Select GCP.
  3. On the setup page, type your integration name and your GCP bucket name.
  4. You can add the integration to a selected team or multiple teams. The integration will be available in the selected team(s) only. Note that this step is optional. If you don’t select a team, then the integration won’t be added to any team. You can always add the integration to a team from the Integrations list.

❗️

Adding or removing a team allows or restricts access to the data related to this integration.

Step 2: Create a service account and grant permissions

📘

You can use an existing account, but we recommend you create a new one. If you want to use an existing one, skip to Step 3.

700
  1. Go to your GCP.
  2. In IAM & Admin, go to Service Accounts.
  3. Click Create Service Account.
  4. Type the name of your service account.
  5. Click Create And Continue.
  6. Click Done.

Step 3: Grant permissions

700
  1. Go to your service account.
  2. Copy the email.
  3. Go to your bucket.
  4. In the Permissions tab, click Add.
  5. Add the email in New principals.
  6. Select the Storage Object Viewer role.
  7. Click Save.

Step 4: Upload the service account’s key

700
  1. Go to your service account.
  2. In the Keys tab, click Add Key.
  3. Select Create new key.
  4. The key type is JSON by default. Keep it that way and click Create. A JSON file will be downloaded.
  5. Go to your integration setup page in SuperAnnotate and upload the JSON file. If the JSON file failed to upload, you'll see this message: Oh no! The JSON file failed to upload. Please check the file and try again.
  6. Click Create.

📘

Messages

  • If the integration is created successfully, you'll see this message: You've successfully created the integration.
  • If the integration couldn't be created, you'll see this message: Oh no! The integration couldn’t be created. Check out the instructions on how to create integrations.

Validate integration

To validate your GCP integration:

  1. In Integrations, find your integration.
  2. Click the three dots button.
  3. Select Check connection.
    • If the integration is valid, you’ll see a success message that says: “The connection of the integration “[your integration name]” is valid.”
    • If the integration is invalid, you’ll see an error message that says: “The connection of the integration “[your integration name]” is invalid.”

📘

Messages

  • If the connection is valid, you'll see this message: The connection is valid.
  • If the connection isn't valid, you'll see this message: The connection is not valid.

📘

Who can create and use integrations?

  • Only Team Owners can create integrations.
  • Only Team Owners, Team Admins, and Project Admins (with permission) can use integrations. To allow Project Admins to use integrations, check the Upload box under Project Admin Permissions in Settings.

🚧

Limitations

  • You can't upload more than 50,000 items to the root or a folder. The remaining items will be skipped.
  • A project can't contain more than 500,000 items.
  • A folder name can't exceed 120 characters and can't contain the following characters: / \ : * ? " < > |

Edit team

To add or remove an integration to a team or multiple teams:

  1. In Integrations, find your integration.
  2. Click the three dots button.
  3. Select Edit team.
  4. Add or remove teams.
  5. Click Save.

Delete integration

To delete an integration:

  1. In Integrations, find your integration.
  2. Click the three dots button.
  3. Select Delete Integration.
  4. In the popup, click Delete.

📘

Messages

If the integration is successfully deleted, you'll see this message: You've successfully deleted the integration.

Add items with your GCP integration

You can add items from your GCP storage to Image Projects, Video Projects, and Text Projects.

  1. In Data, click Add.
  2. Select Upload Images, Upload Video (with frames), Upload Videos, or Upload Documents (depending on your project type).
  3. Go to External Storage.
  4. In Integrations, choose an integration (mandatory) and type a folder path (optional).
  5. Click Upload.

When the upload is in progress, you'll see this message: Your upload is in progress. This might take a while. Click Refresh to see your uploaded items. When you see that, refresh the page.

📘

Message

  • If the items failed to upload, you'll see this message: Oh no! Your items failed to upload.

When you add items from an integrated GCP bucket to SuperAnnotate, you can’t:

  • Run Smart Segmentation
  • Run Smart Prediction
  • Create models and run trainings
  • Export in the COCO format
  • Include fused images in your download
  • Set the upload quality in Settings