Overview
Containerized deployments of Decisions require proper licensing to function. Licensing ensures that each container instance is authorized and can communicate with the Decisions licensing system.
There are two supported approaches for licensing a container:
- Option A: Self-Licensing using Environment Variables (Recommended)
- Option B: Applying an XML License Key via Environment Variables (For restricted or offline environments)
This document outlines both approaches, including configuration steps, prerequisites, and usage considerations.
Option A: Self-Licensing using Environment Variables
Self-licensing is the recommended approach for container environments. When configured, the container automatically sends a license request to the Decisions licensing server during startup. This method relies on environment variables to provide licensing details.
Prerequisites
- The container must have outbound network access to the Decisions licensing server.
- Valid licensing details must be available. Decisions Support provides the Company ID and Company Name. The Contact Email and License Type should be defined based on the environment.
Configuration
Define the following environment variables in the container configuration. For more details, refer to Environment Variables for Licensing.
| Environment Variable | Description | Example |
|---|---|---|
| DECISIONS_LICENSECOMPANYID | Unique license identifier assigned to the organization. | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| DECISIONS_LICENSECOMPANYNAME | Name of the licensed organization. | Decisions |
| DECISIONS_LICENSECONTACTEMAIL | Contact email associated with the license. | example@email.com |
| DECISIONS_ENVIRONMENTNAME | Name of the container environment. | TestingEnvironment |
| DECISIONS_LICENSETYPE | Type of license being used. | EnterpriseProduction |
Steps
- Add the required environment variables to the container configuration (e.g., Docker, Kubernetes, or hosting platform).
- Start or restart the container.
- On startup, the container automatically sends a license request to the Decisions licensing server.
- Once approved, the license is applied automatically.
- Verify licensing status within the Decisions portal if needed.
Behavior
- The container initiates licensing during startup.
- No manual handling of license files is required.
- Licensing updates are handled automatically when the container restarts.
Option B: Offline Licensing (Restricted Environments)
This approach is applicable only when the container cannot connect to the Decisions licensing server (for example, restricted environments).
Prerequisites
- No outbound network access from the container.
Configuration
If the container cannot reach the Decisions licensing server, an offline license must be applied.
Offline licenses are provided by Decisions Support and must be configured using environment variables within the container.
To obtain and apply an offline license, contact Decisions Support.
Choosing the Right Approach
| Scenario | Recommended Approach |
|---|---|
| Standard container deployment with internet access | Self-Licensing using Environment Variables |
| Restricted environment | Contact Decisions Support for offline licensing |
Troubleshooting
- If licensing does not apply after startup, verify that all environment variables are correctly defined.
- Ensure there are no typos or missing values in the configuration.
- For self-licensing, confirm that outbound network access is available.