Red Hat SummitChapter 2. Version compatibility matrix
To maintain the long-term supportability of the Red Hat Edge Manager ecosystem, it is critical to ensure synchronized versioning across the control plane, edge devices, and automation tooling. Agents must not run at a higher minor version than the Red Hat Edge Manager server; the server supports backward-compatible agents at the same or an earlier minor version. The flightctl CLI must be the same version as the Red Hat Edge Manager server; older CLI versions are not supported or tested. Mismatches between server-side APIs and clients can lead to feature parity gaps and extended MTTR (Mean Time to Recovery) during break-fix cycles.
Adhere to the following standards to ensure a stable and supported operational environment:
-
Semantic Versioning Compliance: Deployments must align with the official Red Hat compatibility matrices for the Red Hat Edge Manager server and agent; see Compatibility matrix: server and agent. The
flightctlCLI and the Ansible collection must be the same version as the Red Hat Edge Manager server; see Compatibility matrix: server andflightctlCLI and Compatibility matrix: server and Ansible collection. - Infrastructure Synergy: Maintain validated pairings between the management layer and the underlying hosting platforms, specifically Red Hat OpenShift Container Platform or Red Hat Enterprise Linux, alongside the designated edge operating system versions.
- Lifecycle Management: Favor current releases to leverage the latest security patches and functional enhancements.
2.1. Red Hat Edge Manager component versioning
Compatibility among Red Hat Edge Manager components—the server (API and control plane), the device agent, and the flightctl CLI—is determined by each component’s version and the API they use. Published versions of those components follow Semantic Versioning (MAJOR.MINOR.PATCH):
-
MAJOR: Indicates incompatible API changes between releases whose major version numbers differ. -
MINOR(for example,1.0.xto1.1.x): Indicates new, backward-compatible functionality. -
PATCH(for example,1.1.1to1.1.2): Indicates backward-compatible bug fixes.
2.2. General compatibility guidelines
Upgrade order: Always upgrade the Red Hat Edge Manager server (backend) first. After the server upgrade, upgrade edge agents so their minor version stays the same as or earlier than the server’s minor version. Upgrade the flightctl CLI to the release that matches the server version.
Minor version compatibility for agents:
-
Within the same major version, a server is compatible with agents at the same minor version or any earlier minor version. For example, a
v1.1.0server fully supportsv1.1.xandv1.0.xagents. - An agent at a higher minor version than the server is not supported. Upgrade the server first, then upgrade agents.
Minor version compatibility for the flightctl CLI:
-
The CLI must be the same version as the Red Hat Edge Manager server (for example,
v1.1.xCLI withv1.1.xserver). Older CLI versions are not supported or tested.
Major version compatibility:
-
Components whose
MAJORversion numbers differ are not compatible.
Patch version compatibility:
-
Patch releases under the same
MAJOR.MINORline deliver backward-compatible corrections, including important bug fixes and security errata. They are not intended to introduce incompatible API changes or to require migration when you move from one patch level to another within that line. -
For agents, all patch versions within the same
MAJOR.MINORrelease are fully compatible with each other. For example, av1.1.1server and av1.1.5agent are fully compatible. -
For the
flightctlCLI, use a build from the sameMAJOR.MINORline as the server. Older CLI minor versions are not supported or tested. - Documentation for a given minor release line applies to every patch release in that line unless release notes document an exception.
2.3. API deprecation policy
To reduce disruption, API and feature removals follow this pattern:
-
Mark for deprecation: An API endpoint, field, or feature that is scheduled for removal is first marked deprecated in a
MINORrelease. Agents and the CLI should log warnings when a deprecated feature is used. -
Removal: The feature can be removed in the next
MAJORrelease.
2.4. Compatibility matrix: server, agent, and CLI
Agents follow backward-compatible rules relative to the server; the flightctl CLI must match the server version. The examples use the supported v1.x release line; Red Hat will document combinations for additional major lines when those versions are available.
Compatibility matrix: server and agent
Status meanings:
- Fully compatible: All features are expected to work.
- Incompatible: The combination is not supported. This includes any agent whose minor version is greater than the server’s minor version (for the same major version), and any pairing where major versions differ.
| Server version | Agent version | Status | Notes |
|---|---|---|---|
|
|
| Fully compatible | Recommended combination. |
|
|
| Fully compatible | Recommended combination. |
|
|
| Fully compatible |
Fully supported. The agent is not aware of |
|
|
| Incompatible | Not supported. The agent minor version must not be greater than the server minor version. Upgrade the server before you run this agent version. |
Compatibility matrix: server and flightctl CLI
The flightctl CLI must be the same version as the Red Hat Edge Manager server; mismatched combinations are not supported or tested.
Status meanings:
- Fully compatible: All features are expected to work.
- Incompatible: The combination is not supported. Install the CLI whose version matches the server version.
| Server version | flightctl CLI version | Status | Notes |
|---|---|---|---|
|
|
| Fully compatible | Required combination. |
|
|
| Fully compatible | Required combination. |
|
|
| Incompatible | Not supported. Use the CLI that matches the server version. |
|
|
| Incompatible | Not supported. Use the CLI that matches the server version. |
2.5. Compatibility matrix: server and Ansible collection
The following matrix lists expected compatibility between the Red Hat Edge Manager server and the Ansible content collection for Red Hat Edge Manager on Red Hat Ansible Automation Platform. The Ansible collection must be the same version as the Red Hat Edge Manager server; mismatched combinations are not supported or tested. The examples use the supported v1.x release line; Red Hat will document combinations for additional major lines when those versions are available.
Status meanings:
- Fully compatible: All features are expected to work.
- Incompatible: The combination is not supported. Install the collection whose version matches the server version.
An agent must not be newer than the server; see Compatibility matrix: server and agent. The flightctl CLI must match the server version; see Compatibility matrix: server and flightctl CLI. For the Ansible collection, use the release whose version matches the server.
| Server version | Collection version | Status | Notes |
|---|---|---|---|
|
|
| Fully compatible | Required combination. |
|
|
| Fully compatible | Required combination. |
|
|
| Incompatible | Not supported. Use the collection that matches the server version. |
|
|
| Incompatible | Not supported. Use the collection that matches the server version. |
Agents must not run at a higher minor version than the server (see Compatibility matrix: server and agent). The flightctl CLI and the Ansible collection are supported only at the same version as the Red Hat Edge Manager server (see Compatibility matrix: server and flightctl CLI and Compatibility matrix: server and Ansible collection). Specific combinations for future minor and major release lines will be documented when those versions are available.
Red Hat currently supports Red Hat Edge Manager integration with Red Hat Ansible Automation Platform 2.5. For configuration and automation workflows, see Integrating Red Hat Edge Manager with Red Hat Ansible Automation Platform in the Additional resources section.
2.6. Lifecycle and update policies
Red Hat publishes lifecycle information for Red Hat Edge Manager so that customers and partners can plan deployments and support. Released errata remain available to active subscribers for the supported lifecycle of a major version.
Product support applies to General Availability releases starting with 1.0. Pre-GA versions are not supported.
Customers are expected to upgrade Red Hat Edge Manager to the most current supported version to ensure uninterrupted service and support. Bug fixes and features target the latest supported versions (Full Support phase), with limited exceptions for critical security items on the prior release (Maintenance Support phase), as described in Red Hat product lifecycle documentation.
Lifecycle is tied to support phases, bounded by minor releases of Red Hat Edge Manager. Each new major or minor version of Red Hat Edge Manager moves through production phases that describe maintenance levels from the initial release date.
Full Support: During Full Support, Critical and Important security errata (RHSAs) and Urgent and selected high-priority bug fix errata (RHBAs) ship as they become available. Other fixes and patches can appear in periodic updates. Customers are expected to upgrade to the most current supported minor version. On request, and at Red Hat’s discretion, qualified Critical security errata (RHSAs) and Critical bug fix errata (RHBAs) might be made available for non-current minor versions.
Maintenance Support: During Maintenance Support, qualified Critical and Important RHSAs ship as they become available. Urgent and selected high-priority RHBAs ship as they become available. Other bug fixes and enhancements (RHEAs) might ship at Red Hat’s discretion and should not be assumed.
See Red Hat Edge Manager Life Cycle Policy for authoritative dates and phase transitions for your subscription.
2.7. Deployment platform requirements
The Red Hat Edge Manager management plane runs on Red Hat OpenShift Container Platform or on Red Hat Enterprise Linux. The following combinations are supported for this documentation release.
| Deployment | Supported versions | More information |
|---|---|---|
| Red Hat OpenShift Container Platform (Software Catalog or Helm chart) | Version 4.19 or later | Installing Red Hat Edge Manager on Red Hat OpenShift Container Platform |
| Red Hat Enterprise Linux (RPM-installed services) | Red Hat Enterprise Linux 9.x or 10.x |
2.8. Edge device operating system compatibility
Edge devices run a Red Hat Enterprise Linux-based image with the Red Hat Edge Manager agent. Supported major versions and mixing rules between agent and management plane are documented in OS support and compatibility.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}