Skip to navigation

Manually encrypt properties

This page explains how to use the $SECRET syntax to store specific property values in Vault instead of in Platform.

Reference syntax

To reference a secret, replace the property value with a Vault reference in the following format:

"$SECRET_<path> $KEY_<key>"

For example, "$SECRET_default_password $KEY_key" evaluates to "password".

Include a space before $KEY_.

Encrypt adapter properties

1

Create a secret in Vault

In Vault, create a path and key name for the property. Use a path and key name that clearly relate to the property.

2

Open the adapter configuration

Go to Admin Essentials, click Adapters, and select an adapter.

3

Turn on Advanced View

Click the Advanced View toggle to view the JSON configuration, which can be easier to edit.

4

Replace the value with a reference

Remove the existing value and replace it with the Vault reference. For the format, see Reference syntax.

5

Save the configuration

Click Save. The adapter restarts automatically and uses Vault to decrypt the property.

6

Verify the connection

Confirm that the adapter appears in the list with a green status indicator and connection icons.

Encrypt integration properties

1

Create a secret in Vault

In Vault, create a path and key name for the property. Use a path and key name that clearly relate to the property.

2

Open the integration configuration

Go to Admin Essentials, click Integrations, and select an integration.

3

Locate the property

Find the value that you want to encrypt.

4

Turn on Advanced View

Click the Advanced View toggle to view the JSON configuration.

5

Replace the value with a reference

Remove the existing value and replace it with the Vault reference. For the format, see Reference syntax.

6

Save the configuration

Click Save. The integration restarts automatically and uses Vault to decrypt the property.

Encrypt profile properties

1

Create a secret in Vault

In Vault, create a path and key name for the property. Use a path and key name that clearly relate to the property.

2

Open the profile configuration

Go to Admin Essentials, click Profiles, and select the running profile.

3

Select the property

Click the Configure tab and select the profile property that you want to encrypt.

4

Replace the value with a reference

Remove the existing value and replace it with the Vault reference. For the format, see Reference syntax.

5

Save the configuration

Click Save.

6

Restart Platform

Restart Platform to apply the changes.

Encrypt properties.json values

1

Create a secret in Vault

In Vault, create a path and key name for the property. Use a path and key name that clearly relate to the property.

2

Open properties.json

Open the properties.json file and select the property that you want to encrypt, for example "mongoProps.credentials.passwd".

You can’t encrypt vaultProps values in properties.json.

3

Replace the value with a reference

Remove the existing value and replace it with the Vault reference. For the format, see Reference syntax.

4

Save the file

Save properties.json.

5

Restart Platform

Restart Platform to apply the changes.

What’s next