Skip to content

cli.rst: alphabetise devel subcommands and add net-convert to list #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OddBloke merged 3 commits into from
Jun 12, 2020
Merged

cli.rst: alphabetise devel subcommands and add net-convert to list #430

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04ae465
cli.rst: alphabetise devel subcommands
OddBloke Jun 12, 2020
61c54df
cli.rst: add net-convert entry to devel section
OddBloke Jun 12, 2020
f2ccbfc
Merge branch 'master' into doc
OddBloke Jun 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions doc/rtd/topics/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,17 +106,19 @@ Do **NOT** rely on the output of these commands as they can and will change.

Current subcommands:

* ``schema``: a **#cloud-config** format and schema
validator. It accepts a cloud-config yaml file and annotates potential
schema errors locally without the need for deployment. Schema
validation is work in progress and supports a subset of cloud-config
modules.

* ``net-convert``: manually use cloud-init's network format conversion, useful
for testing configuration or testing changes to the network conversion logic
itself.
* ``render``: use cloud-init's jinja template render to
process **#cloud-config** or **custom-scripts**, injecting any variables
from ``/run/cloud-init/instance-data.json``. It accepts a user-data file
containing the jinja template header ``## template: jinja`` and renders
that content with any instance-data.json variables present.
* ``schema``: a **#cloud-config** format and schema
validator. It accepts a cloud-config yaml file and annotates potential
schema errors locally without the need for deployment. Schema
validation is work in progress and supports a subset of cloud-config
modules.


.. _cli_features:
Expand Down