Cloud-init - Revision history

Leo: Make a template

2023-07-26T16:36:32Z

Make a template

@@ Line 200: / Line 200: @@
 === Disable cloud-init ===
 The cloud-init service file is set so that it doesn't run if <code>/etc/cloud/cloud-init.disabled</code> exists or if the '<code>cloud-init=disabled</code>' exists in the kernel command line
 ==Troubleshooting==

Leo at 18:07, 14 April 2022

2022-04-14T18:07:02Z

← Older revision		Revision as of 18:07, 14 April 2022
Line 29:		Line 29:
	\|}		\|}

	===~~Default~~ user===		===The default user===
	The default username for the non-super user account is 'cloud-user'. Some distros use a different default user such as 'alpine' for Alpine Linux or 'ubuntu' for Ubuntu. If you wish to ~~override this~~ username, you need to edit the <code>cloud.cfg</code> configuration file. For my Rocky Linux image, I ran the following to change the default username.		The default username for the non-super user account is 'cloud-user'. Some distros use a different default user such as 'alpine' for Alpine Linux or 'ubuntu' for Ubuntu.
			The default user account will be created only if '''no''' users are defined. If you do define a list of users, you'll have to also include the default user in this list or else it won't be created. {{Info
			\| title = Do not create the default user account
			\| message = I noticed that some Packer builds create the default user account as part of the initial image set up. Don't do this because you are making assumptions on how the VM is to be configured.

			The user could have overridden the default user username with something else or wanted to skip creating the default user account entirely. If you precreate the account, you cause issues for these two scenarios.

			Additionally, leaving the account creation to Cloud-Init allows it to take care of additional account settings including the SSH authorized key setup and group memberships.
			}}

			==== Changing the default user username ====
			If you wish to change the default user's username, you need to edit the <code>cloud.cfg</code> configuration file.
			{{Highlight
			\| code = system_info:
			default_user:
			name: cloud-user
			lock_passwd: true
			gecos: Cloud User
			\| lang = terminal
			}}
			For my Rocky Linux image, I ran the following to change the default username as part of the kickstart post install script.
	{{Highlight		{{Highlight
	\| code = ## The default user is 'cloud-user'. we'll change this to 'rocky'.		\| code = ## The default user is 'cloud-user'. we'll change this to 'rocky'.
	# sed -i "s/name: cloud-user/name: rocky/" /etc/cloud/cloud.cfg		# sed -i "s/name: cloud-user/name: rocky/" /etc/cloud/cloud.cfg
	\| lang = terminal		\| lang = terminal
	}}~~{{Info~~		}}The default user has their password locked, thereby requiring authentication using SSH keys. You may change this by modifying <code>cloud.cfg</code> as well:
	~~\| title = Do not create the default user account~~
	~~\| message = I noticed that some Packer builds create the default user account as part of the initial image set up. Don't do this.~~

	It's intended for the username to be overridden by the initial VM cloud-init configuration. Cloud-Init will take care of the user account creation, SSH authorized key setup, and also setting up the "Please login as the user X rather than the user Y" message on the root account.
	}}
	The default user has their password locked, thereby requiring authentication using SSH keys. You may change this by modifying <code>cloud.cfg</code> as well:
	{{Highlight		{{Highlight
	\| code = # sed -i "s/lock_passwd: true/lock_passwd: false/" /etc/cloud/cloud.cfg		\| code = # sed -i "s/lock_passwd: true/lock_passwd: false/" /etc/cloud/cloud.cfg
Line 61:		Line 75:

	=== CloudStack ===		=== CloudStack ===
	CloudStack has its own data source type.		CloudStack has its own data source type. Source code for the data source is available at https://github.com/canonical/cloud-init/blob/main/cloudinit/sources/DataSourceCloudStack.py.

			To configure CloudInit to use CloudStack, add the following configuration:
	{{Highlight		{{Highlight
	\| code = # cat <<EOF > /etc/cloud/cloud.cfg.d/99_cloudstack.cfg		\| code = # cat <<EOF > /etc/cloud/cloud.cfg.d/99_cloudstack.cfg
Line 72:		Line 88:
	\| lang = terminal		\| lang = terminal
	}}		}}
	~~Issues~~:		The CloudStack data source does two things. It fetches the user data containing the user's cloud-init config and sets a custom password on the default user account. The data is obtained from a special service running on the virtual router (ie. your VM's gateway) on port 80 (meta data) and port 8080 (password). Your VM template should allow access to these services for CloudInit to function properly.

			A few things you can try are:

			* Fetch the CloudInit data by calling <code>curl http://data-server./latest/user-data</code>
			* Fetch the VM password by calling <code>curl -H 'DomU_Request: send_my_password' <nowiki>http://data-server.:8080</nowiki></code>

			==== Setting VM passwords ====
			For VM templates that support passwords, CloudStack will generate a random 6 character password when the VM is created or when a password reset request is made. The password is then set on the virtual router on the VM's network and can be found on the virtual router at <code>/var/cache/cloud/passwords-$network</code>. The guest VM running CloudInit or the [https://raw.githubusercontent.com/apache/cloudstack/bf6266188c89a5487383f216333ae10e878d2c10/setup/bindir/cloud-set-guest-password.in cloud-set-guest-password] script will then fetch the password and set it on the default user account (defined in the CloudInit config or the script, respectively). The saved password is then cleared from the virtual router using another call.

			If the password isn't being set in your VM, there are a few things to check for:

	* ~~I can't get the root~~ password ~~unlocked~~ and set. ~~Account~~ is ~~always locked even with~~ the ~~following:~~		* Is CloudInit running? You should see some log messages in journalctl about a password being obtained and set.
	~~{{Highlight~~		* Is the default user defined? Is the default user being created? Remember, the password is set on the default user account (not root) by the CloudStack Cloud-Init data source.
	\| code ~~= #~~cloud~~-config~~		* If you provide a custom users list in your cloud init data, you'll need to also include the default user or else it won't be created and the password won't be set.
	~~users:~~		* Is the password being set on the virtual router? If you log in to the virtual router, you can tail the <code>/var/cache/cloud/passwords</code> file and see if the password is being set by the management server and cleared by the guest VM.
	~~- name:~~ root		* If you are intentionally setting the password to the root account, make sure the root account isn't locked. You have to set <code>disable_root: false</code> as it defaults to true.
	~~lock_passwd~~: false
	~~inactive: false~~
	~~password: $1$ADUODeAy$Tp1Tp9Sqb42DV3ux2it1L~~.
	~~\| lang = text~~
	}}

	== Cloud Configs ==		== Cloud Configs ==
Line 174:		Line 195:
	\| lang = yaml		\| lang = yaml
	}}		}}

			== Tasks ==

			=== Disable cloud-init ===
			The cloud-init service file is set so that it doesn't run if <code>/etc/cloud/cloud-init.disabled</code> exists or if the '<code>cloud-init=disabled</code>' exists in the kernel command line

	==Troubleshooting==		==Troubleshooting==

Leo at 00:15, 19 February 2022

2022-02-19T00:15:18Z

@@ Line 85: / Line 85: @@
 }}
-== Example Cloud Configs ==
+== Cloud Configs ==
 See: https://cloudinit.readthedocs.io/en/latest/topics/examples.html
 ==Troubleshooting==

Leo at 02:14, 18 February 2022

2022-02-18T02:14:48Z

@@ Line 58: / Line 58: @@
 # /etc/cloud/cloud.cfg.d/99_pve.cfg
 datasource_list: [ NoCloud, ConfigDrive ]
-}}<br />
+}}
 ==Troubleshooting==

Leo: Added categories and navbar

2022-01-03T06:17:21Z

Added categories and navbar

← Older revision		Revision as of 06:17, 3 January 2022
Line 73:		Line 73:
	\| lang = terminal		\| lang = terminal
	}}		}}

			{{Navbox Linux}}
			[[Category:Linux]]
			[[Category:LinuxUtilities]]

Leo at 07:52, 31 December 2021

2021-12-31T07:52:17Z

← Older revision		Revision as of 07:52, 31 December 2021
Line 1:		Line 1:
	Cloud-init is a program that configures a guest virtual machine when it first boots based on configuration data that's supplied to it via network or a storage volume. It is capable of setting things like the guest's network configuration (IP addresses, routes, resolvers), account credentials and SSH authorized keys.		Cloud-init is a program that configures a guest virtual machine when it first boots based on configuration data that's supplied to it via network or a storage volume. It is capable of setting things like the guest's network configuration (IP addresses, routes, resolvers), account credentials and SSH authorized keys.

	== Building Cloud-Init images ==		==Building Cloud-Init images==
	Linux images that support Cloud-Init should have the Cloud-Init package installed and enabled on start up.		Linux images that support Cloud-Init should have the Cloud-Init package installed and enabled on start up.
	{\| class="wikitable"		{\| class="wikitable"
Line 29:		Line 29:
	\|}		\|}

	=== Default user ===		===Default user===
	The default username for the non-super user account is 'cloud-user'. Some distros use a different default user such as 'alpine' for Alpine Linux or 'ubuntu' for Ubuntu. If you wish to override this username, you need to edit the <code>cloud.cfg</code> configuration file. For my Rocky Linux image, I ran the following to change the default username.		The default username for the non-super user account is 'cloud-user'. Some distros use a different default user such as 'alpine' for Alpine Linux or 'ubuntu' for Ubuntu. If you wish to override this username, you need to edit the <code>cloud.cfg</code> configuration file. For my Rocky Linux image, I ran the following to change the default username.
	{{Highlight		{{Highlight
Line 39:		Line 39:
	\| message = I noticed that some Packer builds create the default user account as part of the initial image set up. Don't do this.		\| message = I noticed that some Packer builds create the default user account as part of the initial image set up. Don't do this.

	~~Do not pre-create the user account as part of~~ the ~~image set up. The~~ username ~~could~~ be overridden ~~as part of~~ the VM ~~setup~~ configuration.		It's intended for the username to be overridden by the initial VM cloud-init configuration. Cloud-Init will take care of the user account creation, SSH authorized key setup, and also setting up the "Please login as the user X rather than the user Y" message on the root account.

	Cloud-Init ~~should be~~ the ~~one to create this~~ user ~~when~~ the ~~system boots up for~~ the ~~first time~~.
	}}		}}
	The default user has their password locked, thereby requiring authentication using SSH keys. You may change this by modifying <code>cloud.cfg</code> as well:		The default user has their password locked, thereby requiring authentication using SSH keys. You may change this by modifying <code>cloud.cfg</code> as well:
Line 49:		Line 47:
	}}		}}

	== Hypervisor support ==		==Hypervisor support==

	===Proxmox===		===Proxmox===

Leo at 07:46, 31 December 2021

2021-12-31T07:46:00Z

@@ Line 1: / Line 1: @@
-Cloud-init is a program that configures a guest virtual machine when it first boots based on configuration data that's supplied to it via network or a storage volume. It is capable of setting things like the guest's network configuration (IP addresses, routes, resolvers), account credentials or SSH authorized keys.
+Cloud-init is a program that configures a guest virtual machine when it first boots based on configuration data that's supplied to it via network or a storage volume. It is capable of setting things like the guest's network configuration (IP addresses, routes, resolvers), account credentials and SSH authorized keys.
-==Proxmox==
+== Building Cloud-Init images ==
 Proxmox supports cloud-init using either the NoCloud (v1, used for Linux based guest OSes) or ConfigDrive (v2, used for Windows based guest OSes) data sources. To learn more about different Cloud-Init data sources, see https://cloudinit.readthedocs.io/en/latest/topics/datasources.html#known-sources.
-NoCloud configuration data is passed to the guest using a 4MB CD-ROM image.  If you are creating a new VM, you must attach this CD-ROM device under 'Hardware' -> 'Add' -> 'CloudInit Drive'. Any changes made to the Cloud-Init settings will require this CD-ROM image to be regenerated.
+A NoCloud configuration data is passed to the guest using a 4MB CD-ROM image.  If you are creating a new VM, you must attach this CD-ROM device under 'Hardware' -> 'Add' -> 'CloudInit Drive'. Any changes made to the Cloud-Init settings will require this CD-ROM image to be regenerated.
-When using Proxmox, on the guest OS, you may wish to add the following Cloud-Init setting so that Cloud-Init only checks the two supported data sources:
+When building images for use with Proxmox, it's recommended to add the following cloud.cfg.d file to restrict the data sources to only the supported options. Otherwise, you may have the VM try downloading the configs using some other method until it times out.
 {{highlight|lang=text|code=
 # /etc/cloud/cloud.cfg.d/99_pve.cfg
 datasource_list: [ NoCloud, ConfigDrive ]
-}}
+}}<br />
 ==Troubleshooting==
-=== Cloud-Init isn't setting the static IP address ===
+===Cloud-Init isn't setting the static IP address===
 On Alpine Linux, Cloud-Init runs but the VM is still obtaining the IP address via DHCP.

Leo: cloudinit not setting static IP

2021-12-30T22:54:05Z

cloudinit not setting static IP

@@ Line 1: / Line 1: @@
 Cloud-init is a program that configures a guest virtual machine when it first boots based on configuration data that's supplied to it via network or a storage volume. It is capable of setting things like the guest's network configuration (IP addresses, routes, resolvers), account credentials or SSH authorized keys.
-== Proxmox ==
+==Proxmox==
 Proxmox supports cloud-init using either the NoCloud (v1, used for Linux based guest OSes) or ConfigDrive (v2, used for Windows based guest OSes) data sources. To learn more about different Cloud-Init data sources, see https://cloudinit.readthedocs.io/en/latest/topics/datasources.html#known-sources.
@@ Line 10: / Line 10: @@
 # /etc/cloud/cloud.cfg.d/99_pve.cfg
 datasource_list: [ NoCloud, ConfigDrive ]
 }}

Leo: Initial content

2021-12-30T22:14:25Z

Initial content

New page

Cloud-init is a program that configures a guest virtual machine when it first boots based on configuration data that's supplied to it via network or a storage volume. It is capable of setting things like the guest's network configuration (IP addresses, routes, resolvers), account credentials or SSH authorized keys.

== Proxmox ==
Proxmox supports cloud-init using either the NoCloud (v1, used for Linux based guest OSes) or ConfigDrive (v2, used for Windows based guest OSes) data sources. To learn more about different Cloud-Init data sources, see https://cloudinit.readthedocs.io/en/latest/topics/datasources.html#known-sources.

NoCloud configuration data is passed to the guest using a 4MB CD-ROM image. If you are creating a new VM, you must attach this CD-ROM device under 'Hardware' -> 'Add' -> 'CloudInit Drive'. Any changes made to the Cloud-Init settings will require this CD-ROM image to be regenerated.

When using Proxmox, on the guest OS, you may wish to add the following Cloud-Init setting so that Cloud-Init only checks the two supported data sources:
{{highlight|lang=text|code=
# /etc/cloud/cloud.cfg.d/99_pve.cfg
datasource_list: [ NoCloud, ConfigDrive ]
}}