Contents

• What are External Credentials?
• How to add External Credentials to Peak
• Using External Credentials

What are External Credentials?

External Credentials enable the Peak platform to connect with external systems such as code repositories. These credentials are often required within Workflow input parameters and image build arguments.

Storing External Credentials as plain text in your repo or even within input parameters can be dangerous as they can easily be identified and copied by other users. Using the External Credentials tool will prevent this from happening. It will also help when you need to refresh your keys as you will only need to do it in one place!

Supported repositories

Peak supports External Credentials for the following repositories:

• Custom

• Bitbucket

• GitHub

• GitLab

How to add External Credentials to Peak

1. Go to Console > Access Tokens.

2. Scroll down to the External Credentials area.

3. Click ADD.
   The Create External Credential input box appears.

   
   

4. Give the credential a suitable name.

5. Select the required type, for example GitHub.

6. Enter the required credentials for your chosen type.
   The credentials that are required will vary according to the repository you are accessing.

7. Click SUBMIT.
   The new credential is added to the External Credentials list.
   

   
   

Editing and deleting credentials

To edit a credential:

1. Hover your cursor over the row with the credential details you want to edit.

2. Click on the pencil icon that appears.

3. Make any required changes and click SUBMIT.

If you no longer need the external credential, you can delete it:

1. Hover your cursor over the row with the credential details you want to delete.

2. Click on the trash icon that appears.

Using External Credentials

Once your External Credentials have been added, they can be used for:

• Docker files

• Scripts

• Build arguments when building Workspaces, Workflows and Web Apps.

For more information, see How to use External Credentials.