> For the complete documentation index, see [llms.txt](https://docs.bdb.ai/administrative-settings-4/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bdb.ai/administrative-settings-4/admin-panel-options/configurations/secret-management.md).

# Secret Management

The ***Secret Management*** setting gives facility to prevent the database-related or any other sensitive/confidential information from getting exposed. In Secret Management Settings the Admin configures the Key of the Sensitive data but the actual value is saved in Kubernetes as Environmental Variable by the DevOps Team.

## Steps to Add Secret Key

* Click on the ***Secret Management*** icon from the Configurations section provided in the Admin panel.​

<figure><img src="https://3626602954-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBxju1xjBIIexZfulhFPA%2Fuploads%2FphGRO8B3U7lP8Ekj4px6%2Fimage.png?alt=media&amp;token=991a2db7-b6ad-451d-9820-8a64e0659d24" alt=""><figcaption></figcaption></figure>

* The ***Secret Management*** page opens.
* Click on the ***New*** option to add a new secre&#x74;***.***

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/CbtVlfBoBfPK7Cb6PuDO/image.png" alt=""><figcaption></figcaption></figure>

* Click the ***Add New Field*** icon for the Secret Management option.

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/REgJvVdiVMbrDDw67yvv/image.png" alt=""><figcaption></figcaption></figure>

* An option to add the ***Secret Key*** appears as shown in the below image:   &#x20;

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/PkyVvUrJvBp7JzBInZsh/image.png" alt=""><figcaption></figcaption></figure>

* Provide the ***Secret Key*** in the given space.
* Click the ***Save*** option.

&#x20;   &#x20;

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/Yjgqdcp3ll32GnuUOZg1/image.png" alt=""><figcaption></figcaption></figure>

* A confirmation message appears.&#x20;
* The secret key will be saved and displayed in the list.

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/tf5MNL49EsTCMgqcdUu1/image.png" alt=""><figcaption></figcaption></figure>

* To add a new field click on the ***Add*** + icon provided for the Secret key.

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/4kOxv8PU7A4ROfYuVMAZ/image.png" alt=""><figcaption></figcaption></figure>

* Add multiple fields like Port, Host, Username, Password, etc. depending upon the selected DB.    &#x20;

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/h7v23uX0g23qoSwWBbVN/image.png" alt=""><figcaption></figcaption></figure>

* Once all the required fields are added, click the ***Save*** option.&#x20;
* A confirmation message appears to ensure that all the inserted fields are saved.

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/o3pWVQ4LUzpz4MAf4cLh/image.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
*<mark style="color:green;">Please Note:</mark>*

* *Click the **View***<img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/Zvbtzgpo539DGU2YVvm9/image.png" alt="" data-size="line"> *icon to display all the added fields.*
* *Click the **Delete*** <img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/KDFVP1QYWDkqkLU9xSKn/image.png" alt="" data-size="line">*icon to remove the added Secret key.*
* *Click the **Close*** <img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/QXN7zyk8KorlpKPG00UL/image.png" alt="" data-size="line">*icon to remove an added field.*
  {% endhint %}

### Steps to Share a Secret Key <a href="#steps-to-share-a-secret-key" id="steps-to-share-a-secret-key"></a>

Once Admin has configured the settings, it is possible to share it to a user/user group to use the encrypted secret keys. Click the ***Share*** <img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/zvGc28GsSBYCQhPqHDOW/image.png" alt="" data-size="line">icon provided next to a saved Secret Key to share it.

* Click the ***Share*** icon for a saved Secret Key.

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/KVLoBRtsKdX3aJFSE1kM/image.png" alt=""><figcaption></figcaption></figure>

* The ***Share Secret Key*** window opens.
* Select the **USER** or **USER GROUP** option to list the users (Use the **EXCLUDE USER** to exclude the user from the right to access a shared Secret Key).
* Select User(s)/User Group(s) from the list.
* Use arrow to move the selected user(s) and user group(s) to the right side box.

&#x20;     ![](https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/Qzd0zTO6fj3uTmSTYLSZ/image.png)​

* Once the selected user(s) and user group(s) appear in the right side box.
* Click the ***Save*** option.

&#x20;     ![](https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/NwvDhbAjPgzqBr4zDiGf/image.png)​

* A confirmation message appears and the Secret Key gets shared to the selected user(s) or user group(s).

<figure><img src="https://content.gitbook.com/content/Bxju1xjBIIexZfulhFPA/blobs/TN56ELSGmzSJVZHtmPt3/image.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
*<mark style="color:green;">Please Note:</mark>*&#x20;

* *Admins must request DevOps to add keys and values in Kubernetes, adhering to Kubernetes naming conventions (Use hyphen or underscore, special characters are restricted) .*&#x20;
* &#x20;*Admins must share these secret keys with relevant users/user groups for access.*
* *Once configured and shared  to respected users and user groups these keys can be utilized across platform modules.*
  {% endhint %}

&#x20;
