Global Vault
The Global Vault offers a centralized repository for managing certain values that are used across multiple components like database credentials, API keys, and environment-specific settings. This ensures that every component of an application references a singular, consistent source for its configurations.
Vault centralizes and manages configuration values that are essential for various components of your application. By simplifying the process of defining, scoping, accessing, and managing these variables, Vault enhances the overall efficiency and security of your deployments. This platform ensures a reliable and streamlined approach to handling configuration values, promoting consistency and reducing maintenance efforts.
The Global Administrator in the Kubeark platform, will have the ability to view all variables stored within the Global Vault as well as the Workspace Vaults (Local Vaults)
The Vault feature in Kubeark, accessible via the Settings Management menu, offers a robust list of platform-specific variables and configurations. Within the main Vault page, users are presented with a main menu organized into multiple tabs, each dedicated to a distinct aspect of the platform. These tabs include Cluster Management, Infrastructure (Infra), Jira, Sources, Template Group, Workspace, User, Function, and Workflows.
- Cluster: Vault's cluster management section provides users the tools to define, edit, and oversee variables associated with different clusters. Ensure each cluster operates with its designated configurations and accesses the correct resources.
- Infra: This is where users manage the variables related to infrastructure setups. Whether you're working on networking configurations or storage parameters, the 'Infra' section makes it straightforward.
- Jira: The Jira tab in Vault is dedicated to managing variables specifically related to Jira integrations. It allows users to configure and maintain settings that ensure seamless connection and interaction with Jira systems. This could include API keys, project IDs, or other data necessary for integrating and automating tasks between Kubeark and Jira.
- Sources: In the Sources tab, admins can manage variables associated with various source control or 3rd party systems.
- Template Group: Organize and manage variables related to different template groups. Tailor configurations to cater to specific template group needs, ensuring optimal deployment and functioning.
- Workspace: The Workspace section within Vault focuses on managing variables that are specific to individual Workspaces
- User: Personalize user experiences or manage user-specific data by employing the user variables section. This feature ensures individual users or groups operate under their specific parameters.
- Function: Integrate and manage specific function-related variables with ease. Whether it's a custom function or a predefined one, ensure it has the right settings to execute correctly.
Step 1 - Access the Vault: navigate to the Settings menu in the main application dashboard
Step 2 - Initiate Key Creation: once inside the Vault section, select Create Key
Step 3 - Fill in the Key details: Upon selecting Create Key, a prompt will open, allowing you to enter the desired arguments for the key creation
Argument | Description |
|---|---|
Name | Enter the desired name for your key. This will be how you reference it in future |
Value | Input the actual data or value for your key. This can be any string of text or numbers. |
Is Secret? | You will see a toggle switch labeled "Yes/No". If your key contains sensitive information that should be hidden or encrypted, toggle this to "Yes". |
Description | Provide a brief description of the key. This can be helpful for others who may use this key, or for you to recall its purpose later. |
Scope | Here, you can define the scope of the key's applicability. Choose from the following options based on where you want this key to be used: -> Cluster -> Infra -> Jira -> Sources -> Template Group -> Workspace -> User -> Function |
Step 4 - Save & Confirm:Once you have filled in all the required arguments, click on Save
Now, you have successfully created a key within Vault. This key will be available for use as per the scope you've defined, ensuring a consistent and efficient configuration process.
