---
title: "Embedded Cluster air-gapped installation guide"
description: "Learn how to install ITRS Analytics with an Embedded Cluster air-gapped deployment. Connect to Geneos for seamless real-time monitoring data ingestion."
url: "https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/install/embedded-cluster-airgap-install/index.html"
---
<!-- Review Algolia Labels before publishing -->

ITRS Analytics is an observability platform that stores, analyzes, and visualizes metrics, logs, and events. One of the ways data can be ingested into ITRS Analytics is through Geneos, which collects real-time monitoring data from servers, databases, networks, and applications. ITRS Analytics processes and transforms your monitoring data into actionable insights through several dedicated apps such as Entity Viewer, Dashboards, and Alerting which are all accessible through a web interface called the [ITRS Analytics Web Console](https://docs.itrsgroup.com/docs/itrs-analytics/app/webconsole/current/user-guide/about/index.html).

This guide covers installing ITRS Analytics using the Embedded Cluster air-gapped deployment option and connecting it to Geneos to ingest data. This option provides a quick way to get started with ITRS Analytics publishing, ideal for smaller deployments, initial testing, or proof-of-concept scenarios. For large-scale production deployments requiring all apps and maximum resiliency, it is recommended to use the [Bring-Your-Own-Cluster (BYOC) deployment option](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/install/install-via-kots-online/index.html).


**Note**

 This guide assumes you already have Geneos installed. If not, see the [Geneos Quickstart Guide](https://docs.itrsgroup.com/docs/geneos/current/getting-started/quickstart/index.html) for installation instructions. 


## Plan your ITRS Analytics installation

Before installing ITRS Analytics and connecting it to Geneos, it is important to plan your deployment carefully. This includes preparing your license and installation package, and determining the server sizing and requirements for your setup.

### Get your ITRS Analytics license and installation package<!-- For elaboration. Recommend to have a how-to guide. -->

You can request an ITRS Analytics license and the installation package download link from your ITRS Account Manager.


**Note**

  The download link will vary depending on the [deployment option](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/install/deployment-options/index.html). Make sure to inform your Account Manager if you opt for a different deployment option.

You can also download the installation package from the Customer’s Download Portal. If you do not have the URL or password, please contact your ITRS Account Manager or submit a support request.


<!-- Nice to have: create a new section describing the manual way of how to download IAX in the get.itrsgroup.com (instead of requesting the download links from Support or AM). -->

### Determine your server size and requirements

Proper sizing is essential for ITRS Analytics to run efficiently and handle your monitoring data at scale. To determine your environment's requirements, first obtain the message rate from your Geneos setup, then use the ITRS Analytics Sizer to calculate the recommended hardware and resource allocation.

#### Get the message rate  

The required size by ITRS Analytics depends mainly on the message rate it needs to handle.

| T-shirt sizing    | Message rate | ITRS Analytics entities    |  Indicative server range | 
|-------------------|--------------|--------------------|---------------|
| Large             | 100,000      | 250,000            | 3,000-9,000   | 
| Medium            | 50,000       | 125,000            | 900-3,000     |
| Small             | 10,000       | 25,000             | 300-900       |

For existing Geneos customers, the message rate generated by any Gateway (version 5.14.0 or later) can be obtained by configuring ITRS Analytics publishing in statistics-only mode. To configure this in the Gateway Setup Editor:<!-- Can be linked to https://docs.itrsgroup.com/docs/geneos/current/processing/data-access-and-publishing/connect-geneos-to-itrs-analytics/index.html#statistics-only-mode -->

1. Navigate to **ITRS Analytics Connection**.
2. Click **Enable** to enable  publishing to ITRS Analytics.
3. Set the **Mode** to `statisticsOnly` to enable ITRS Analytics statistics.

    ![ITRS Analytics connection statistics only mode](https://docscdn.itrsgroup.com/geneos/images/gateway/gateway-mode-statistics-only.gif)

Statistics are then recorded to the [self-monitoring dataviews](https://docs.itrsgroup.com/docs/geneos/current/processing/data-access-and-publishing/connect-geneos-to-itrs-analytics/index.html#self-monitoring) and to the `gateway.log` file.

To calculate the overall required message rate, check the `gateway.log` file or sum the message rates from all Gateways connected to the same ITRS Analytics instance. For example:

![Gateway log messageRate](https://docscdn.itrsgroup.com/itrs-analytics-platform/images/iax-install-gateway-logs.png)


**Note**

 The `messageRate` shown in the Summary dataview does not indicate the total message rate of your Gateway. It only reflects the number of messages that were successfully sent during the last sampling interval. 


If these statistics are not available, you can initially refer to the sizing guidelines. The recommended number of servers for ITRS Analytics is based on specific assumptions (outlined in the table below) and an analysis of message rates from existing Gateways. You may use these estimates as a starting point, but validate them with actual statistics from your Gateways as soon as possible, since message rates can vary significantly between different plugins.

| Indicative server range                     | Computation                 |
|----------------------------------|-----------------------------|
| Lower estimate                   | The following conservative assumptions were used: - 20-second sampling
- 2 managed entities per server
- 7 dataviews per managed entity
- 10 columns and 10 rows per dataview
- 50% of values changing every sample period |
| Upper estimate                   | Actual message rates from various Gateways were used. Most of these Gateways use 20-second sampling and a wide range of plugins. |

#### Estimate cluster requirements with ITRS Analytics Sizer <!-- Copied from ITRS Analytics Sizer -->
  
Once you have the message rate, use the interactive [ITRS Analytics Sizer](https://iaxsizer.itrslab.com/?utm_source=docs&utm_medium=web&utm_campaign=sizer) tool to calculate additional infrastructure requirements, including cluster size, if you plan to enable Linkerd, Trust Manager, or install apps. The results will display an overview of the expected resource usage, drawing data from the latest available version of ITRS Analytics.

<!-- PLACEHOLDER. Optional topic and to decide the correct section to place. 

#### Adding optional apps 

  - Recalculate the resources (link back to Using the IAX Sizer)
  - Upgrading the resources (if applicable)
  - Reconfiguring IAX

-->

<!-- PLACEHOLDER. This section is only needed for BYOC deployment.

### Determine and setup RBAC requirements

-->

## Install ITRS Analytics <!-- Specifically: #Embedded cluster air-gapped installation -->

With your license and installation package ready and server requirements determined, you are now ready to install ITRS Analytics.

### Set up your system for Embedded Cluster installation

Review the requirements below to ensure that your system is properly configured and fully ready for the installation process.

#### System requirements summary

| Requirement            | Details                                                                                          |
|-------------------------|-------------------------------------------------------------------------------------------------|
| Operating system        |  Linux                                                                                           |
| Architecture            |  x86-64                                                                                          |
| Init system             |  `systemd`                                                            |
| Memory                  |  Refer to the [Resources and hardware requirements](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/prerequisites/resource-hw-requirements/index.html)                      |
| CPU cores               |  Refer to the [Resources and hardware requirements](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/prerequisites/resource-hw-requirements/index.html)       |
| Disk write latency      | Ensure the disk's P99 write latency does not exceed 10 ms to support `etcd` stability
For detailed information on disk write latency requirements for `etcd`, see the [Disks](https://etcd.io/docs/v3.6/op-guide/hardware/#disks) section                   |
| Data directory space    | At least 85Gi of total space and should not exceed 80% usage
For air-gapped, data storage should have at least three times the size of the airgap bundle and should not exceed 80% usage |
| [Default data directory](#default-data-directory)  |  By default, the data directory is set to `/var/lib/embedded-cluster`                                                                     |
| [Custom data directory](#custom-data-directory)   |  Use the `--data-dir` flag with the Embedded Cluster install command to change the default directory                             |

##### Directories created by Embedded Cluster

The cluster and its components will automatically create files and directories in the following paths:

- /etc/cni
- /etc/k0s
- /opt/cni
- /opt/containerd
- /run/calico
- /run/containerd
- /run/k0s
- /sys/fs/cgroup/kubepods
- /sys/fs/cgroup/system.slice/containerd.service
- /sys/fs/cgroup/system.slice/k0scontroller.service
- /usr/libexec/k0s
- /var/lib/calico
- /var/lib/cni
- /var/lib/containers
- /var/lib/kubelet
- /var/log/calico
- /var/log/containers
- /var/log/embedded-cluster
- /var/log/pods
- /usr/local/bin/k0s

##### k0s compatibility

Embedded Cluster is built on k0s, so it inherits all [k0s system requirements](https://docs.k0sproject.io/) and external runtime dependencies.

#### Data directory

The data directory is a necessary component of the ITRS Analytics application, containing both application data and logs. The allocated disk space for this directory must correspond to the t-shirt size chosen during deployment (for example, small, medium, large).

##### Default data directory

By default, the data directory is set to `/var/lib/embedded-cluster`. If the default is used, ITRS Analytics will share disk space to other non-ITRS applications using the `/var/lib/` or `/var` partition.

##### Custom data directory

To configure a custom data directory path during installation, use the `--data-dir` flag with the Embedded Cluster installation command.

##### Notes and limitations

The following constraints apply when using or configuring the data directory:

- You cannot change the data directory of the Embedded Cluster after installation.
- In multi-node setups, all nodes must use the same data directory specified during the initial installation. A different data directory cannot be selected when joining additional nodes to the cluster using the Embedded Cluster `join` command.
- If you specify a different data directory during installation using the `--data-dir` flag, you must use the same directory path when performing a disaster recovery restore.
- Symlinks are not supported for the Embedded Cluster data directory.

#### Port requirements

Correct port configuration is important for the operation of Embedded Cluster. These ports need to be accessible for both single-node and multi-node installations.

##### Ports for local processes

These ports must be accessible to local processes on the same node. No firewall rules are required.

| Port   | Protocol | Service  |
|--------|----------|----------|
| 2379   | TCP      | etcd     |
| 7443   | TCP      | Kubernetes Metrics Server |
| 9099   | TCP      | 
| 10248  | TCP      | 
| 10257  | TCP      | Kubernetes controller manager |
| 10259  | TCP      | Kubernetes scheduler |

##### Ports for inter-node communication

The ports listed below are used for two-way communication between nodes.

- In multi-node setups, you must open these ports in the firewall to allow traffic between nodes.
- In single-node setups, these ports must still be available, even though no inter-node communication occurs.

| Port   | Protocol | Service  |
|--------|----------|----------|
| 2380   | TCP      | etcd peer |
| 4789   | UDP      | VXLAN |
| 6443   | TCP      | Kubernetes API Server |
| 9091   | TCP      | 
| 9443   | TCP      | 
| 10249  | TCP      | kube-proxy metrics |
| 10250  | TCP      | 
| 10256  | TCP      | kube-proxy health check |

##### Additional services

| Port   | Protocol | Service                          |
|--------|----------|----------------------------------|
| 53     | UDP/TCP  | DNS resolution                   |
| 9333   | TCP      | SeaweedFS (HA mode)              |

##### Port for Admin Console

| Port   | Protocol | 
|--------|----------|
| 30000  | TCP      | 

Open port 30000/TCP in the firewall to allow end users to access the Admin Console. This port must also be reachable by any nodes joining the cluster. 

If port **30000** is already in use, you can specify a different port during installation by running the `--admin-console-port` flag with the Embedded Cluster install command. For example:

```
sudo ./itrs-analytics install --license license.yaml --admin-console-port=20000
```

##### Port for Local Artifact Mirror (LAM)

| Port   | Protocol | 
|--------|----------|
| 50000  | TCP      |

If port **50000** is already in use, you can choose a different port for the LAM during installation by running the `--local-artifact-mirror-port` flag with the Embedded Cluster install command. For example:

```
sudo ./itrs-analytics install --license license.yaml --local-artifact-mirror-port=40000
```

### Perform the preflight checks

This step helps verify that your system and cluster meet the necessary requirements before proceeding with the installation.

Run this command to perform preflight checks:

  ```
  sudo ./itrs-analytics install run-preflights --license license.yaml --airgap-bundle itrs-analytics.airgap
  ```


**Success**


A successful preflight check will show **Host preflight passed** in the console.



### Run the installer

Install ITRS Analytics with the `--airgap-bundle` flag. Run the command:

  ```
  sudo ./itrs-analytics install --license license.yaml --airgap-bundle ./itrs-analytics.airgap
  ```

### Verify successful installation

Once the installation is complete, the URL to the Admin Console will be displayed.

![Successful ITRS Analytics installation](https://docscdn.itrsgroup.com/itrs-analytics-platform/images/iax-install-successful-install.png)

## Configure ITRS Analytics in Admin Console

The Admin Console is a web-based interface where you will configure ITRS Analytics after its successful installation. This process involves securing the Admin Console with certificates, optionally configuring cluster nodes, setting up ITRS Analytics with your preferred apps and settings, and then deploying the platform.

### Secure the Admin Console <!-- This is a new header. Previously, these checkboxes were under Start installation. -->

1. Go to the URL from the installation output to open the Admin Console. Click **Start**.

2. If you see a security warning in the browser, click **Advanced** and proceed to the URL.

3. When prompted, choose whether to use a self-signed certificate or your own custom certificate. If you choose to upload your own, you will need to provide a PEM file and a corresponding private TLS key.

4. Optionally, supply a hostname for accessing the ITRS Analytics UI. Click **Continue**.

5. Log in to the Admin Console using the password you set in the command output during installation. <!-- Previously, the login to AC checkbox was under the the #Log in to the Admin Console header. The header is now consolidated here to follow the UI flow from the walkthrough. -->

### Configure the cluster (optional)

On the **Nodes** screen, you can add nodes before deploying ITRS Anaytics. Click **Continue**.

To create a multi-node cluster with Embedded Cluster, see [Multi-node clusters with Embedded Cluster air-gapped](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/install/configure-multi-node-clusters-embedded-airgap/index.html).

### Configure ITRS Analytics

1. On the **Configure ITRS Analytics** screen, configure the following sections:

    | Section | What you need to do |
    |---------|---------------------|
    | **Cluster Settings** | Select the appropriate cluster size based on your needs. For more information, see [Sizing guidelines](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/prerequisites/resource-hw-requirements/index.html). |
    | **Host names** | Specify the paths to the apps and ingestion host names you will use. A fully qualified domain name (FQDN) is required for both the **Apps external host name** and **Ingestion external host name** where the application will be accessible. |
    | **ITRS Analytics Apps** | This is the list of all required apps which will be installed by default. Beginning with installation package 2.18.13+p2.18.10, the IAM app is a required app and is selected by default. For more information, see [IAM app is required](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/upgrade/itrs-analytics-upgrade-notes/index.html#iam-app-is-required). |
    | **Optional Apps** | Review the recommended optional apps, as well as other apps you can install depending on your business requirements. |
    | **Beta apps** | This section is only available if there are any beta apps. These are pre-release versions that are still in development and testing. They may offer new features that are not yet fully validated, which can introduce operational risks. Use beta apps only in non-production environments to avoid impacting business operations. |
    | **Credentials** | Review default login information for different user and admin levels, intended for informational purposes. |
    | **Storage Settings** | Click a checkbox to display configuration options. Note that modifying these settings may require advanced configuration to adjust correctly. When configuring storage classes, make sure that upgrades are supported, since these are performed independently from ITRS Analytics installation. |
    | **Advanced Settings** | Select **Show Advanced Configuration** to view advanced configuration options. |
    | **Service Mesh** | Enables service mesh and mutual TLS (mTLS). This will install `trust-manager`, `linkerd-cni`, and `linkerd` if these are not in your cluster. |
    | **TLS Certificates** | Choose between using self-signed certificates or [deploying your own custom, non-self-signed certificates](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/install/tls/index.html). If linkerd is enabled, select **Linkerd: custom linkerd certificates** to use custom Linkerd certificates. You will need to provide a PEM file and a corresponding private TLS key. |
    | **ITRS Analytics: custom certificates** | Select **ITRS Analytics: custom certificates** to use custom ITRS Analytics certificates. You will need to provide a PEM file and a corresponding private TLS key. |
    | **Ingress Annotations** | Specify the `ingress-nginx` annotations for ingress resources. Refer to this [NGINX configuration document](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/) for more information.|
    | **Preflight and Support Bundle Settings** | Select to enable **Run Disk I/O Performance Test** or **Include Disk I/O Test for Support Bundle**. If you disable either option, preflight checks and gathering of support bundles will be faster at the expense of poorer quality.  |
    | **Backup and Restore** | 
**Note**

 This setting is not yet supported in Embedded Cluster. 
 Selecting **Enable IAX backup and restore** activates backup and restore support for ITRS Analytics using Velero. |
    | **ClickHouse Workload Scheduling** | Enable the **Enforce ClickHouse Node Selector** to ensure ClickHouse workloads run only on nodes matching the defined selector (enabled by default for the larger cluster sizes). Disabling this will allow you to use fewer dedicated nodes, but it may result in performance or stability issues. Beginning with ITRS Analytics 2.18.1 on Embedded Cluster, this option is permanently disabled and is no longer available for selection. |
    | **Helm Install/Upgrade Options** | Configure the **ITRS Analytics Helm Chart Timeout** setting to be used during installation or [upgrade operations](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/upgrade/itrs-analytics-upgrade-notes/index.html#helm-chart-timeout-adjustment-required). |
    | **Status Informer Overrides** | Leave **Audit ingestion**, **Logs ingestion**, and **Traces ingestion** selected unless that ingestion is intentionally disabled. These options are available starting with ITRS Analytics 2.18.13. Clearing a toggle removes those workloads from application status, so a disabled ingestion pipeline does not cause the KOTS Admin Console to show the application as unavailable. The ingestion pipeline stays in its current state. For more information, see [Status informer overrides](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/upgrade/itrs-analytics-upgrade-notes/index.html#status-informer-overrides). |
    | **Helm Chart Values Override** | Input your desired configuration values to override the default Helm chart settings and then save your configuration. Starting with ITRS Analytics version 2.18.4, use the chart name as the top-level key and nest values exactly as they appear in the chart's default values. |

    
**Warning**


The previous **Helm Chart Values Override** format is no longer supported. Existing overrides that use the old structure can be silently ignored after installation or upgrade. For migration guidance and examples, see [Helm Chart Values Override format changed](https://docs.itrsgroup.com/docs/itrs-analytics/platform/2.18.0/upgrade/itrs-analytics-upgrade-notes/index.html#helm-chart-values-override-format-changed).



2. Click **Continue** to proceed to **Validate the environment and deploy ITRS Analytics** section. <!-- New step -->

### Validate the environment and deploy ITRS Analytics <!-- In current docs, this is #Preflight checks and deploy -->

After completing all configurations, wait for the version to finish deploying, then access the ITRS Analytics Web Console.

![Accessing ITRS Analytics Web Console](https://docscdn.itrsgroup.com/itrs-analytics-platform/images/iax-install-version-deployed.png)

Enter your credentials to access the Web Console. When you first open the Web Console, change your password to activate your account.

## Post installation

### Upload the ITRS Analytics user license

After installation, you must upload your ITRS Analytics user license to activate the platform. While ITRS Analytics comes with a bootstrap license that allows you to use the platform for five days, you need to upload the [requested ITRS Analytics license file](#get-your-itrs-analytics-license) to continue using the platform beyond this period. Save the file on your local folder so you can upload it to the Web Console. To upload:

1. On the Web Console side panel, click **Admin**.
2. Click the **License Management** tab.  
3. Click **Upload License**, and then browse to the location where the `.json` file is saved.
4. Select the `.json` file.

You will see a confirmation when the file has been successfully uploaded.


**Note**


When the license expires, data ingestion will continue but ITRS Analytics will stop serving data.



This is an example of the Web Console view showing that the licenses have been uploaded correctly:

![Uploaded license shown in the Web Console](https://docscdn.itrsgroup.com/itrs-analytics-platform/images/iax-install-license-upload.png)

### Check the roles in IAM app

After uploading the license file to the Web Console, verify the roles configured in the IAM app, particularly the `user` role and its associated permissions. By default, the `user` role is granted full read access to all entities, which may need to be restricted in production environments.

![User role in IAM app](https://docscdn.itrsgroup.com/itrs-analytics-platform/images/iax-install-iam-roles-user.png)

## Connect to a Geneos Gateway

After installing and configuring ITRS Analytics, you need to connect your Geneos Gateway to the platform so you can begin ingesting monitoring data to ITRS Analytics. This also enables you to:

- Store and analyze historical monitoring data at scale, correlating real-time and historical data for better troubleshooting and insights.
- Access advanced analytics and visualization capabilities through web-based interfaces for comprehensive monitoring and analysis.
- Centralize monitoring data from multiple Gateways and Netprobes in a single platform for unified visibility across your infrastructure.
- Enhance alerting capabilities with historical context and trend analysis to identify patterns and prevent issues before they impact 
operations.
- Scale your monitoring infrastructure to handle large volumes of metrics, logs, and events as your environment grows.

### Configure ITRS Analytics Connection in the Gateway Setup Editor

To start publishing data from Gateway to ITRS Analytics, you must configure the **ITRS Analytics Connection** in the Gateway Setup Editor (GSE).

![ITRS Analytics connection configuration](https://docscdn.itrsgroup.com/geneos/images/gateway/gw-itrs-analytics-connect-7-8-0.png)

To configure ITRS Analytics Connection:

1. Tick the **Enable** checkbox.
2. Set **Mode** to **connection**.
3. Tick the **Verify server certificate** checkbox to enable the server certificate verification. This setting is applied in both the connection for publishing data to ITRS Analytics and for accessing data from ITRS Analytics.
4. Configure the following settings under **Publishing** and **Data access** sections:

| Section | Setting | Description |
|-------|-------|-------|
| Connection > Publishing | Service address | Specify the ITRS Analytics ingestion service hostname with the `http://` prefix. For example: `https://ingestion.my-iax.com`. 
**Note**

 The service address field defaults to `https` and port `443`, so that `https://ingest.hub.local:443` can be entered as `ingest.hub.local`. 
 |
| Connection > Publishing | Credentials | Specify the ITRS Analytics user credentials to access the ITRS Analytics ingestion service. An ingestion user must be created via [Keycloak](https://docs.itrsgroup.com/docs/itrs-analytics/platform/current/install/advanced-keycloak/advanced-keycloak-overview/index.html). |
| Connection > Data access | Service address | Specify the ITRS Analytics Web Console hostname. For example: `https://my-iax.com`.|
| Connection > Data access | Credentials | Specify the ITRS Analytics user credentials to access data from ITRS Analytics. A data access user must be created via [Keycloak](https://docs.itrsgroup.com/docs/itrs-analytics/platform/current/install/advanced-keycloak/advanced-keycloak-overview/index.html). This user must be mapped to a **user** role and added to a **user** group. |

### Configure Geneos commands

To enable Gateway commands to work with ITRS Analytics, you must configure the **Authentication** section in the GSE. This allows users in ITRS Analytics to execute commands through the Entity Viewer app.

To configure the Geneos commands:

1. Navigate to the **Authentication section** of the GSE.

2. Create a **Role** that has permissions to execute all available commands.
  https://app.storylane.io/demo/erfuaoxp4gtd

3. Add the **user role** created in ITRS Analytics in the **Role properties** setting.
  ![Adding a user role](https://docscdn.itrsgroup.com/geneos/images/connect-geneos-to-obcerv-add-role.png)


**Note**



- The **user role** created in ITRS Analytics can be added to an existing Gateway role that has permissions to execute commands.
- The example above gives ITRS Analytics access to all available Gateway commands. You can limit this access to specific Gateway commands by configuring **Role** > **Permissions** > **Options** > **Command**. See [Command permissions - Gateway Authentication Technical Reference](https://docs.itrsgroup.com/docs/geneos/current/security/access-controls/geneos_authentication_tr/index.html#command-permissions). 


### Verify successful Gateway connection

After completing the configuration steps, confirm that the Gateway is successfully connected to ITRS Analytics.

You can do this in the Web Console by:

- Verifying that the Entity Viewer displays the same data visible in the Active Console.
- [Running commands](https://docs.itrsgroup.com/docs/itrs-analytics/app/entities/current/user-guide/commands/index.html#trigger-commands-from-an-entity) and ensuring they return a completed status.

![Commands access](https://docscdn.itrsgroup.com/itrs-analytics-app-entities/images/execute-commands-1-17-0.gif)

