diff --git a/README.rst b/README.rst index 560df7d5..6388aae3 100644 --- a/README.rst +++ b/README.rst @@ -42,12 +42,14 @@ Plugins Plugins execute actions based on the metadata obtained by the service. -#### cloudbaseinit.plugins.windows.sethostname.SetHostNamePlugin +cloudbaseinit.plugins.windows.sethostname.SetHostNamePlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Sets the instance's hostname. -#### cloudbaseinit.plugins.windows.createuser.CreateUserPlugin +cloudbaseinit.plugins.windows.createuser.CreateUserPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Creates a local cloud user (if it does not already exist) and adds it to a set of provided local groups. @@ -55,13 +57,17 @@ of provided local groups. The following configuration parameters control the behaviour of this plugin. ++------------+--------------------------------+------------------+ | Option | Description | Default | -|------------|--------------------------------|------------------| -| _username_ | Name of the cloud user | _Admin_ | -| _groups_ | Comma separated list of groups | _Administrators_ | ++============+================================+==================+ +| *username* | Name of the cloud user | *Admin* | ++------------+--------------------------------+------------------+ +| *groups* | Comma separated list of groups | *Administrators* | ++------------+--------------------------------+------------------+ -#### cloudbaseinit.plugins.windows.setuserpassword.SetUserPasswordPlugin +cloudbaseinit.plugins.windows.setuserpassword.SetUserPasswordPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Sets the cloud user's password. If a password has been provided in the metadata during boot (user_data) it will be used, otherwise a random password @@ -69,79 +75,98 @@ will be generated, encrypted with the user's SSH public key and posted to the metadata provider (currently supported only by the OpenStack HTTP metadata provider). ++------------------------+-------------------------------------------------------------------------------------+---------+ | Option | Description | Default | -|------------------------|-------------------------------------------------------------------------------------|---------| -| _inject_user_password_ | Can be set to false to avoid the injection of the password provided in the metadata | True | ++========================+=====================================================================================+=========+ +| *inject_user_password* | Can be set to false to avoid the injection of the password provided in the metadata | *True* | ++------------------------+-------------------------------------------------------------------------------------+---------+ -#### cloudbaseinit.plugins.windows.networkconfig.NetworkConfigPlugin +cloudbaseinit.plugins.windows.networkconfig.NetworkConfigPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Configures static networking. ++-------------------+------------------------------+---------+ | Option | Description | Default | -|-------------------|------------------------------|---------| -| _network_adapter_ | Network adapter to configure | _None_ | ++===================+==============================+=========+ +| *network_adapter* | Network adapter to configure | *None* | ++-------------------+------------------------------+---------+ -If _network_adapter_ is not specified, the first available ethernet +If *network_adapter* is not specified, the first available ethernet adapter will be chosen if it cannot be matched with the configuration provided in the metadata. -#### cloudbaseinit.plugins.windows.sshpublickeys.SetUserSSHPublicKeysPlugin +cloudbaseinit.plugins.windows.sshpublickeys.SetUserSSHPublicKeysPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Creates an "authorized_keys" file in the user's home directory containing the SSH keys provided in the metadata. It is needed by the -_cloudbaseinit.plugins.windows.setuserpassword.SetUserPasswordPlugin_ plugin. +*cloudbaseinit.plugins.windows.setuserpassword.SetUserPasswordPlugin* plugin. -#### cloudbaseinit.plugins.windows.extendvolumes.ExtendVolumesPlugin +cloudbaseinit.plugins.windows.extendvolumes.ExtendVolumesPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Extends automatically a disk partition to it's maximum size. This is useful when booting images with different flavors. -#### cloudbaseinit.plugins.windows.winrmlistener.ConfigWinRMListenerPlugin +cloudbaseinit.plugins.windows.winrmlistener.ConfigWinRMListenerPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Configures a WinRM HTTPS listener to allow remote management via WinRS or PowerShell. -#### cloudbaseinit.plugins.windows.winrmcertificateauth.ConfigWinRMCertificateAuthPlugin +cloudbaseinit.plugins.windows.winrmcertificateauth.ConfigWinRMCertificateAuthPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Enables password-less authentication for remote management via WinRS or PowerShell. See: http://www.cloudbase.it/windows-without-passwords-in-openstack/ -#### cloudbaseinit.plugins.windows.localscripts.LocalScriptsPlugin +cloudbaseinit.plugins.windows.localscripts.LocalScriptsPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Executes any script (e.g. Powershell, CMD, etc) located in the following path. ++----------------------+--------------------+---------+ | Option | Description | Default | -|----------------------|--------------------|---------| -| _local_scripts_path_ | Local scripts path | _None_ | ++======================+====================+=========+ +| *local_scripts_path* | Local scripts path | *None* | ++----------------------+--------------------+---------+ -#### cloudbaseinit.plugins.windows.licensing.WindowsLicensingPlugin +cloudbaseinit.plugins.windows.licensing.WindowsLicensingPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Activates the Windows instance if the following option is True. ++--------------------+------------------+---------+ | Option | Description | Default | -|--------------------|------------------|---------| -| _activate_windows_ | Activate Windows | _False_ | ++====================+==================+=========+ +| *activate_windows* | Activate Windows | *False* | ++--------------------+------------------+---------+ -#### cloudbaseinit.plugins.windows.ntpclient.NTPClientPlugin +cloudbaseinit.plugins.windows.ntpclient.NTPClientPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Applies NTP client info based on the DHCP server options, if available. ++-----------------------+-------------------+---------+ | Option | Description | Default | -|-----------------------|-------------------|---------| -| _ntp_use_dhcp_config_ | Set NTP from DHCP | _False_ | ++=======================+===================+=========+ +| *ntp_use_dhcp_config* | Set NTP from DHCP | *False* | ++-----------------------+-------------------+---------+ -#### cloudbaseinit.plugins.windows.mtu.MTUPlugin +cloudbaseinit.plugins.windows.mtu.MTUPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Sets the network interfaces MTU based on the value provided by the DHCP server options, if available. @@ -149,26 +174,31 @@ options, if available. This is particularly useful for cases in which a lower MTU value is required for networking (e.g. OpenStack GRE Neutron Open vSwitch configurations). ++-----------------------+-------------------+---------+ | Option | Description | Default | -|-----------------------|-------------------|---------| -| _mtu_use_dhcp_config_ | Set MTU from DHCP | _True_ | ++=======================+===================+=========+ +| *mtu_use_dhcp_config* | Set MTU from DHCP | *True* | ++-----------------------+-------------------+---------+ -#### cloudbaseinit.plugins.windows.userdata.UserDataPlugin +cloudbaseinit.plugins.windows.userdata.UserDataPlugin +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Executes custom scripts provided with the user_data metadata as plain text or compressed with Gzip. Supported formats: -##### Windows batch +Windows batch +""""""""""""" The file is executed in a cmd.exe shell (can be changed with the COMSPEC -environment variable). The user_data first line must be: +environment variable). The *user_data* first line must be: rem cmd -##### PowerShell +PowerShell +"""""""""" The user_data first line must be: @@ -178,7 +208,8 @@ or for a x86 PowerShell execution: #ps1_x86 -##### Bash +Bash +"""" A bash shell needs to be installed in the system and available in the PATH in order to use this feature. The user_data first line must start with: @@ -189,7 +220,8 @@ e.g.: #!/bin/bash -#### cloud-config +cloud-config +"""""""""""" Cloud-config YAML configuration as supported by cloud-init, excluding Linux specific content. The user_data first line must be: @@ -199,28 +231,34 @@ specific content. The user_data first line must be: Note: currently only local file creation is supported. -#### Multi-part userdata content +Multi-part userdata content +""""""""""""""""""""""""""" MIME multi-part userdata is supported. The content will ne handled based on the content type. -##### text/x-shellscript +text/x-shellscript +"""""""""""""""""" Any script to be executed: PowerShell, CMD, Bash or Python. -##### text/part-handler +text/part-handler +""""""""""""""""" A script that can manage other content type parts. This is used in particular by Heat / CFN templates, although Linux specific. -##### text/x-cfninitdata +text/x-cfninitdata +"""""""""""""""""" Heat / CFN content. Written to the path provided by: ++-------------------+-------------------------+-------------+ | Option | Description | Default | -|-------------------|-------------------------|-------------| -| _heat_config_dir_ | Heat configuration path | _C:\\cfn_ | ++===================+=========================+=============+ +| *heat_config_dir* | Heat configuration path | *C:\\cfn* | ++-------------------+-------------------------+-------------+ Example Heat Windows templates: https://github.com/openstack/heat-templates/tree/master/hot/Windows