Set Up a Litmus Edge API Token for an Application Release
8 min
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
- Ensure you know how to create a draft application release. See Create a Draft Application Release for details.
Step 1: Create The EGDE_API_TOKEN Variable
- Create a variable named EDGE_API_TOKEN for the application release.
- Set the variable value and adjust any other parameters as needed.
EDGE_API_TOKEN
Step 2: Complete and Submit Application Release
- Follow the instructions from Step 3-Step 5 in Add a Draft Application Release to create a draft application release.
- Submit the draft release when ready.
Step 3: Launch the Application from Litmus Edge Manager
- To ensure the EDGE_API_TOKEN is properly set, launch the application from the Litmus Edge Manager (LEM).
- LEM will automatically create an API token named MPC-APP in Litmus Edge during this process if it does not already exist.
- 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:
- Log in to Litmus Edge.
- From the Navigation panel, navigate to System > Tokens. The NATS Proxy pane appears.
- Ensure the MPC-APP token is created and appears in the list.
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:
- Log in to Litmus Edge.
- From the Navigation panel, select Applications. The Dashboard pane appears.
- Click Containers. The Containers pane appears.
Click Inspect to view the container details.
Inspect button location- Scroll down to the Config section under Env and check that EDGE_API_TOKEN matches the MPC-APP token from Step 3.
Config: Env