summaryrefslogtreecommitdiff
path: root/doc/rtd/howto/disable_cloud_init.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rtd/howto/disable_cloud_init.rst')
-rw-r--r--doc/rtd/howto/disable_cloud_init.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/rtd/howto/disable_cloud_init.rst b/doc/rtd/howto/disable_cloud_init.rst
new file mode 100644
index 00000000..75e07001
--- /dev/null
+++ b/doc/rtd/howto/disable_cloud_init.rst
@@ -0,0 +1,39 @@
+.. _disable-Cloud_init:
+
+How to disable cloud-init
+*************************
+
+One may wish to disable cloud-init to ensure that it doesn't do anything on
+subsequent boots. Some parts of cloud-init may run once per boot otherwise.
+
+There are two cross-platform methods of disabling ``cloud-init``.
+
+Method 1: text file
+====================
+
+To disable cloud-init, create the empty file
+:file:`/etc/cloud/cloud-init.disabled`. During boot the operating system's init
+system will check for the existence of this file. If it exists, cloud-init will
+not be started.
+
+Example:
+
+.. code-block::
+
+ $ touch /etc/cloud/cloud-init.disabled
+
+Method 2: kernel commandline
+============================
+
+To disable cloud-init, add ``cloud-init=disabled`` to the kernel commandline.
+
+Example (using GRUB2 with Ubuntu):
+
+.. code-block::
+
+ $ echo 'GRUB_CMDLINE_LINUX=cloud-init.disabled' >> /etc/default/grub
+ $ grub-mkconfig -o /boot/efi/EFI/ubuntu/grub.cfg
+
+.. note::
+ When running in containers, ``cloud-init`` will read an environment
+ variable named ``KERNEL_CMDLINE`` in place of a kernel commandline.