Refine versioning and compatibility documentation #87
Conversation
Updated versioning documentation for clarity and consistency.
|
|
||
| This page describes how versioning and compatibility work across mirrord components. | ||
|
|
||
| ### Component Compatibility |
There was a problem hiding this comment.
This can just be a H3 instead of H2 (same for rest)
| date: 2025-04-07T00:00:00.000Z | ||
| lastmod: 2025-04-07T00:00:00.000Z |
There was a problem hiding this comment.
| date: 2025-04-07T00:00:00.000Z | |
| lastmod: 2025-04-07T00:00:00.000Z | |
| date: 2026-01-14T00:00:00.000Z | |
| lastmod: 2026-01-14T00:00:00.000Z |
| tags: | ||
| - enterprise |
There was a problem hiding this comment.
Not only relevant for enterprise customers, right?
|
|
||
| # Versioning | ||
|
|
||
| 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 in production environments. |
There was a problem hiding this comment.
in production environments
This could be misunderstood. We never recommend using mirrord in production, so I'd use a different phrasing here.
|
|
||
| ### 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. |
There was a problem hiding this comment.
components can be upgraded independently as long as they remain within the same major version.
FYI, we have a different major for the charts. It's not it's own running component though, it's just a way to install the operator. So up to you, whatever you think would help users understand.
| * Upgrade the mirrord Operator | ||
| * Upgrade client tooling (CLI) as needed | ||
|
|
||
| Upgrading the License Server first is safe because Operators are backward compatible with newer License Server versions within the same major version. |
There was a problem hiding this comment.
Operators are backward compatible with newer License Server versions
I'm not sure this part makes sense chronologically
Updated versioning documentation for clarity and consistency.