summaryrefslogtreecommitdiff
path: root/tools/ds-identify
diff options
context:
space:
mode:
authorScott Moser <smoser@ubuntu.com>2018-09-14 21:12:17 +0000
committerServer Team CI Bot <josh.powers+server-team-bot@canonical.com>2018-09-14 21:12:17 +0000
commitbb60f61bfcd92465f4076e8d8abbb486cf6bbcf1 (patch)
tree17dbac0f8253a11e70e77176bcea9f73340b632c /tools/ds-identify
parentc6cfed7fb58be76a3f95963a5de469aa03542cd3 (diff)
downloadvyos-cloud-init-bb60f61bfcd92465f4076e8d8abbb486cf6bbcf1.tar.gz
vyos-cloud-init-bb60f61bfcd92465f4076e8d8abbb486cf6bbcf1.zip
ds-identify: doc string cleanup.
There was a typo in the doc string at the top of ds-identify (disable -> disabled). That is fixed here as well as adding some better examples on content in /etc/cloud/ds-identify.cfg.
Diffstat (limited to 'tools/ds-identify')
-rwxr-xr-xtools/ds-identify16
1 files changed, 12 insertions, 4 deletions
diff --git a/tools/ds-identify b/tools/ds-identify
index fcc60149..5afe5aa1 100755
--- a/tools/ds-identify
+++ b/tools/ds-identify
@@ -2,16 +2,24 @@
# shellcheck disable=2015,2039,2162,2166
#
# ds-identify is configured via /etc/cloud/ds-identify.cfg
-# or on the kernel command line. It takes primarily 2 inputs:
+# or on the kernel command line. It takes the following inputs:
+#
# datasource: can specify the datasource that should be used.
-# kernel command line option: ci.datasource=<dsname>
+# kernel command line option: ci.datasource=<dsname> or ci.ds=<dsname>
+# example line in /etc/cloud/ds-identify.cfg:
+# datasource: Ec2
#
# policy: a string that indicates how ds-identify should operate.
-# kernel command line option: ci.di.policy=<policy>
+#
# The format is:
# <mode>,found=value,maybe=value,notfound=value
# default setting is:
-# search,found=all,maybe=all,notfound=disable
+# search,found=all,maybe=all,notfound=disabled
+#
+# kernel command line option: ci.di.policy=<policy>
+# example line in /etc/cloud/ds-identify.cfg:
+# policy: search,found=all,maybe=none,notfound=disabled
+#
#
# Mode:
# disabled: disable cloud-init