Service Connection Exposer

About this extension

This extension provides the following components:

• A service connection for connecting to an Azure RM account
• A service connection for connecting to an Amazon Web Services(AWS) account
• A service connection for connecting to a Google Cloud Platform(GCP) account
• A task for setting connection environment variables for downstream tasks

Create a new service connection for connecting to an AWS account

The task requires a AWS service connection for setting up the credentials to connect to an AWS account. For setting up a new AWS service connection:

• On the project page, go to Project settings and choose Service connections.
• In the New service connection list, choose AWS for ServiceConnectionExposer.
• Enter the following details to set up the service connection:
  • Connection name*: Enter a unique name of the service connection to identify it within the project
  • Access key id*: Enter the access key id for your AWS account
  • Secret access key*: Enter the secret access key associated with the access key id
  • Region*: Enter the region of the Amazon Simple Storage Service(S3) bucket in which you want to store the ServiceConnectionExposer remote state file e.g. 'us-east-1'

Create a new service connection for connecting to a GCP account

The task requires a GCP service connection for setting up the credentials to connect to a GCP service account. For setting up a new GCP service connection:

• Download the JSON key file containing the required credentials
  • In the GCP Console, go to the Create service account key page.
  • From the Service account list, select the existing service account or New service account to create a new one.
  • If New service account was selected in the previous step, in the Service account name field, enter a name.
  • From the Role list, select Project > Owner.
  • Click Create. A JSON file that contains your key downloads to your computer.
• On the project page, go to Project settings and choose Service connections.
• In the New service connection list, choose GCP for ServiceConnectionExposer.
• Enter the following details to set up the service connection:
  • Connection name*: Enter a unique name of the service connection to identify it within the project
  • Project id*: Enter the project id of the GCP project in which the resources will be managed
  • Client email*: Enter the value of the client_email field in the JSON key file
  • Token uri*: Enter the value of the token_uri field in the JSON key file
  • Scope*: Enter the scope of access to GCP resources e.g. https://www.googleapis.com/auth/cloud-platform. For more information, see granting roles to service accounts
  • Private key*: Enter the value of the private_key field in the JSON key file

Task

• Search for Service Connection Exposer and click on Add

• Select the required provider from the Provider list. The available options denote the following:

  • azurerm - Azure Resource Manager
  • aws - Amazon Web Services
  • gcp - Google Cloud Platform

Setting up AzureRM backend configuration

• Azure subscription*: Select the Azure subscription to use for AzureRM backend configuration

Setting up AWS backend configuration

• Amazon Web Services connection*: Select the AWS connection to use for AWS backend configuration

Setting up GCP backend configuration

• Google Cloud Platform connection*: Select the GCP connection to use for GCP backend configuration

NOTE: If your connection is not listed or if you want to use an existing connection, you can setup a service connection, using the 'Add' or 'Manage' button.