fix: Catch up docs with the CLI flag renames - #261
Open
jedevc wants to merge 3 commits into
Open
Conversation
nurof3n
requested changes
Aug 21, 2026
The CLI renamed --tags to --tag and no longer splits a flag value on commas, so every example here set a single tag literally named "production,customer_A". Repeat the flag instead. The two template examples were wrong in a second way: neither /instances/templates nor /volumes/templates accepts tags, and both reject unknown members, so the CLI has no field to expose and the API calls as written would fail outright. Templating relabels the source record in place rather than building a new one, so the template already carries the instance's or volume's tags — tag the resource first, then convert it. Left the CLI alone rather than adding a --tag flag the platform has nothing to do with. The trailing note about comma separation still holds for --filter and the API query parameter, so it's scoped to filtering rather than dropped. Signed-off-by: Justin Chadwell <justin@unikraft.com>
Renamed in the CLI alongside --tags. Both already appeared as repeated flags in these examples, so this is only the rename. Signed-off-by: Justin Chadwell <justin@unikraft.com>
Nothing said how to express more than one element. Now that the CLI no longer splits a flag value on commas, repeating the flag or writing JSON are the only two ways, and neither was written down anywhere. Signed-off-by: Justin Chadwell <justin@unikraft.com>
jedevc
force-pushed
the
docs/parse-flag-renames
branch
from
August 24, 2026 13:00
9148bba to
d95edd3
Compare
jedevc
marked this pull request as ready for review
August 24, 2026 13:21
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
2 participants
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.
The CLI dropped csv-style parsing for lists and maps and renamed the plural flags, so
--tags production,customer_A,--services, and--domainsare all broken in the docs as they stand.Breaking change: unikraft-cloud/cli#395
Also documents how to express a list or map field now that commas are gone—repeat the flag, or write JSON—which
pages/cli/fields.mdxnever covered at all.The two template-creation examples on the tagging page turned out to be broken in a way the flag rename doesn't explain: neither
POST /instances/templatesnorPOST /volumes/templatesaccepts tags at all, and both reject unknown members, so those API tabs would 400 as written. Templating relabels the source record in place, so the template already inherits the instance's or volume's tags — both blocks now tag the resource and then convert it.