Skip to main content
Version: Deploy 24.1

Manage secrets using Azure Keyvault

Your development organization may choose to integrate with an external secrets management tool to support the secure management of secrets. While you can choose to manage sensitive key/value pairs for environment-specific information using internal encrypted dictionaries. Deploy also supports integration with the Azure Key Vault service to manage and inject secrets into Deploy. The API-based integration with Azure Key Vault enables you to define, manage, and use key vault as an external data source for secret storage.

How it works​

The Azure Key Vault integration is a Deploy plugin that allows you to configure external dictionaries that can be used with your environments. You can also define a Azure Key Vault-based lookup provider that can reference and resolve a key/value pair stored in key vault secrets. Deploy does not save or cache the key/value information stored in Azure key vault in the Deploy system.

Use external Azure Key Vault-based dictionaries​

Managing an external Azure key vault dictionary is similar to how you currently manage internal dictionaries in Deploy.

  • You assign a Vault-based dictionary to an environment.
  • During deployment, key/value pairs stored in Vault will replace defined placeholders in the deployment to the environment.

To manage a Vault dictionary, you:

  1. Define a connection to your Vault server and the paths to where secrets and values are stored.
  2. Define an external dictionary using this connection.
  3. Associate the external dictionary with an environment.
  4. Create placeholder references to secrets and other values stored in Azure key vault.

Use an external Azure Key Vault lookup provider​

For secrets and password fields used with certain CI's, you can establish a Azure key vault-based lookup provider that will be used to look up a value based on a lookup provider key that you specify. See Create an external lookup value provider for details.

User access control​

Like any security-related feature, controlling access to sensitive data needs to be managed as a part of the integration. Deploy provides controls to limit access, ensuring that:

  • Developers are authenticated and authorized to read secrets
  • Role-based access to secrets is supported
  • Policies are provided to control credentials and how they can be used

The integration with Vault is controlled by the connection to the Azure Key Vault server itself and the specific list of keys (Secret paths) that the user can access.

Install the plugin​

To install the plugin:

  1. Download the Deploy Azure Key Vault integration from the distribution site.
  2. Place the plugin inside the XL_DEPLOY_SERVER_HOME/plugins/ directory.
  3. Restart Deploy.

For additional details on installing or removing a plugin, see Install or remove Deploy plugins.

Create a Azure Key Vault connection​

Deploy supports the Azure Key Vault using a 'Server' CI configuration type. The role of this type is to allow you to configure a connection to a Azure keyvault server using the Azure Cloud connection and be able to read key values.

To create a new connection to a Vault server:

  1. Hover over Configuration, click Menu button, and select New > secrets > azure > keyvault > Server.

  2. In the Name field, enter a name for the Azure key vault connection.

  3. In the Azure Cloud field, select an predefined Azure server for connection.

  4. In the Vault Name field, enter a name of the key vault.

  5. Click Save or Save and close.

    Create a Azure keyvault connection

Create an external lookup value provider​

You can specify certain properties for a Configuration Item (CI) that should be looked up in an external source. This is useful for sensitive data that is not part of a deployment package such as hosts or cloud targets.

To support this, you can create a special CI type called a LookupValueProvider that references your Vault connection. Once this configuration is in place, you can select the LookupValueProvider and type a key/identifier for the value that you want to use.

To create Vault lookup provider:

  1. Hover over Configuration, click Menu button, and select New > secrets > azure > keyvault > LookupValueProvider.

  2. In the Name field, enter a name for the Azure Keyvault lookup provider.

  3. In the azure-keyvault-lookup-provider field, enter the name of the Azure Key Vault server connection you created earlier (e.g., MyAzureVault).

  4. Click Save or Save and close.

    Create a Vault lookup provider

Create an external dictionary​

Once you have defined your external Azure Key Vault server connection, you can create a dictionary that you can associate with your environments. To create an external dictionary:

  1. Hover over Environments, click Menu button, and select New > secrets > azure > keyvault > Dictionary.

  2. In the Name field, enter a name for the Vault dictionary.

  3. In the Azure Keyvault Manager field, enter the name of the Vault server connection you created earlier (e.g., MyAzureVault).

  4. In the Secret paths field, type one or more secret paths to where key-value pairs are stored.

  5. Click Save or Save and close.

    Create a Vault dictionary

Select an external lookup value provider and key​

After creating an external lookup value provider, you can now select it and choose a key when configuring properties for certain CIs. For example, if you want to store and resolve a password for a host CI:

  1. Hover over Infrastructure, click Menu button, and select New > overthere > SshHost.

  2. Complete the required fields for the CI.

  3. In the SU password field, click Value lookup toggle button and select the LookupProvider you created in Create an external lookup value provider.

  4. In the Lookup provider key field, type the name of the key for the corresponding value that is stored in Azure keyvault.

    Insert a Vault lookup provider

  5. Click Save or Save and close.