ansible-role-tripleo-image-build
This is a standard Ansible role, and can be installed as a dependency via ansible-galaxy, pip, or your own mechanism(s)
Anyone who wants to build images. Tools such as:
- ci.centos.org image building jobs that create images used by tripleo-quickstart
- Self Test (tests/build.sh)
- C.A.T.
- other folks building images for various test and CI purposes
ansible-galaxy -v install -p roles-from-galaxy -r requirements-build.yml
- extracting ansible-role-tripleo-image-build to roles-from-galaxy/ansible-role-tripleo-image-build
- ansible-role-tripleo-image-build was installed successfully# from GitHub
- sec: git+ssh://github.com/redhat-openstack/ansible-role-tripleo-parts
- src: git+ssh://github.com/redhat-openstack/ansible-role-tripleo-image-build
# local files
# - src: file:///home/me/ci/ansible-role-tripleo-image-buildvia Python Setup Tools (virtualenv, pip) C.A.T.
In addition to supporting Galaxy, this role allows for being installed via pip. A file is provided in the root of this repo (setup.cfg) that will install the necessary files in egg form.
pip install -r requirements-build.txtThat file might look like this
pbr>=1.6
ansible==2.0.1
git+https://github.com/redhat-openstack/ansible-role-tripleo-parts.git#egg=ansible-role-tripleo-parts
git+https://github.com/redhat-openstack/ansible-role-tripleo-image-build.git#egg=ansible-role-tripleo-image-build
# to pull in local development changes
#file:///home/me/ci/ansible-role-tripleo-image-build/#egg=ansible-role-tripleo-image-buildIn addition to the methods described above to reference and/or import this role into your own project, a sample script is provided that allows for creating images directly from a clone of this git repository. If you have ideas on how to make this role better (and want to contribute) please see below for details on how to submit a patch.
build.sh is an easy way to quickly see how image building works, and iterate on this role locally.
pushd tests/pip
./build.sh $VIRTHOSTFull options for build.sh
./build.sh [options] virthost
-i, --install-deps Install C.A.T. dependencies (git, python-virtualenv, gcc, libyaml)
* Basic options w/ defaults
-p, --playbook <playbook> default: 'build_default_images.yml', Specify playbook to be executed.
-z, --requirements <file> default: 'requirements-build.txt', Specify the python setup tools requirements file.
-r, --release <release> default: 'mitaka', { kilo | liberty | mitaka }
-b, --base_os <os> default: 'centos7', { centos7 | rhel }
-u, --base_url <url> Must be resolvable from $virthost. Shortcut for: \'-e artib_minimal_base_image_url=<url>\'
-e, --extra-vars <file> Additional Ansible variables. Supports multiple ('-e f1 -e f2')
-o, --output <logfile> tee output to file
* Advanced options
-w, --working-dir <directory> Location of ci-ansible-tripleo sources and virtual env
-c, --clean Clean the virtualenv before running a deployment
-g, --git-clone Git clone --> ssh://github.com/redhat-openstack/ansible-role-tripleo-image-build
-s, --system-site-packages Create virtual env with access to local site packages
-v, --ansible-debug Invoke ansible-playbook with -vvvv
-h, -?, --help Display this help and exitNote: this sample playbook leverages a simple role that dynamically adds $VIRTHOST (via 'virthost') to the Ansible inventory.
hosts: localhost
roles:
- { role: add-inventory-virthost, virthost: "$VIRTHOST" }
- name: Build images using defaults (rdo, mitaka, centos7)
hosts: virthost
remote_user: root
roles:
- parts/kvm
- parts/libvirt
- ansible-role-tripleo-image-buildThis role requires libguestfs, virt-customize, virt-sparsify, and other dependencies installed and configured via parts/kvm and parts/libvirt.
meta/main.yml pulls in the following dependencies that setup KVM, libvirt, and libguestfs. These are provided by ansible-role-tripleo-parts
- parts/kvm
- parts/libvirt
tasks/main.yml After nuking the working directory:
- (repo_setup.yml) Get the base image and setup yum repositories
- (package_install.yml) Install packages for overcloud base image
- (convert_undercloud.yml) Use overcloud base image to create undercloud base image
- (dib_build.yml) Use DIB to build the overlcloud-full and IPA images, leveraging support from tripleo-common
- (undercloud_inject.yml) Inject overcloud-full and IPA images into the undercloud image
Notes:
- The overcloud image is constructed by a series of calls to virt-customize, part of libguestfs to run scripts that 'yum install' directly to the qcow2. Other utilities from this toolset are also used to grow/shrink/sparsify/manipulate the image(s).
- The undercloud qcow is generated by starting with the overcloud and adding/removing a few packages.
- The overcloud and IPA images are then written --> undercloud image, so when undercloud.qcow2 is booted by tripleo-quickstart, the overcloud image is present and ready to be deployed.
All land in working_dir.
The builder logs are a canonical log of how the qcow2's are created, and is the best, first place to look/explore.
- builder-undercloud.log
- builder-overcloud.log
Content Manifests (every file, size, mode, etc)
- content-undercloud.csv
- content-overcloud.csv
Additional per-phase (potentially verbose) logs are found in working directory
The defaults for image building are located at defaults/main.yml. With no params specified this role will build images for:
- Mitaka (RDO, delorean, current-passed-ci)
- http://trunk.rdoproject.org/centos7-mitaka/{{ artib_delorean_hash | default('current-passed-ci')}}/delorean.repo
- CentOS 7 base image
- Disk Image Builder (DIB) tools from liberty are used
- images are built in $virthost:/home/oooq-images
To change or customize how images are built and what they contain, enabling scenarios such as:
- {rdo, rhos} x {centos, rhel}
- RPM's, container (future), built from source (future)
- additional test tools or configuration (be vocal, submit issues/blueprints!)
| Variable | Description |
|---|---|
| artib_working_dir | All artifacts are created here. |
| artib_release | (rdo only): mitaka, liberty |
| artib_dib_prepare_script | Jinja2 template bash script used to prepare host for building images with DIB |
| artib_dib_release_rpm | where DIB itself comes from. Default: "http://rdoproject.org/repos/openstack-liberty/rdo-release-liberty.rpm" |
| artib_minimal_base_image_url | base image for undercloud and overcloud |
| artib_repo_script | Jinja2 template bash script used to install repositories on base image for binaries via virt-customize |
| artib_undercloud_remove_packages | the undercloud image is generated by starting with the overcloud, removing packages from, and adding packages to it. This is the list of packages to remove |
| artib_undercloud_install_packages | ^ this is the list of packages to add |
| artib_overcloud_package_list | the set of packages installed (by yum) on the images. Default: vars/default_package_list.yml |
| artib_overcloud_images | the list of artifacts that are packaged and published by invoking this role |
| artib_vc_verbose | (default: false) set to true for verbose virt-customize output |
| artib_vc_trace | (default: false) set to true for trace/dbg virt-customize output |
| artib_dib_remove_epel | if true, removes epel from the DIB elements tree with hostility |
| artib_dib_workarounds | enabled (true) by default, this causes an additional virt-customize pass specifically to massage DIB inputs for temporary workarouds |
| artib_dib_workaround_script | ^ the script for this |
| artib_overcloud_build_mode | python module (default), "openstack overcloud image build", or "tripleo-build-images" |
Here are the full defaults contained in defaults/main.yml. Note that most are internal and should not be modified.
# defaults file for ansible-role-tripleo-image-build
# global build vars
artib_working_dir: /var/lib/oooq-images
# Whether or not to delete the working directory before starting.
artib_start_over: true
# repo_setup vars
artib_minimal_base_image_url:
http://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
# global build vars
artib_working_dir: /var/lib/oooq-images
# delete working directory prior to building images.
artib_start_over: true
# repo_setup vars
artib_minimal_base_image_url:
http://cloud.centos.org/centos/7/images/CentOS-7-x86_64-GenericCloud.qcow2
artib_minimal_overwrite_existing: no
artib_base_os: centos7
artib_release: mitaka
artib_build_system: delorean
artib_image_stage_location: testing
artib_repo_script: "repo-{{ artib_base_os }}-{{ artib_build_system }}.sh.j2"
#swapfile arguments
artib_swapfile_script: swapfile-create.sh.j2
# package_install vars
artib_overcloud_base_image_url:
"file:///{{ artib_working_dir }}/minimal-base.qcow2"
artib_overcloud_overwrite_existing: no
artib_package_install_script: package-install-default.sh.j2
artib_overcloud_package_list: default_package_list.yml
# convert_undercloud vars
artib_undercloud_base_image_url:
"file:///{{ artib_working_dir }}/overcloud-base.qcow2"
artib_undercloud_overwrite_existing: no
artib_undercloud_convert_script: undercloud-convert-default.sh.j2
artib_undercloud_disk_size: 42
artib_vc_ram: 8192
artib_vc_cpu: 4
artib_vc_verbose: false
artib_vc_trace: false
# undercloud == overcloud (+/-) packages
artib_undercloud_remove_packages:
- cloud-init
- mariadb-galera-server
- openstack-sahara*
- python2-barbicanclient
artib_undercloud_install_packages:
- mariadb-server
- python-tripleoclient
- openstack-tempest
# -tests packages which contains tempest-style tests
- python-aodh-tests
- python-ceilometer-tests
- python-heat-tests
- python-ironic-tests
- python-keystone-tests
- python-manila-tests
- python-mistral-tests
- python-neutron-tests
- python-sahara-tests
- python-zaqar-tests
artib_undercloud_selinux_permissive: true
##################
# dib_build vars #
##################
#
# default is to use an ansible module (python_module_tripleo_build_images) to invoke tripleo-common's python class directly
# ansible-role-tripleo-image-build/library/tripleo_build_images.py
#
# "openstack_overcloud_image_build" enable the upstream tripleo doc'd mechanism
# https://docs.openstack.org/developer/tripleo-docs/post_deployment/build_single_image.html
# note this is for ocata+ / osp 11+.
#
# "tripleo_build_images" call tripleo-build-images from tripleo-common.
# valid for mitaka/newton osp 9/10 only
#
artib_overcloud_build_mode: python_module_tripleo_build_images
# creates yaml file passed to the tripleo-common image building library
artib_image_yaml_template: "dib-manifest-default.yaml.j2"
# sets the filesystem type for overcloud-full image
artib_overcloud_fs_type: "xfs"
# https://github.com/redhat-openstack/ansible-role-tripleo-image-build/issues/15
artib_dib_workarounds: true
artib_dib_workaround_script: dib-workaround-default.sh.j2
artib_dib_elements_path:
- /usr/share/tripleo-image-elements
- /usr/share/tripleo-puppet-elements
- /usr/share/instack-undercloud/
- "{% if artib_release == 'mitaka' %}/usr/share/openstack-heat-templates/software-config/elements/{% endif %}"
# set up build host (build tools, etc)
artib_dib_prepare_script: dib-prepare-centos7-default.sh.j2
artib_dib_remove_epel: true
# TODO: currently we build by default with mitaka rpm...though IMHO this should track whatever release we are building
# "http://rdoproject.org/repos/openstack-{{ artib_release }}/rdo-release-{{ artib_release }}.rpm"
artib_dib_release_rpm:
"http://rdoproject.org/repos/openstack-mitaka/rdo-release-mitaka.rpm"
# injected --> undercloud.qcow2
artib_overcloud_images:
- ironic-python-agent.initramfs
- ironic-python-agent.kernel
- overcloud-full.initrd
- overcloud-full.qcow2
- overcloud-full.vmlinuz
# fail, ignore, continue. See http://libguestfs.org/virt-sparsify.1.html
artib_virt_sparsify_checktmpdir_flag: fail
# artib_publish_dest_user: username
# artib_publish_dest_host: foo.example.com
# artib_publish_dest_basepath: /var/www/html/yourchoice
# artib_publish_create_dest_via_ssh: false
artib_publish: false
artib_publish_artifacts:
- undercloud.qcow2
- undercloud.qcow2.md5
- ironic-python-agent.tar
- ironic-python-agent.tar.md5
- overcloud-full.tar
- overcloud-full.tar.md5
- artib-logs.tar.gz
- artib-logs.tar.gz.md5
No other galaxy roles are leveraged. libvirt and portions of KVM are used to build images via parts/kvm, and parts/libvirt
Contributions and patches are welcome! Feel free to log issues and/or discuss here:
https://github.com/redhat-openstack/ansible-role-tripleo-image-build/issues
Code reviews and patches are managed by Gerrit here:
https://review.gerrithub.io/#/q/project:redhat-openstack/ansible-role-tripleo-image-build
Ideas for substantive changes and/or features/targets/requirements are heartily welcomed. Please do reach out on IRC (freenode) at #rdo or #tripleo, or please submit a blueprint here:
https://github.com/redhat-openstack/ansible-role-tripleo-image-build/blueprints
$ git clone ssh://github.com/redhat-openstack/ansible-role-tripleo-image-build
$ cd ansible-role-tripleo-image-build/
$ git review -s
Creating a git remote called "gerrit" that maps to:
ssh://[email protected]:29418/redhat-openstack/ansible-role-tripleo-image-build.git
$ git remote -v
gerrit ssh://[email protected]:29418/redhat-openstack/ansible-role-tripleo-image-build.git (fetch)
gerrit ssh://[email protected]:29418/redhat-openstack/ansible-role-tripleo-image-build.git (push)
origin ssh://github.com/redhat-openstack/ansible-role-tripleo-image-build (fetch)
origin ssh://github.com/redhat-openstack/ansible-role-tripleo-image-build (push)- create a branch (git checkout -b my-groovy-idea)
- add files and commit
- Post review (git review)
The commit message should be of the form:
A single line description of the change
A multi-line description of the change, ideally with
context and/or URL to github issue.To address feedback and iterate on reviews, amend your existing commit (git commit --amend) and run "git review" again. Be sure to leave the Change-Id alone!
Apache 2.0
redhat-openstack
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent