Skip to main content

Add an AWS KMS secret manager

To store and use encrypted secrets (such as access keys) and files, you can add an AWS KMS Secret Manager.

This topic describes how to add an AWS KMS Secret Manager in Harness.

Before you begin​

Step 1: Add a Secret Manager​

This topic assumes you have a Harness Project set up. If not, see Create Organizations and Projects.

You can add a Connector from any module in your Project in Project setup, or in your Organization, or Account Resources.

In Connectors, click Connector.

In Secret Managers, click AWS KMS. The AWS Key Management Service settings appear.

Step 2: Overview​

Enter Name for your secret manager.

You can choose to update the ID or let it be the same as your secret manager's name. For more information, see Entity Identifier Reference.

Enter Description for your secret manager.

Enter Tags for your secret manager.

Click Continue.

Option: Credential Type​

You can select the following options for authenticating with AWS:

  • AWS Access Key.
  • Assume IAM role on delegate.
  • Assume Role using STS on delegate.

Option: AWS Access Key​

Use your AWS IAM user login credentials.

Either from the JSON for the Key Policy, or in the AWS IAM console, under Encryption keys, gather the AWS Access Key ID, AWS Secret Key, and Amazon Resource Name (ARN).

For more information, see Finding the Key ID and ARN from Amazon.

AWS Access Key ID​

Click Create or Select a Secret.

In the secret settings dialog, you can create/select a Secret and enter your AWS Access Key as it's value.

The AWS Access Key is the AWS Access Key ID for the IAM user you want to use to connect to Secret Manager.

AWS Secret Access Key​

Click Create or Select a Secret.

You can create a new Secret with your Access Key ID's secret key as the Secret Value, or use an existing secret.

AWS ARN​

Click Create or Select a Secret.

As explained above, you can create a new Secret with your ARN as the Secret Value, or use an existing secret.

Option: Assume IAM Role on Delegate​

If you select Assume the IAM Role on Delegate Harness will authenticate using the IAM role assigned to the AWS host running the Delegate, you select using a Delegate Selector.

Option: Assume Role using STS on Delegate​

This option uses the AWS Security Token Service (STS) feature. Typically, you use AssumeRole within your account or for AWS cross-account access.

Role ARN​

Enter the Amazon Resource Name (ARN) of the role that you want to assume. This is an IAM role in the target deployment AWS account.

External ID​

If the administrator of the account to which the role belongs provided you with an external ID, then enter that value.

For more information, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party from AWS.

Assume Role Duration (seconds)​

This is the AssumeRole Session Duration. See Session Duration in the AssumeRole AWS docs.

Step 3: Setup Delegates​

In Delegates Setup, enter Selectors for specific Delegates that you want to allow to connect to this Connector. Click Save and Continue.

Step 4: Test Connection​

In Connection Test, click Finish after your connection is successful.