Skip to content

Agents

Visual overview

This video provides a step-by-step tutorial on how to install and configure the MetaKraftwerk Agent.

What is the MKW Agent?

The MetaKraftwerk Agent is a lightweight client application that acts as a bridge between your local machine and the MetaKraftwerk platform. It is required for secure authentication, deployment, and synchronization of your work with the MetaKraftwerk API. The agent ensures that all operations are performed securely and that your credentials are managed safely.

Why do you need the MKW Agent?

  • It enables secure communication between your computer and MetaKraftwerk.
  • It handles authentication with your organization's identity provider (e.g., Azure Active Directory).
  • It manages deployment sessions and caches your login for convenience.

How to Create an Agent ID

Before installing the MKW Agent, you need a personal Agent ID and password. These credentials are provided by your MetaKraftwerk administrator (usually via email).

Steps:

  1. Request your Agent ID: Contact your MetaKraftwerk admin if you have not received your Agent ID and password.
  2. Store your credentials: Keep your Agent ID and password secure, as you will need them during the setup.

Installation and Configuration

1. Set Environment Variables

Before installing the agent, you must set the following environment variables on your Windows system:

VariableValue Description
MKW_AGENT_IDYour personal Agent ID (provided by your admin)
MKW_PASSWORDThe password associated with your Agent ID (provided by your admin)
MKW_SF_USERYour AZR-Snowflake user (e.g., azr_yourname@yourcompany.com)
MKW_SF_AUTH_TYPESet this to EXTERNALBROWSER

How to set environment variables:

  1. Open the Windows Start menu and search for "Environment Variables".
  2. Click on "Edit the system environment variables".
  3. In the System Properties window, click "Environment Variables...".
  4. Under "User variables", click "New..." and add each variable with its corresponding value.
  5. Click OK to save.

2. Download and Install the MKW Agent

  1. Download the installer:
    You can download the MKW Agent Installer using the link below: Download MKW Agent Installer

  2. Run the installer:
    Double-click the setup file to start the installation. The process takes about one minute.

  3. First launch:
    After installation, the agent will start automatically. If the environment variables are set correctly, you will be logged in automatically.

  4. Pin to taskbar (optional):
    For quick access, right-click the agent icon in the taskbar and select "Pin to taskbar".


3. Using the MKW Agent

  • Once the agent is online, select it in the MetaKraftwerk web interface (top right menu).
  • When you start your first deployment, a browser window will open for Azure Active Directory authentication. Log in with your AZR user.
  • After successful login, you can close the browser tab and return to MetaKraftwerk.
  • The session will be cached, so you won’t need to log in again until you restart your computer.