summaryrefslogtreecommitdiff
path: root/doc/man/cloud-init-per.1
diff options
context:
space:
mode:
authorzsdc <taras@vyos.io>2020-03-11 21:20:58 +0200
committerzsdc <taras@vyos.io>2020-03-11 21:22:23 +0200
commitc6627bc05a57645e6af8b9a5a67e452d9f37e487 (patch)
treeb754b3991e5e57a9ae9155819f73fa0cbd4be269 /doc/man/cloud-init-per.1
parentca9a4eb26b41c204d1bd3a15586b14a5dde950bb (diff)
parent13e82554728b1cb524438163784e5b955c7c5ed0 (diff)
downloadvyos-cloud-init-c6627bc05a57645e6af8b9a5a67e452d9f37e487.tar.gz
vyos-cloud-init-c6627bc05a57645e6af8b9a5a67e452d9f37e487.zip
Cloud-init: T2117: Updated to 20.1
- Merge 20.1 version from the Canonical repository - Removed unneeded changes in datasources (now only OVF datasource is not equal to upstream's version) - Adapted cc_vyos module to new Cloud-init version - Changed Jenkinsfile to use build scripts, provided by upstream
Diffstat (limited to 'doc/man/cloud-init-per.1')
-rw-r--r--doc/man/cloud-init-per.145
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/man/cloud-init-per.1 b/doc/man/cloud-init-per.1
new file mode 100644
index 00000000..3668232e
--- /dev/null
+++ b/doc/man/cloud-init-per.1
@@ -0,0 +1,45 @@
+.TH CLOUD-INIT-PER 1
+
+.SH NAME
+cloud-init-per \- Run a command with arguments at a specific frequency
+
+.SH SYNOPSIS
+.BR "cloud-init-per" " <frequency> <name> <cmd> [ arg1 [ arg2 [...]]]"
+
+.SH DESCRIPTION
+Run a command with arguments at a specific frequency.
+
+This utility can make it easier to use boothooks or bootcmd on a per
+"once" or "always" basis. For example:
+
+ - [ cloud-init-per, once, mymkfs, mkfs, /dev/vdb ]
+
+The cloud-init-per command replaced the cloud-init-run-module command.
+
+.SH OPTIONS
+.TP
+.B "frequency"
+This can be one of the following values:
+
+.BR "once" ":"
+run only once and do not re-run for new instance-id
+
+.BR "instance" ":"
+run only the first boot for a given instance-id
+
+.BR "always" ":"
+run every boot
+
+.TP
+.B "name"
+A name to give the command to run to show up in logs.
+
+.TP
+.B "cmd [ arg1 [ arg2 [...]]]"
+The actual command to run followed by any additional arguments.
+
+.SH COPYRIGHT
+Copyright (C) 2020 Canonical Ltd. License GPL-3 or Apache-2.0
+
+.SH SEE ALSO
+Full documentation at: <https://cloudinit.readthedocs.io>