The main goal of this project is to provide guest cloud initialization for Windows and other operating systems.
The architecture of the project is highly flexible and allows extensions for additional clouds and plugins.
There's no limitation in the type of supported Hypervisor. This service can be used on instances running on Hyper-V, KVM, Xen, ESXi, etc
Documentation, support and contacts: http://www.cloudbase.it
The following x64 and x86 builds are automatically generated by a Jenkins job at every commit:
https://www.cloudbase.it/downloads/CloudbaseInitSetup_Beta_x64.msi https://www.cloudbase.it/downloads/CloudbaseInitSetup_Beta_x86.msi
A metadata service has the role of pulling the metadata configuration information.
Supported clouds and metadata services:
- OpenStack (HTTP)
- OpenStack (ConfigDrive)
- Amazon EC2
- CloudStack
- OpenNebula
- Ubuntu MAAS
Plugins execute actions based on the metadata obtained by the service.
Sets the instance's hostname.
Creates a local cloud user (if it does not already exist) and adds it to a set 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 |
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 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 |
Configures static networking.
| Option | Description | Default |
|---|---|---|
| network_adapter | Network adapter to configure | None |
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.
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.
Extends automatically a disk partition to it's maximum size. This is useful when booting images with different flavors.
Configures a WinRM HTTPS listener to allow remote management via WinRS or PowerShell.
Enables password-less authentication for remote management via WinRS or PowerShell. See: http://www.cloudbase.it/windows-without-passwords-in-openstack/
Executes any script (e.g. Powershell, CMD, etc) located in the following path.
| Option | Description | Default |
|---|---|---|
| local_scripts_path | Local scripts path | None |
Activates the Windows instance if the following option is True.
| Option | Description | Default |
|---|---|---|
| activate_windows | Activate Windows | False |
Applies NTP client info based on the DHCP server options, if available.
| Option | Description | Default |
|---|---|---|
| ntp_use_dhcp_config | Set NTP from DHCP | False |
Sets the network interfaces MTU based on the value provided by the DHCP server 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 |
Executes custom scripts provided with the user_data metadata as plain text or compressed with Gzip.
Supported formats:
The file is executed in a cmd.exe shell (can be changed with the COMSPEC environment variable). The user_data first line must be:
rem cmd
The user_data first line must be:
#ps1_sysnative
or for a x86 PowerShell execution:
#ps1_x86
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:
#!
e.g.:
#!/bin/bash
Cloud-config YAML configuration as supported by cloud-init, excluding Linux specific content. The user_data first line must be:
#cloud-config
Note: currently only local file creation is supported.
MIME multi-part userdata is supported. The content will ne handled based on the content type.
Any script to be executed: PowerShell, CMD, Bash or Python.
A script that can manage other content type parts. This is used in particular by Heat / CFN templates, although Linux specific.
Heat / CFN content. Written to the path provided by:
| Option | Description | Default |
|---|---|---|
| heat_config_dir | Heat configuration path | C:\cfn |
Example Heat Windows templates: https://github.com/openstack/heat-templates/tree/master/hot/Windows