Get Started

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

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:

  1. Navigate to your account settings.

  2. Select the Workspace tab.

  3. 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 allow you to securely store and use sensitive information or configuration details in Paradime. These variables can be managed in two different contexts:

  • Bolt Schedule Environment Variables: For production jobs (requires Admin access)

  • Code IDE Environment Variables: For development work

Add a New Environment Variable

  1. From any page in the Paradime application, Click Settings

  2. Navigate to Workspaces > Environment Variables

  3. Choose where to add your variable:

    1. For production jobs: In the Bolt Schedules section, click Add New

    2. For development work: In the Code IDE section, click Add New

  4. Configure your variable:

    1. Enter Key name

    2. Enter Value

    3. Click Save icon (💾)

When Variables Take Effect

  • Bolt Schedules: Variables are automatically injected into your dbt™ project at runtime

  • Code IDE: Variables are immediately available in your development environment

Managing Environment Variables

  • Edit: Click the 'Edit' button (✎) next to the variable

  • Delete: Click the 'Delete' button (🗑️) next to the variable

  • Remember to save your changes

Important notes

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

  1. Navigate to your account settings.

  2. Select the "Workspace" tab.

  3. Scroll to API key section and click on the + Generate API Key

  4. Provide a name for the key (e.g., 'My New API Key').

  5. Optional: Set a lifetime for the key by specifying the number of days until expiration.

  6. Click Create to save.

  7. 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.

Related Documentation

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 ConnectionsNextManaging Users in the Workspace

Last updated

Was this helpful?

OSZAR »