From 8642e8bce3530d2deb6b02895c08edd291eea48f Mon Sep 17 00:00:00 2001
From: Chad Smith <chad.smith@canonical.com>
Date: Mon, 2 Nov 2020 07:20:30 -0700
Subject: doc: add example query commands to debug Jinja templates (#645)

---
 doc/rtd/topics/instancedata.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'doc/rtd/topics')

diff --git a/doc/rtd/topics/instancedata.rst b/doc/rtd/topics/instancedata.rst
index 255245a4..1850982c 100644
--- a/doc/rtd/topics/instancedata.rst
+++ b/doc/rtd/topics/instancedata.rst
@@ -592,6 +592,22 @@ see only redacted values.
  % cloud-init query --format 'cloud: {{ v1.cloud_name }} myregion: {{
  % v1.region }}'
 
+ # Locally test that your template userdata provided to the vm was rendered as
+ # intended.
+ % cloud-init query --format "$(sudo cloud-init query userdata)"
+
+ # The --format command renders jinja templates, this can also be used
+ # to develop and test jinja template constructs
+ % cat > test-templating.yaml <<EOF
+   {% for val in ds.meta_data.keys() %}
+   - {{ val }}
+   {% endfor %}
+   EOF
+ % cloud-init query --format="$( cat test-templating.yaml )"
+ - instance_id
+ - dsmode
+ - local_hostname
+
 .. note::
   To save time designing a user-data template for a specific cloud's
   instance-data.json, use the 'render' cloud-init command on an
-- 
cgit v1.2.3