Skip to content

[doc] Add notes about compatibility and release process - #1631

Merged
barroco merged 1 commit into
interuss:masterfrom
Orbitalize:release_deploy
Aug 20, 2026
Merged

[doc] Add notes about compatibility and release process#1631
barroco merged 1 commit into
interuss:masterfrom
Orbitalize:release_deploy

Conversation

@the-glu

@the-glu the-glu commented Aug 12, 2026

Copy link
Copy Markdown
Member

This PR adds to the documentation a method for performing upgrades, along with a compatibility matrix between recent DSS releases. This contributes to #1598 and is related to #1624 .

We should probably update this page as well as add the matrix to the release. However, we cannot add it to the release documentation, since we need the release itself to run the tests on the official image. Should we try to find a workaround, or assume that master will be up to date rather than the release's documentation?

The release procedure will need to be updated as well, once the previous point is settled.

@the-glu
the-glu force-pushed the release_deploy branch 2 times, most recently from f180cae to 3cf2e55 Compare August 12, 2026 08:37

@barroco barroco left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @the-glu for preparing this. See my comments inline.

Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
@the-glu

the-glu commented Aug 12, 2026

Copy link
Copy Markdown
Member Author

@barroco Thanks for the review, a improved version is ready for a second pass

Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated

@barroco barroco left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@the-glu, many thanks!

@BenjaminPelletier BenjaminPelletier left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a great start and fine to add as-is. I think many of my comments are somewhat important, but they could potentially all be addressed in a followup PR if more convenient.

Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md
Comment thread docs/operations/upgrades.md
Comment thread docs/operations/upgrades.md Outdated
Comment on lines +57 to +68
### Methodology

The matrix is produced by `release/compat/run-compat-matrix.sh`, which runs every pair of the
versions listed above locally with Docker Compose and reports the outcome of the prober and of
the USS qualifier.

Monitoring image used: interuss/monitoring:v0.31.0

Each pair above is tested with two `core-service` instances sharing a single CockroachDB
datastore, with the database migrated by the `db-manager` of version B. All configuration
(flags in particular) is left to default values. The prober and the USS qualifier are then run
against both instances.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like we need instructions to do this and we need to update https://github.com/interuss/dss/tree/master/release to reflect this necessary task when releasing (and, separately, it seems like we need to link to that page from https://github.com/interuss/dss/blob/master/RELEASE.md)

I don't think it will be important to users interested in upgrading how we generated or validated our documentation, just that it is correct. I think this section can be entirely moved to https://github.com/interuss/dss/tree/master/release and tweaked to read as an explanation for what run-compat-matrix.sh does and why.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there is a linked PR #1624 in draft that helped generated part of this document. When it done I will update it to reflect what we want there, and I expect instructions to be part of that PR as well a this point.

I think what is left there is important for the user: the version used, the datastore, the migrations, the flags used and what tests that have been run, do you sill think it should be removed?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user wants to know if two versions are compatible and it seems like that question is already answered in the table above without this information. If the answer above depends on flags used, what tests have been run, etc, then it seems like those caveats should be included in the answer somehow; the user shouldn't be given an answer whose interpretation depends on knowing how that documentation was written. The documentation-generation methodology is relevant to InterUSS contributors/developers, but I don't think it should be relevant to users, and this document is user documentation.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the section, but I still think it was somehow relevant. The documentation cannot validate every scenario with all possible combinations. We present the base, common case; if users deviate from that, they should run their own tests. This section explained how to do so.

Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment on lines +57 to +68
### Methodology

The matrix is produced by `release/compat/run-compat-matrix.sh`, which runs every pair of the
versions listed above locally with Docker Compose and reports the outcome of the prober and of
the USS qualifier.

Monitoring image used: interuss/monitoring:v0.31.0

Each pair above is tested with two `core-service` instances sharing a single CockroachDB
datastore, with the database migrated by the `db-manager` of version B. All configuration
(flags in particular) is left to default values. The prober and the USS qualifier are then run
against both instances.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user wants to know if two versions are compatible and it seems like that question is already answered in the table above without this information. If the answer above depends on flags used, what tests have been run, etc, then it seems like those caveats should be included in the answer somehow; the user shouldn't be given an answer whose interpretation depends on knowing how that documentation was written. The documentation-generation methodology is relevant to InterUSS contributors/developers, but I don't think it should be relevant to users, and this document is user documentation.

Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated
Comment thread docs/operations/upgrades.md Outdated

@barroco barroco left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed offline with @BenjaminPelletier, this PR can be merged and additional/unadressed feedback will be addressed in follow up PRs. @the-glu please capture remaining items in issues if any.

@barroco
barroco merged commit b49724c into interuss:master Aug 20, 2026
12 checks passed
@mickmis
mickmis deleted the release_deploy branch August 20, 2026 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants