Infrared virt-customize plugin

This is a demo plugin for infrared which is not maintained, if you want to consume virt-customize natively with Ansible refer to POC repo of virt-customize-ansible-modules

Notes:

• No linting is being done at the moment

• Due to infrared's design, works only on RHEL and Fedora

• Not optimized to the way infrared works with variables at the moment

• Assumes that the user running virt-customize has rw permission to guest disk image

• Assumes repos are configured on guest disk image

Description

A plugin for RedHat's infrared tool.

This plugin is designed to perform customization on guest disk images using libguestfs and additional tools.

Installation

Assuming infrared is already installed and configured (installation guide):

infrared plugin add https://github.com/VKhitrin/infrared-virt-customize

Usage

See notes on the top for some limitations in place at the moment

Specifying executor host

By default, this plugin will be executed on remote undercloud node:

infrared virt-customize --image-host '/path/to/image' --install vim

If you don't have undercloud installed or want to run locally:

infrared virt-customize --host-address localhost --image-host '/path/to/image' --install vim

If you wish to run the plugin on remote host, you can specify host-user (by default is root) and you must specify host-key (SSH private key that can log to remote machine):

infrared virt-customize --host-address remote.my.domain --host-user root --host-key ~/.ssh/id_rsa --image-host '/path/to/image' --install vim

General arguments

Only one image-* option can be supplied

List of guest disk image locations on executor host (required=False)

infrared virt-customize --image-host '/path/to/image','/path/to/image2'

List of guest disk image locations from the web (required=False)

infrared virt-customize --image-url 'http://site.com/path/to/image1','https://site.com/path/to/image2'

List of guest disk image locations on infrared client (required=False)

infrared virt-customize --image-local '/path/to/image','/path/to/image2'

The directory on executor host where images will be fetched to (required=False, default='/tmp')

infrared virt-customize --image-url 'http://site.com/path/to/image1' --image-path '/home/stack/'

Enable N ≥ 2 vCPUs during execution (required=False):

infrared virt-customize --cpu N

Enable N amount in MBs of memory during execution (required=False):

infrared virt-customize --memory N

Enable virt-customize's verbosity (required=False):

infrared virt-customize --verbosity yes

Enabled virt-customize's debug (required=False):

infrared virt-customize --trace yes

Skip libguestfs tools installation on executor host (required=False):

infrared virt-customize --skip-install-tools yes

Scrub build log of virt-customize from guest disk image (required=False):

infrared virt-customize --scrub-build-log yes

Set password encrypthion method when performing password tasks (required=False):

infrared virt-customize --password-crypto md5|sha256|sha512

Subscription Manager manipulation

Register to subscription manager [required both --sm-register and --sm-credentials] (required=False):

infrared virt-customize --image-* '/path/to/image' --sm-register yes --sm-credentials user@email.com:password

Attach a subscription to guest disk image:

infrared virt-customize --image-* '/path/to/image' --sm-attach poolid

Remove all subscriptions from guest disk image:

infrared virt-customize --image-* '/path/to/image' --sm-remove yes

Unregister from subscription manager [Works only if guest disk image is registered to subscription manager] (required=False):

infrared virt-customize --image-* '/path/to/image' --sm-unregister yes 

Package manipulation

List of packages to be installed on guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --install package1,package2

List of packages to be uninstalled from guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --uninstall package1,package2

Update packages on guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --update yes

Install packages on guest disk image on firstboot (required=False):

infrared virt-customize --image-* '/path/to/image' --firstboot-install package1,package2

Guest manipulation

Run virt-customize commands from file on guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --commands-file /path/to/commands-file

Execute a script on guest disk image on firstboot (required=False):

infrared virt-customize --image-* '/path/to/image' --firstboot-file /path/to/file

Execute a command on guest disk image on firstboot (required=False):

infrared virt-customize --image-* '/path/to/image' --firstboot-command command

Set a hostname in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --guest-hostname hostname

Set a user's password in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --user-password user:password

Set root's password in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --root-password password

Run script (located on disk-image) in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --run-script script

Run command in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --run-command command

Inject SSH key to user in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --ssh-inject user:ssh_key

Set a timezone in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --guest-timezone timezone

Relabel SELinux file contexets in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --selinux-relabel yes

File manipulation

Copy files inside guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --copy-inside /path/to/source:/path/to/dest

Copy files from infrared client to guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --copy-to /path/to/source:/path/to/dest

Delete files in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --delete /path/to/file

Append line to file in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --append-line /path/to/file:line

Change permission to file in guest disk image [can be decimal or octal permission] (required=False):

infrared virt-customize --image-* '/path/to/image' --guest-permission permission:/path/to/file

Create symbolic link to file in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --guest-link /path/to/target:/path/to/file

Create directories in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --guest-directory /path/to/directory

Move file/directories in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --move-inside /path/to/source:/path/to/dest

Scrub file in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --scrub /path/to/file

Truncate file to zero length in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --truncate /path/to/file

Truncate path to zero length in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --truncate-recursive /path/to/file

Create a file in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --create /path/to/file

Copy file from infrared client to guest disk image while preserving permissions (required=False):

infrared virt-customize --image-* '/path/to/image' --upload-to /path/to/source:/path/to/dest

Write content to file in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --write-content /path/to/file:content

Edit file's content using perl's regular expression in guest disk image (required=False):

infrared virt-customize --image-* '/path/to/image' --edit /path/to/file:perl_reg_expression