Installing the App in Nautobot¶
Here you will find detailed instructions on how to install and configure the App within your Nautobot environment.
Prerequisites¶
- This app is compatible with Nautobot 2.0.0 and higher.
- Databases supported: PostgreSQL, MySQL
Note
Please check the dedicated page for a full compatibility matrix and the deprecation policy.
Before you proceed, you must have at least one of the dependent libaries installed as detailed below.
Please do not enable this app until you are able to install the dependencies, as it will block Nautobot from starting.
Dependencies¶
For this app to operate you must install at least one of the dependent libraries required by the secrets providers.
You must install the dependencies for at least one of the supported secrets providers or a RuntimeError
will be raised.
AWS¶
AWS Secrets Manager and Systems Manager Parameter Store are supported. Both providers require the boto3
library. This can be easily installed along with the app using the following command:
Azure Key Vault¶
The Azure Key Vault provider requires the azure-identity
and azure-keyvault-secrets
libraries. This can be easily installed along with the app using the following command:
Delinea/Thycotic Secret Server¶
The Delinea/Thycotic Secret Server provider requires the python-tss-sdk
library. This can easily be installed along with the app using the following command:
HashiCorp Vault¶
The HashiCorp Vault provider requires the hvac
library. This can easily be installed along with the app using the following command:
1Password Vault¶
The 1Password Vault provider requires the onepassword-sdk
library. This can easily be installed along with the app using the following command.
Note
The 1Password Vault requires a minimum version of Python 3.9.
Access Requirements¶
There are no special access requirements to install the app.
Install Guide¶
Note
Apps can be installed from the Python Package Index or locally. See the Nautobot documentation for more details. The pip package name for this app is nautobot-secrets-providers
.
The app is available as a Python package via PyPI and can be installed with pip
:
To ensure Secrets Providers is automatically re-installed during future upgrades, create a file named local_requirements.txt
(if not already existing) in the Nautobot root directory (alongside requirements.txt
) and list the nautobot-secrets-providers
package:
Once installed, the app needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your nautobot_config.py
file:
- Append
"nautobot_secrets_providers"
to thePLUGINS
list. - Append the
"nautobot_secrets_providers"
dictionary to thePLUGINS_CONFIG
dictionary and override any defaults.
# In your nautobot_config.py
PLUGINS = ["nautobot_secrets_providers"]
# PLUGINS_CONFIG = {
# "nautobot_secrets_providers": {
# ADD YOUR SETTINGS HERE
# }
# }
Once the Nautobot configuration is updated, run the Post Upgrade command (nautobot-server post_upgrade
) to run migrations and clear any cache:
Then restart (if necessary) the Nautobot services which may include:
- Nautobot
- Nautobot Workers
- Nautobot Scheduler
App Configuration¶
View configuration details for specific secrets providers on their dedicated pages here.