docs: document availability zones - #5127
Open
joelle-a-dev wants to merge 1 commit into
Open
Conversation
Availability zones (default zone1/zone2/zone3, per-zone subnets, automatic round-robin assignment at launch, and the enable-zones/ disable-zones commands for simulating a cloud outage) were fully implemented but entirely undocumented. - Add reference pages for the zones, enable-zones, and disable-zones commands - Document the --zone option on launch, and fix the sample launch output which was missing "in <zone>" - Add an explanation page describing the concept - Add the Unavailable instance state, which was missing from instance-states.md - Add a how-to guide walking through listing zones, launching into one, and disabling/re-enabling a zone - Cross-link from list.md and info.md, and add the Zone column that list already prints by default but wasn't documented Closes canonical#5118
joelle-a-dev
marked this pull request as ready for review
August 7, 2026 21:11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Availability zones are a fully implemented feature (
zones,enable-zones,disable-zonescommands,launch --zone, theZonefield ininfo/list, and theUnavailableinstance state) but had no documentation at all.zones,enable-zones, anddisable-zones--zoneonlaunch, and fix the sample launch output (was missingin <zone>)Unavailableinstance state, missing frominstance-states.mdlist.md/info.md, and document theZonecolumn thatlistalready prints by defaultCloses #5118
Test plan
pip install -r docs/requirements.txt && sphinx-build -b html docs /tmp/build) — completes with zero warnings or errors (aside from expected "Git clone too shallow" notices from a shallow local clone)src/client/cli/cmd/{zones,enable_zones,disable_zones,launch}.cpp, the formatter implementations, andsrc/daemon/daemon.cpp)multipassd(not built in this environment), would appreciate a maintainer sanity check of the transcribed--helpoutput blocks