Skip to content

Secrets

I have the ability to create Secrets through Environment Variables or the Secrets Providers App on an on-prem installation of Nautobot. How does this work with Nautobot Cloud Console?

This is a three-step process, similar to an on-prem installation:

  1. Create a new Secret in Nautobot Cloud Console. This is done via Organization Secrets. To access the detailed documentation click the question mark "?" button at the top of the Secret creation/edition form.
  2. Associate the Secret to your Nautobot instance in Nautobot Cloud Console. To do this click the "+" next to your Secret or navigate to Nautobot instance page Secrets tab and click the "Associate" button at the top of the page. If you intend to use the Secret via environment variable you must restart the Nautobot instance before it will be available.
  3. Create the appropriate Secret(s) and Secret Group(s) inside Nautobot, using secret path(s) or environment variable name(s) provided in Nautobot Cloud Console.

The Secrets Providers App is installed on every Nautobot Cloud instance, so your Nautobot Secrets can also read values from a secrets store you already run.

For full details, see Manage Secrets and Use Secrets Providers.

Should I use HashiCorp Vault or Environment Variables for the Provider type of my Nautobot Secrets?

We recommend using Nautobot Cloud Secrets with the HashiCorp Vault provider. If you need to change the value of a secret, you can simply update the value in the Nautobot Cloud Console and the new value will be available automatically without needing to restart the instance. In the Nautobot Secret form, choose the HashiCorp Vault provider and select nautobot_cloud_vault as the Vault.

How do I reference a Secret or environment variable inside an App's configuration?

Set the App's config field to your environment variable name prefixed with nautobot_cloud__ — for example nautobot_cloud__NAUTOBOT_SSOT_IPFABRIC_HOST. Nautobot Cloud strips the nautobot_cloud__ prefix and substitutes the value of that environment variable (or associated Secret) when the instance starts, so restart or update the instance after changing the Secret. This differs from Nautobot Secrets that use the HashiCorp Vault provider, which pick up changes without a restart. See Reference a Secret in an App's Configuration.