Introduction

Integrations let you define and re-apply access data to third-party services in Buddy's pipelines. For example, adding an AWS integration will allow you to upload assets to S3 buckets, deploy ElasticBeanstalk apps, invalidate Cloudfront cache, or run commands in the AWS CLI.

Defining integrations

Whenever you add an action that requires connecting to a third-party service, Buddy will ask you to create an integration. Depending on the type of the integration, you may need to fill a form with the access data (e.g. access and secret keys), or authenticate Buddy in the external service with OAuth (e.g. when connecting to GitHub).

Adding AWS integration

Multiple integrations for one service

You can have multiple integrations of one type in your workspace. For example, you can use several AWS integrations and deploy to different accounts within the same project. There are two ways to add extra integrations.

1. From the account selection dropdown of the action using the integration:

Adding a new integration from an action

2. By clicking the +Add a new integration button in the Integrations tab.

Adding a new integration from the Integrations tab

Scopes

When adding an integration you can define its scope, i.e. who is permitted to define new actions with the access data it contains. By default, every integration is added with the PRIVATE scope, which restricts these permissions to the integration's owner.

Types of scopes

There are four types of integration scopes. Each scope defines who can add and edit actions using the integration:

1. Private – restricted to the owner of the integration. The scope can be further limited to a specific project.
2. Everyone – restricted to the members of the workspace in which the integration was defined. The scope can be further limited to a specific project (recommended for YAML configuration).
3. Administrators – restricted to the admins of the workspace in which the integration was defined. The scope can be further limited to a specific project.
4. Administrators + Group – restricted to admins and a selected group of users in the workspace in which the integration was defined. The scope can be further limited to a specific project (for example, back-end developers in a back-end project).

Managing integrations

All integrations can be managed in the Integrations tab on the left sidebar (https://app.buddy.works/$DOMAIN/workspace/integrations). There you can add and remove integrations and edit their details: name, access data, and scope.

Integration management screen

Integrations in YAML

If you manage your pipelines with YAML, make sure to provide the ID of the integration to the actions that are using it. Here's an example:

 - action: "Upload files to AWS S3"
   type: "AMAZON_S3"
   input_type: "BUILD_ARTIFACTS"
   bucket_name: "buddy-tests-files"
   acl: "PRIVATE"
   integration_hash: "5e391f5aae784b7208de0d0a"

ID hash

You can find the ID on the integration's tile in the Integrations tab:

ID hash of an AWS integration