This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch 4.20
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/4.20 by this push:
new d6cb68d Section about vm password in ConfigDrive (#501)
d6cb68d is described below
commit d6cb68d4f83a1b0ff73a3c1aa63c16d25f0e6ada
Author: Phsm Qwerty <p...@users.noreply.github.com>
AuthorDate: Tue Jun 3 08:19:20 2025 +0000
Section about vm password in ConfigDrive (#501)
---
source/adminguide/api.rst | 25 ++++++++++++++++++++++++-
1 file changed, 24 insertions(+), 1 deletion(-)
diff --git a/source/adminguide/api.rst b/source/adminguide/api.rst
index b4139a8..48bdeb6 100644
--- a/source/adminguide/api.rst
+++ b/source/adminguide/api.rst
@@ -12,7 +12,7 @@
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-
+
The CloudStack API is a low level API that has been used to implement
the CloudStack web UIs. It is also a good basis for implementing other
@@ -177,6 +177,29 @@ VMdata - a list of String arrays representing
[“directory”, “filename”,
- default: config-2
+Virtual machine password via ConfigDrive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ConfigDrive metadata provider delivers the virtual machine password
simultaneously in two variants, leaving which one to use to the user discretion:
+
+1. As the ``<mountdir>/cloudstack/password/vm_password.txt`` file.
+
+This file is intended to be used by an external script that runs inside the
virtual machine every boot, and changes the password if needed.
+The init-script that implements this functionality can be found in the
`Cloudstack source
<https://github.com/apache/cloudstack/blob/main/setup/bindir/cloud-set-guest-password-configdrive.in>`_.
+
+.. note::
+ The ``vm_password.txt`` file is not compatible with cloud-init password
module, so the cloud-init will ignore it.
+ It is up to Cloudstack administrator to include the script processing it
in the virtual machines and/or their templates.
+
+2. As the ``<mountdir>/openstack/latest/vendor_data.json``.
+This is a standard password location supported by cloud-init's both
ConfigDrive datasource and the password module.
+Therefore, this variant allows using cloud-init as the only tool for
provisioning a virtual machine, without using external scripts.
+
+.. warning::
+ Cloud-init password module is designed to only perform the initial virtual
machine password setup.
+ It will ignore the changes in ``vendor_data.json`` after the first run.
Therefore, resetting the virtual machine password from Cloudstack will not work
with this variant.
+
+
For more detailed information about the Config Drive implementation refer to
the `Wiki Article
<https://cwiki.apache.org/confluence/display/CLOUDSTACK/Using+ConfigDrive+for+Metadata%2C+Userdata+and+Password#:~:text=CLOUDSTACK%2D9813%20%2D%20(),%2Dkeys)%20and%20password%20files>`_
