summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/faq.rst
diff options
context:
space:
mode:
authorChad Smith <chad.smith@canonical.com>2020-11-18 07:23:44 -0700
committerGitHub <noreply@github.com>2020-11-18 09:23:44 -0500
commitf680114446a5a20ce88f3d10d966811a774c8e8f (patch)
tree936dfbe130d693abc0a9c87ba0367bfc276674bc /doc/rtd/topics/faq.rst
parente1bde919923ff1f9d1d197f64ea43b976f034062 (diff)
downloadvyos-cloud-init-f680114446a5a20ce88f3d10d966811a774c8e8f.tar.gz
vyos-cloud-init-f680114446a5a20ce88f3d10d966811a774c8e8f.zip
cli: add --system param to allow validating system user-data on a machine (#575)
Allow root user to validate the userdata provided to the launched machine using `cloud-init devel schema --system`
Diffstat (limited to 'doc/rtd/topics/faq.rst')
-rw-r--r--doc/rtd/topics/faq.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/rtd/topics/faq.rst b/doc/rtd/topics/faq.rst
index d08914b5..27fabf15 100644
--- a/doc/rtd/topics/faq.rst
+++ b/doc/rtd/topics/faq.rst
@@ -141,12 +141,12 @@ that can validate your user data offline.
.. _validate-yaml.py: https://github.com/canonical/cloud-init/blob/master/tools/validate-yaml.py
-Another option is to run the following on an instance when debugging:
+Another option is to run the following on an instance to debug userdata
+provided to the system:
.. code-block:: shell-session
- $ sudo cloud-init query userdata > user-data.yaml
- $ cloud-init devel schema -c user-data.yaml --annotate
+ $ cloud-init devel schema --system --annotate
As launching instances in the cloud can cost money and take a bit longer,
sometimes it is easier to launch instances locally using Multipass or LXD: