Managing workspace configurations

In this guide, you'll learn how to manage essential configurations for your Paradime workspace. Proper configuration management ensures consistency, security, and flexibility across your analytics engineering projects.

Estimated completion time: 10 minutes

Prerequisites

An admin role In Paradime to create workspaces

What you'll learn

1. Managing dbt™ Versions in Paradime Workspaces

Paradime allows you to centrally manage the dbt™ version for your entire workspace, ensuring consistency across both the Code IDE and Bolt scheduler for all users. This feature is crucial for maintaining compatibility and leveraging the latest dbt™ functionalities across your projects.

View your current dbt version:

Navigate to your account settings.
Select the Workspace tab.
Under the project settings section, find the current dbt™ version configuration.

Upgrade or downgrade your dbt ™version

Before changing the dbt™ version, ensure that your projects are compatible with the new version to avoid any potential issues.

Click the Edit button next to the current dbt™ version.
Select the desired dbt™ version from the dropdown menu.
Click the Save button to apply the changes.

Once saved, all users in the workspace will inherit this dbt™ version, which applies to both the Code IDE and the Bolt scheduler.

2. Setting Up Environment Variables

Environment variables in Paradime allow you to securely store and use sensitive information or configuration details, particularly for use with the Bolt scheduler. This feature helps you maintain security and flexibility in your dbt™ jobs and schedules.

Add a New Environment Variable

Navigate to your account settings.
Select the "Workspace" section from the top left.
Click on the Add Variable.
Define the variable key (e.g., 'warehouse').
Enter the corresponding value (e.g., 'transform_xl').
To preview the value, click on the eye icon next to the value field.
Click Save

Once saved, Bolt will automatically inject environment variables into your dbt™ project at runtime. This allows you to use these variables in your dbt™ models and configurations without hardcoding sensitive or environment-specific information.

Managing Environment Variables

Edit: Click the 'Edit' button next to the variable you wish to modify.
Delete: Click the 'Delete' button next to the variable you want to remove.

Remember to save your changes after editing or deleting variables.

Important Note: These environment variables are only accessible via Bolt scheduler and are not available in the Code IDE environment.

For users who need to use variables in their Code IDE:

They will need to add these variables separately in their profile settings.
This ensures that sensitive information is kept separate between development and production environments.

3. Managing API Keys

API keys in Paradime provide secure, programmatic access to your workspace resources. They are essential for integrating Paradime with other tools and automating workflows. Each API key is scoped to a specific workspace, ensuring isolation and security of your data and configurations.

Generate a New API Key

Navigate to your account settings.
Select the "Workspace" tab.
Scroll to API key section and click on the + Generate API Key
Provide a name for the key (e.g., 'My New API Key').
Optional: Set a lifetime for the key by specifying the number of days until expiration.
Click Create to save.
After creation, securely store your API key, secret, and endpoint.

Define API Key Capabilities

Choose the capabilities you want to enable for this API key, you can find all the capabilities and access in the API docs. Select the appropriate capabilities based on your intended use of the API key.

Important Note on API Key Scope: API keys in Paradime are scoped to specific workspaces. This means:

Each API key is tied to the workspace in which it was created.
An API key generated in one workspace cannot be used to access or manage resources in another workspace.

Managing API Keys

To manage existing API keys:

View all generated keys in the API key section of your workspace settings.
Delete keys that are no longer needed or may have been compromised.

Best Practice: Regularly review your API keys, rotate them periodically, and ensure each key has only the necessary capabilities for its intended use.

Summary

You've now learned how to manage dbt™ versions, set up environment variables, and handle API keys in your Paradime workspace. These skills will help you maintain a secure and efficient analytics engineering environment.

Next, we'll explore Managing Users in the Workspace to ensure proper access control and collaboration in your Paradime projects.

PreviousSetting Up Data Warehouse Connections NextManaging Users in the Workspace

Last updated 11 days ago