Secrets
Overview
The Secrets Card safeguards your edge nodes by offering a secure and reliable way to store and manage sensitive information. This minimizes the risk of unauthorized access and data breaches, keeping your critical data protected.
The Secrets Card empowers you to securely:
- Store: Confidently store sensitive information like passwords, API keys, and tokens directly on your edge nodes.
- Manage: Easily upload, download, edit, and delete secrets as needed, all within a secure environment.
- Control Access: Restrict access to secrets, ensuring only authorized users can leverage them.
This article will guide you through utilizing the Secrets Card to bolster the security of your edge deployments. It will cover the process of storing and managing your sensitive data.
Secrets Card UI
The Secrets Card
Cards Index:
- (a) Add a Secret
- (b) Delete All Secrets
- (c) Upload Secrets in a File
- (d) Download Secrets in a File
- (e) Edit Secret
- (f) Delete Individual Secret
- (g) Hide Secrets Card
Reveal a New Secrets Card
Proceed to the top right hand corner in the Barbara Panel. Click on the “+ New” button and scroll down to select the “Secrets” Card.
Adding a New Secrets Card
Your Secrets Card will now appear in the Barbara Panel alongside your other Cards.
If you can’t select your Secrets Card from the drop down menu this is because your card is already in your Node Details view.
Add a Secret
Select the “+” icon to add a Secret value or file.
Adding a New Secret
There are two ways of defining a secret:
Add a Secret's value with Manual Entry
Follow the prompt to name your Secret and enter your chosen value.
New Secret Modal
Add a Secret's value using a file
To add a secret's value using a file, select the slider button on the tab “Add file as a Secret” and choose a file from your desktop. Once you confirm your selection it will be uploaded within your Secrets Card. This is useful when the secret is contained in an archive, as in the case of certificates.
Suppose we want to add a secret named "Test" whose value is contained in the certificate file: ca.crt
ca.crt Certificate File
Once your ca.crt file has been uploaded, select ‘Add” to save it as a Secret.
Add a Secret from the File ca.crt
Download Secrets in a File
Directly download all your Secrets onto your desktop by pressing the “Download” button.
Download Button
You can also choose to download an empty template, if you have no saved Secrets in your card. Your empty download will appear as a “txt” file with the below formula.
SECRET_1=value_1
SECRET_2=value_2
SECRET_3=value_3
Once you have filled out your template (with all your Secret values), proceed to upload your “txt” file using the below “Upload” instructions.
Upload Secrets from a File
You can directly upload “txt” files with multiple Secret values by pressing the “Upload” button.
Upload Button
You can use your empty template as a base structure to fill in all of your Secret values in one place.
user=bob
password=passwordbob
port=9093
Follow the prompt and select your desired template_filled.txt file from your desktop. Click “Upload File” to save your uploaded document to your Secrets Card. Your uploaded template will automatically create individual tabs for each Secret value.
Secrets Uploaded
Editing your Existing Secrets
Select the “Edit” icon to easily update individual Secrets within your Secrets Card.
If a Secret's value was added using a file you won’t be able to edit it.
In order to edit it you must upload a new file and it will automatically overwrite the previous.
Editing Secrets
Follow the prompt to save all of your new adjustments.
Secret Edited
Delete Secrets
You can delete individual Secrets within your card by selecting the “Delete” icon on the Secret asset/value you wish to delete.
Delete Button
If your Secrets Card is empty the delete button will be disabled.
Confirm your choice with the follow-up prompt.
Delete Modal
If you delete a Secret that is being used, your application will still continue working normally.
Only once your application is restarted or updated will the missing Secret cause your app to not work properly, or even crash.
To delete your entire Secrets Card select the “Delete all Secrets” option to the middle, right of your Card.
Delete All Secrets
Hiding Your Secrets Card
You can easily hide your Secrets Card, if you want to tidy-up your panel, without losing any data. Select the “Hide” icon at the top, right of the Secrets Card.
Hide the Card
Confirm your choice to hide your Card with the follow-up prompt.
Hide Confirmation Modal
To easily retrieve your Secrets Card and view it in your Panel go to the “+ New” button and select “Secrets” from the drop down menu (as mentioned in the first step).