Litmus Edge Manager User UI
...
Application Releases
Add a Draft Application Releas...

Set Up a Litmus Edge API Token for an Application Release

8min

When configuring an application release for deployment to a Litmus Edge instance, you can include an API token for the Docker container of the release. Follow the steps below to create and apply the API token.

Before You Begin

Step 1: Create The EGDE_API_TOKEN Variable

  1. Create a variable named EDGE_API_TOKEN for the application release.
  2. Set the variable value and adjust any other parameters as needed.
EDGE_API_TOKEN
EDGE_API_TOKEN


Step 2: Complete and Submit Application Release

  1. Follow the instructions from Step 3-Step 5 in Add a Draft Application Release to create a draft application release.
  2. Submit the draft release when ready.

Step 3: Launch the Application from Litmus Edge Manager

  1. To ensure the EDGE_API_TOKEN is properly set, launch the application from the Litmus Edge Manager (LEM).
  2. LEM will automatically create an API token named MPC-APP in Litmus Edge during this process if it does not already exist.
  3. The MPC-APP token value will be passed into the EDGE_API_TOKEN environment variable.

Important Notes:

  • If the application is launched directly from Litmus Edge, the environment variable will not include the API token.
  • If the application is not working as expected, use Step 4 & Step 5 to verify that the API token is created and passed correctly.

(Optional) Step 4: Confirm API Token

To confirm an API token with the name MPC-APP exists on your litmus edge:

  1. Log in to Litmus Edge.
  2. From the Navigation panel, navigate to System > Tokens. The NATS Proxy pane appears.
  3. Ensure the MPC-APP token is created and appears in the list.
System > Tokens
System > Tokens


(Optional) Step 5: Verify Passed API Token Assignment to Docker Container

To ensure that the API Token has been passed to the Docker Container from Litmus Edge:

  1. Log in to Litmus Edge.
  2. From the Navigation panel, select Applications. The Dashboard pane appears.
  3. Click Containers. The Containers pane appears.

  4. Click Inspect to view the container details.

    Inspect button location
    Inspect button location
    
  5. Scroll down to the Config section under Env and check that EDGE_API_TOKEN matches the MPC-APP token from Step 3.
Config: Env
Config: Env




Updated 11 Oct 2024
PREVIOUS
Set Up Variables for an Application Release
NEXT
Set Up Docker Container Configurations for an Application Release
Docs powered by Archbee