Configuring parameters for vaulted properties

Before you run a DataStage® flow, you can modify parameters for vaulted properties, which are securely stored in a vault. A vault is a space for managing secrets such as passwords or API keys that applications use to access protected resources.

About this task

You can use parameters for vaulted parameters in your flow connections. Before you run a DataStage flow, you need to set up a parameter set with parameters that directly points to an internal vault.

Procedure

  1. Create an internal vault:
    1. From the navigation panel, go to Configurations and settings.
    2. Select Vaults and secrets, and then click Secrets.
    3. Provide secret details for your vault.
    4. Click Save.
  2. Set up a parameter set with parameters that point to the vault secret. If you do not have a parameter set already, see Creating and using parameter sets in DataStage.
    1. In your project on the asset tab, select your parameter set.
    2. Click Create parameter and select Vaulted secret.
    3. Optional: To specify a default value, select a secret from a vault and choose the secret key for your parameter using the Vault lookup option.
    4. Click Apply and return, then click Save.
  3. Map parameters from a parameter set:
    1. Double-click the connector in your flow and open the Stage tab.
    2. Enter the connection details with your vaulted parameters in the #parameter_set_name.parameter_name# format.
      Example: #custom_paramset.username#
    3. Enter the rest of the connection details, then click Save.
  4. Enable runtime parameters:
    1. Click the Settings icon circular refresh icon and select Runtime parameters option.
    2. Select your parameter set with vaulted parameters to enable it for your flow.
    3. Click Save.
  5. Run your DataStage flow with the parameters that you specified.
  6. Optional: In the logs, click the Parameters tab to see the parameters from your flow that point to the vault secret.