> For the complete documentation index, see [llms.txt](https://metalbear.com/mirrord/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://metalbear.com/mirrord/docs/managing-mirrord/versioning.md). # Versioning Which versions of the mirrord components work together, and how to upgrade them safely. mirrord is composed of multiple components, including the CLI, Operator, Agent, and License Server. These components may be deployed and upgraded independently, and mirrord is designed to support safe, incremental upgrades. This page describes how versioning and compatibility work across mirrord components. ## Component Compatibility mirrord components communicate over well-defined APIs and do not require lockstep upgrades. In most cases, components can be upgraded independently as long as they remain within the same major version. Note: The only caveat here is that the mirrord Operator helm chart runs its own major versions, but the helm chart just delivers the Operator. The Operator version is what should be considered for compatibility. ## License Server and Operator Compatibility The mirrord License Server and mirrord Operator are backward compatible with each other within the same major version. This means that a newer License Server can serve older Operators, and a newer Operator can communicate with older License Servers. Minor and patch upgrades do not require coordinated rollouts between these components. Breaking changes between the License Server and Operator only occur on major version upgrades. ## Operator and Agent Compatibility Agents are deployed and managed by the mirrord Operator. The Operator selects and manages the Agent version automatically. Users should not manually manage Agent image versions when using the Operator. Operator and Agent compatibility is guaranteed within the same Operator release. ## Upgrade Order When upgrading mirrord components, the following order is recommended: * Upgrade the License Server * Verify that the License Server is healthy and reachable * Upgrade the mirrord Operator * Upgrade client tooling (CLI) as needed ## Semantic Versioning mirrord follows semantic versioning for all components. Patch releases include bug fixes only. Minor releases are backward compatible across components. Major releases may introduce breaking changes. Cross-component compatibility is guaranteed within the same major version. Any breaking changes will be documented in release notes and upgrade documentation. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://metalbear.com/mirrord/docs/managing-mirrord/versioning.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.