Skip to content

Commit ccd5fda

Browse files
committed
Document User Data support for System VMs
1 parent c1a1e33 commit ccd5fda

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

source/adminguide/systemvm.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -944,6 +944,47 @@ System VMs (any of the Console Proxy VM, Secondary Storage VM, Virtual Router or
944944
945945
Since CloudStack 4.16, for VMware, migration of System VMs can also be done to a destination host in a different cluster belonging to the same pod (in case of cluster-wide primary storage pools, this will cause the Root volume of the system VM to be migrated to the appropriate datastore in the new cluster). Storage migration of stopped System VMs is also supported.
946946
947+
Customizing System VMs
948+
----------------------
949+
950+
CloudStack supports User Data for System VMs at boot time.
951+
Default root administrators can supply initialization scripts or configuration to automate tasks
952+
such as installing additional packages, setting environment variables, or configuring telemetry.
953+
Ensure that the User Data is valid for cloud-init.
954+
Invalid content may prevent a System VM from functioning correctly.
955+
956+
.. warning::
957+
User Data offers powerful customization, but inappropriate or intrusive scripts can
958+
destabilize or break System VMs. Avoid modifying critical services or networking unless
959+
you fully understand the impact, and always test changes in a non-production environment
960+
before rollout.
961+
962+
To enable and configure User Data for System VMs:
963+
964+
#. Create a User Data entry for the default root administrator account.
965+
#. Set the global setting ``systemvm.userdata.enabled`` to ``true``.
966+
#. Provide the ID of the User Data per System VM type using the following global settings:
967+
968+
.. cssclass:: table-striped table-bordered table-hover
969+
================================= ============================================================
970+
Global Setting Description
971+
================================= ============================================================
972+
``consoleproxy.userdata`` ID of the User Data for Console Proxy VMs
973+
``secondarystorage.userdata`` ID of the User Data for Secondary Storage VMs
974+
``router.userdata`` ID of the User Data for Virtual Routers,
975+
VPC VR, internal LB Instances, and elastic LB Instances
976+
================================= ============================================================
977+
978+
#. Destroy the System VMs and allow CloudStack to re-deploy them to apply the changes.
979+
980+
.. note::
981+
Initialization is performed by a CloudStack service, not by the systemd
982+
cloud-init unit, to avoid conflicts with CloudStack System VM services.
983+
984+
.. note::
985+
Only the default root administrator account can set the global settings for System VM User Data.
986+
The associated User Data entries must also be created under the default root administrator account.
987+
947988
Troubleshoot networks from System VMs
948989
-------------------------------------
949990
.. |run-diagnostics-icon.png| image:: /_static/images/run-diagnostics-icon.png

0 commit comments

Comments
 (0)