add the vmware guestinfo service

Author: rgl

cloudbaseinit/conf/default.py

@@ -162,6 +162,8 @@ def __init__(self, config):
                 default=[
                     'cloudbaseinit.metadata.services.httpservice.HttpService',
                     'cloudbaseinit.metadata.services'
+                    '.vmwareguestinfo.VMwareGuestInfoService',
+                    'cloudbaseinit.metadata.services'
                     '.configdrive.ConfigDriveService',
                     'cloudbaseinit.metadata.services.ec2service.EC2Service',
                     'cloudbaseinit.metadata.services'

cloudbaseinit/conf/factory.py

@@ -23,6 +23,7 @@
     'cloudbaseinit.conf.openstack.OpenStackOptions',
     'cloudbaseinit.conf.azure.AzureOptions',
     'cloudbaseinit.conf.ovf.OvfOptions',
+    'cloudbaseinit.conf.vmwareguestinfo.VMwareGuestInfoConfigOptions',
 )
 
 

cloudbaseinit/conf/vmwareguestinfo.py

@@ -0,0 +1,41 @@
+# Copyright 2019 ruilopes.com
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""Config options available for the VMwareGuestInfo metadata service."""
+
+from oslo_config import cfg
+
+from cloudbaseinit.conf import cloudconfig
+
+class VMwareGuestInfoConfigOptions(cloudconfig.CloudConfigOptions):
+    """Config options available for the VMwareGuestInfo metadata service."""
+
+    def __init__(self, config):
+        super(VMwareGuestInfoConfigOptions, self).__init__(config, group='vmwareguestinfo')
+        self._options = [
+            cfg.StrOpt(
+                'rpctool_path',
+                default='C:/Program Files/VMware/VMware Tools/rpctool.exe',
+                help='VMware Tools rpctool.exe path'),
+        ]
+
+    def register(self):
+        """Register the current options to the global ConfigOpts object."""
+        group = cfg.OptGroup(self._group_name, title="VMwareGuestInfo Config Options")
+        self._config.register_group(group)
+        self._config.register_opts(self._options, group=group)
+
+    def list(self):
+        """Return a list which contains all the available options."""
+        return self._options

cloudbaseinit/metadata/services/vmwareguestinfoservice.py

@@ -0,0 +1,123 @@
+# Copyright 2019 ruilopes.com
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import base64
+import gzip
+import io
+import os
+
+from cloudbaseinit import conf as cloudbaseinit_conf
+from cloudbaseinit import exception
+from cloudbaseinit.metadata.services import base
+from cloudbaseinit.osutils import factory as osutils_factory
+
+CONF = cloudbaseinit_conf.CONF
+
+class VMwareGuestInfoService(base.BaseMetadataService):
+    """
+    This uses the VMware Guest Info interface to obtain the cloud init data
+    from the VM extraconfig guestinfo properties using the VMware Tools
+    rpctool cli application.
+
+    You can use the following guestinfo properties:
+
+    +--------------------+------------------------------------------------------+
+    | property           | description                                          |
+    +--------------------+------------------------------------------------------+
+    | guestinfo.metadata | A JSON document containing the cloud-init metadata.  |
+    | guestinfo.userdata | A YAML document containing the cloud-init userdata,  |
+    |                    | or a MIME multipart message with the YAML document   |
+    |                    | containing the cloud-init user data and custom       |
+    |                    | scripts as described at doc/source/userdata.rst      |
+    +--------------------+------------------------------------------------------+
+
+    When using terraform, you can create a cloud init configuration with:
+
+        # a cloud-init userdata.
+        # see https://www.terraform.io/docs/providers/template/d/cloudinit_config.html
+        # see https://www.terraform.io/docs/configuration/expressions.html#string-literals
+        data "template_cloudinit_config" "example" {
+            gzip = true
+            base64_encode = true
+            part {
+                content_type = "text/cloud-config"
+                content = <<-EOF
+                #cloud-config
+                set_hostname: example
+                EOF
+            }
+        }
+
+        # see https://www.terraform.io/docs/providers/vsphere/r/virtual_machine.html
+        resource "vsphere_virtual_machine" "example" {
+            ...
+            # NB this extra_config data ends-up inside the VM .vmx file and will be
+            #    exposed by cloudbase-init as a cloud-init datasource.
+            extra_config = {
+                "guestinfo.userdata" = data.template_cloudinit_config.example.rendered
+                "guestinfo.metadata" = base64gzip(jsonencode({
+                    "admin-username": var.winrm_username,
+                    "admin-password": var.winrm_password,
+                    "public-keys": [trimspace(file("~/.ssh/id_rsa.pub"))],
+                }))
+            }
+            ...
+        }
+
+    NB The base image must have the VMware Tools installed.
+    """
+
+    def __init__(self):
+        super(VMwareGuestInfoService, self).__init__()
+        self._os_utils = osutils_factory.get_os_utils()
+
+    def get_user_data(self):
+        return self._get_cache_data('userdata')
+
+    def get_meta_data(self):
+        return json.self._get_cache_data('metadata')
+
+    def _get_data(self, name):
+        if not os.path.exists(CONF.vmwareguestinfo.rpctool_path):
+            return None
+        stdout, stderr, exit_code = self._os_utils.execute_process([
+            CONF.vmwareguestinfo.rpctool_path,
+            'info-get guestinfo.%s' % name
+        ])
+        if exit_code:
+            raise exception.CloudbaseInitException(
+                'Failed to execute "%(rpctool_path)s" with '
+                'exit code: %(exit_code)s\nstdout: %(stdout)s\nstderr: %(stderr)s' % {
+                    'rpctool_path': CONF.vmwareguestinfo.rpctool_path,
+                    'exit_code': exit_code,
+                    'stdout': stdout,
+                    'stderr': stderr})
+        data = base64.b64decode(stdout)
+        if data[:2] == self._GZIP_MAGIC_NUMBER:
+            bio = io.BytesIO(data)
+            with gzip.GzipFile(fileobj=bio, mode='rb') as out:
+                data = out.read()
+        return data
+
+    def get_host_name(self):
+        return self.get_meta_data().get('local-hostname')
+
+    def get_public_keys(self):
+        return self.get_meta_data().get('public-keys')
+
+    def get_admin_username(self):
+        return self.get_meta_data().get('admin-username')
+
+    def get_admin_password(self):
+        return self.get_meta_data().get('admin-password')

cloudbaseinit/plugins/common/sshpublickeys.py

@@ -34,7 +34,7 @@ def execute(self, service, shared_data):
             LOG.debug('Public keys not found in metadata')
             return base.PLUGIN_EXECUTION_DONE, False
 
-        username = CONF.username
+        username = service.get_admin_username() or CONF.username
 
         osutils = osutils_factory.get_os_utils()
         user_home = osutils.get_user_home(username)