Skip to content

[doc] Add a deployment checklist#1491

Open
the-glu wants to merge 11 commits into
interuss:masterfrom
Orbitalize:prod_checklist
Open

[doc] Add a deployment checklist#1491
the-glu wants to merge 11 commits into
interuss:masterfrom
Orbitalize:prod_checklist

Conversation

@the-glu
Copy link
Copy Markdown
Contributor

@the-glu the-glu commented May 27, 2026

This PR follows #1469

It does add a deployment checklist, with the idea of listing each important steps for a production (or anything related, like a qualification, etc..) setup.

Checkbox are checkable and stored in the brower's stroage, providing (light) support of a real to-do list if needed.

It's partially redundant with some page (e.g. home, operations), but the idea is to centralize everything with pointers for non-local deployments.

the-glu and others added 10 commits May 19, 2026 16:58
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
Copy link
Copy Markdown
Member

@BenjaminPelletier BenjaminPelletier left a comment

Choose a reason for hiding this comment

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

Thanks, this looks good and I think is another valuable piece of documentation that will see a lot of interest in the very near future. In addition to a few comments below, I think we should change the term "Production". Multiple groups have the practice of deploying software to multiple environments, at a minimum including actual production serving end users and a shared qualification environment where software prereleases are qualified. The deployment into the qualification environment is fully relevant to all of this documentation, yet it is not production. Perhaps "Deployment checklist"? I know that isn't perfect because we also call running containers on a local machine a "local deployment". Nonetheless, I think I still lean toward "Deployment checklist" as accurate enough while being maximally obvious when it correctly applies. If there are concerns, possibly "Cloud deployment checklist" is more accurate as long as the USS isn't deploying on premises.

Comment thread docs/production_checklist.md Outdated
Comment thread docs/production_checklist.md Outdated
Comment thread docs/production_checklist.md Outdated
Comment thread docs/production_checklist.md Outdated
## Deployment

* [ ] Deploy the DSS instance by following the guides based on your previous infrastructure choices.
* [ ] If needed, pool your DSS instance. Guides are available for [CockroachDB](operations/pooling-crdb.md) and [YugabyteDB](operations/pooling.md).
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.

Pooling happens as part of following the per-infrastructure-choice deployment guide according to the "operations" pooling documentation -- for instance, steps 6 and 8 in the manual deployment documentation. It looks like the GCP and AWS deployment documentation are probably weak on making this point clear; I would expect them to say something like steps 6 and 8 in the manual documentation. The important thing for this PR though is that I don't think "pool your DSS instance" is a separate step from "Deploy the DSS instance".

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes the documentation is not clear on that.

For me there are two points (or subpoints): you deploy it, by spawning services and, optionally, you configure it correctly in a pool. First step you can probably do it alone and it may work directly in the non-pooled case, second step involve "special work" that need other DSS participants.

I also think that pointing to the pooling part is important, as it's a 'core' operation (plus others part are not clear (yet)).

I moved it to a sub-step in this document + tweaked wording, would that work?

@the-glu the-glu changed the title [doc] Add a production checklist [doc] Add a deployment checklist May 28, 2026
Co-authored-by: Benjamin Pelletier <BenjaminPelletier@users.noreply.github.com>
@the-glu
Copy link
Copy Markdown
Contributor Author

the-glu commented May 28, 2026

@BenjaminPelletier Ready for a second pass of review, I reworded "Production" to "Deployment checklist" in general + added a menu entry as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants