Skip to content

Latest commit

 

History

History
27 lines (23 loc) · 2.09 KB

VAULT_ENCRYPT.md

File metadata and controls

27 lines (23 loc) · 2.09 KB

Encrypting Sensitive Data in MetroÆ

You can safeguard sensitive data in MetroÆ by encrypting files with MetroÆ's encryption tool. See the steps below for instructions on how to encrypt credentials.yml. It uses Ansible's vault encoding in the background. More details about the vault feature can be found in documentation provided by Ansible.

1. Create the credentials file to be encrypted

In your MetroAE deployment folder, create or edit the credentials.yml to store credentials required for various Nuage components. This file will be encrypted.

2. Encrypt credentials.yml

To encrypt credentials.yml, run the following command:

metroae tools encrypt credentials [deployment_name]

The default deployment name is default if not specified. This command will prompt for master passcode to encrypt the file and will also prompt for confirming passcode. Note: All user comments and unsupported fields in the credentials file will be lost.

3. Running MetroÆ with encrypted credentials

While running MetroÆ commands you can supply the MetroÆ passcode via prompt or by setting an environment variable

metroae <workflow> <component> [action] [deployment_name]

This command prompts you to enter the master passcode that you used to encrypt the credentials file. Alternatively, if you have the environment variable METROAE_PASSWORD set to the right passcode, MetroÆ does not prompt for the passcode.

Questions, Feedback, and Contributing

Get support via the forums on the MetroAE site.
Ask questions and contact us directly at devops@nuagenetworks.net.

Report bugs you find and suggest new features and enhancements via the GitHub Issues feature.

You may also contribute to MetroAE by submitting your own code to the project.