Red Hat Edge Manager component versioning

Copy link

Compatibility among Red Hat Edge Manager components, including 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.x to 1.1.x): Indicates new, backward-compatible functionality.
• PATCH (for example, 1.1.1 to 1.1.2): Indicates backward-compatible bug fixes.

General compatibility guidelines

Copy link

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.0 server fully supports v1.1.x and v1.0.x agents.
• 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.x CLI with v1.1.x server). Older CLI versions are not supported or tested.

Major version compatibility:

• Components whose MAJOR version numbers differ are not compatible.

Patch version compatibility:

• Patch releases under the same MAJOR.MINOR line 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.MINOR release are fully compatible with each other. For example, a v1.1.1 server and a v1.1.5 agent are fully compatible.
• For the flightctl CLI, use a build from the same MAJOR.MINOR line 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.

API deprecation policy

Copy link

To reduce disruption, API and feature removals follow this pattern:

1. Mark for deprecation: An API endpoint, field, or feature that is scheduled for removal is first marked deprecated in a MINOR release. Agents and the CLI should log warnings when a deprecated feature is used.
2. Removal: The feature can be removed in the next MAJOR release.

Compatibility matrix: server, agent, and CLI

Copy link

Agents follow backward-compatible rules relative to the server; the flightctl CLI must match the server version.

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.

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.

Compatibility matrix: server and Ansible collection

Copy link

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.

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 in the Additional resources section. The flightctl CLI must match the server version; see Compatibility matrix: server and flightctl CLI in the Additional resources section. For the Ansible collection, use the release whose version matches the server.

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.

Lifecycle and update policies

Copy link

Red Hat publishes lifecycle information for Red Hat Edge Manager to help customers and partners plan deployments and support. Released errata remain available to active subscribers for the supported lifecycle of a major version.

Upgrade Red Hat Edge Manager to the most current supported version to maintain uninterrupted service and support. Bug fixes and features target the latest supported versions during the Full Support phase. Critical security items on the prior release receive limited support during the Maintenance Support phase.

Each major or minor version of Red Hat Edge Manager moves through support phases — Full Support and Maintenance Support — that define the level of maintenance available from the initial release date.

Full Support: During Full Support, Critical and Important Red Hat Security Advisories (RHSAs) and Urgent and selected high-priority Red Hat Bug Advisories (RHBAs) ship as they become available. Other fixes and patches can appear in periodic updates. Upgrade to the most current supported minor version. On request, and at Red Hat’s discretion, qualified Critical RHSAs and Critical 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 Red Hat Enhancement Advisories (RHEAs) might ship at Red Hat’s discretion and should not be assumed.

See Red Hat Edge Manager Life Cycle Policy in the Additional resources section for authoritative dates and phase transitions for your subscription.

Deployment platform requirements

Copy link

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.

Edge device operating system compatibility

Copy link

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 Operating system support and compatibility.