Use a common python build/install role

In order to radically simplify how we prepare the service
venvs, we use a common role to do the wheel builds and the
venv preparation. This makes the process far simpler to
understand, because the role does its own building and
installing. It also reduces the code maintenance burden,
because instead of duplicating the build processes in the
repo_build role and the service role - we only have it all
done in a single place.

We also change the role venv tag var to use the integrated
build's common venv tag so that we can remove the role's
venv tag in group_vars in the integrated build. This reduces
memory consumption and also reduces the duplication.

This is by no means the final stop in the simplification
process, but it is a step forward. The will be work to follow
which:

1. Replaces 'developer mode' with an equivalent mechanism
   that uses the common role and is simpler to understand.
   We will also simplify the provisioning of pip install
   arguments when doing this.
2. Simplifies the installation of optional pip packages.
   Right now it's more complicated than it needs to be due
   to us needing to keep the py_pkgs plugin working in the
   integrated build.
3. Deduplicates the distro package installs. Right now the
   role installs the distro packages twice - just before
   building the venv, and during the python_venv_build role
   execution.

Depends-On: https://review.openstack.org/598957
Change-Id: I9c25b430bd7590131b50f36c697fcc24e1abaf64
Implements: blueprint python-build-install-simplification
Signed-off-by: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>
This commit is contained in:
Jesse Pretorius 2018-03-27 22:17:57 +01:00 committed by Jesse Pretorius (odyssey4me)
parent 596d05eb1a
commit 7266fe2197
5 changed files with 40 additions and 113 deletions

View File

@ -40,8 +40,19 @@ ironic_developer_mode: false
ironic_developer_constraints: ironic_developer_constraints:
- "git+{{ ironic_git_repo }}@{{ ironic_git_install_branch }}#egg=ironic" - "git+{{ ironic_git_repo }}@{{ ironic_git_install_branch }}#egg=ironic"
# TODO(odyssey4me):
# This can be simplified once all the roles are using
# python_venv_build. We can then switch to using a
# set of constraints in pip.conf inside the venv,
# perhaps prepared by giving a giving a list of
# constraints to the role.
ironic_pip_install_args: >-
{{ ironic_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
{{ (pip_install_upper_constraints is defined) | ternary('--constraint ' + pip_install_upper_constraints | default(''), '') }}
{{ pip_install_options | default('') }}
# Name of the virtual env to deploy into # Name of the virtual env to deploy into
ironic_venv_tag: untagged ironic_venv_tag: "{{ venv_tag | default('untagged') }}"
ironic_bin: "/openstack/venvs/ironic-{{ ironic_venv_tag }}/bin" ironic_bin: "/openstack/venvs/ironic-{{ ironic_venv_tag }}/bin"
# System info # System info

View File

@ -20,6 +20,8 @@
enabled: yes enabled: yes
daemon_reload: yes daemon_reload: yes
with_list: "{{ filtered_ironic_services }}" with_list: "{{ filtered_ironic_services }}"
listen:
- "venv changed"
- name: Restart tftpd-hpa - name: Restart tftpd-hpa
service: service:

View File

@ -13,17 +13,12 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
- name: Install distro packages # TODO(odyssey4me):
package: # This can be simplified once all the roles are using
name: "{{ ironic_packages_list }}" # python_venv_build. We can then switch to using a
state: "{{ ironic_package_state }}" # set of constraints in pip.conf inside the venv,
update_cache: "{{ (ansible_pkg_mgr == 'apt') | ternary('yes', omit) }}" # perhaps prepared by giving a giving a list of
cache_valid_time: "{{ (ansible_pkg_mgr == 'apt') | ternary(cache_timeout, omit) }}" # constraints to the role.
register: install_packages
until: install_packages is success
retries: 5
delay: 2
- name: Create developer mode constraint file - name: Create developer mode constraint file
copy: copy:
dest: "/opt/developer-pip-constraints.txt" dest: "/opt/developer-pip-constraints.txt"
@ -33,104 +28,23 @@
{% endfor %} {% endfor %}
when: ironic_developer_mode | bool when: ironic_developer_mode | bool
- name: Retrieve checksum for venv download - name: Ensure remote wheel building is disabled in developer mode
uri: set_fact:
url: "{{ ironic_venv_download_url | replace('tgz', 'checksum') }}" venv_build_host: "{{ ansible_hostname }}"
return_content: yes
register: ironic_venv_checksum
when: ironic_venv_download | bool
- name: Attempt venv download
get_url:
url: "{{ ironic_venv_download_url }}"
dest: "/var/cache/{{ ironic_venv_download_url | basename }}"
checksum: "sha1:{{ ironic_venv_checksum.content | trim }}"
register: ironic_get_venv
when: ironic_venv_download | bool
- name: Remove existing venv
file:
path: "{{ ironic_bin | dirname }}"
state: absent
when: ironic_get_venv is changed
- name: Create ironic venv dir
file:
path: "{{ ironic_bin | dirname }}"
state: directory
mode: "0755"
register: ironic_venv_dir
when: ironic_get_venv is changed
- name: Unarchive pre-built venv
unarchive:
src: "/var/cache/{{ ironic_venv_download_url | basename }}"
dest: "{{ ironic_bin | dirname }}"
copy: "no"
when: ironic_get_venv is changed
notify: Restart ironic services
- name: Install pip packages
pip:
name: "{{ ironic_pip_packages }}"
state: "{{ ironic_pip_package_state }}"
virtualenv: "{{ ironic_bin | dirname }}"
virtualenv_site_packages: "no"
extra_args: >-
{{ ironic_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
{{ (pip_install_upper_constraints is defined) | ternary('--constraint ' + pip_install_upper_constraints | default(''),'') }}
{{ pip_install_options | default('') }}
register: install_packages
until: install_packages is success
retries: 5
delay: 2
when: ironic_get_venv | failed or ironic_get_venv | skipped
notify: Restart ironic services
- name: Remove python from path first (CentOS, openSUSE)
file:
path: "{{ ironic_bin | dirname }}/bin/python2.7"
state: "absent"
when: when:
- ansible_pkg_mgr in ['yum', 'zypper'] - ironic_developer_mode | bool
- ironic_get_venv is changed
# NOTE(odyssey4me): - name: Install the python venv
# We reinitialize the venv to ensure that the right include_role:
# version of python is in the venv, but we do not name: "python_venv_build"
# want virtualenv to also replace pip, setuptools private: yes
# and wheel so we tell it not to. vars:
# We do not use --always-copy for CentOS/SuSE due venv_build_distro_package_list: "{{ ironic_devel_distro_packages }}"
# to https://github.com/pypa/virtualenv/issues/565 venv_install_destination_path: "{{ ironic_bin | dirname }}"
- name: Update virtualenv path venv_install_distro_package_list: "{{ ironic_packages_list }}"
shell: | venv_pip_install_args: "{{ ironic_pip_install_args }}"
find {{ ironic_bin }} -name \*.pyc -delete venv_pip_packages: "{{ (ironic_oslomsg_amqp1_enabled | bool) | ternary(ironic_pip_packages + ironic_optional_oslomsg_amqp1_pip_packages, ironic_pip_packages) }}"
sed -si '1s/^.*python.*$/#!{{ ironic_bin | replace ('/','\/') }}\/python/' {{ ironic_bin }}/* venv_facts_when_changed:
virtualenv {{ ironic_bin | dirname }} \ - section: "ironic"
{{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \ option: "venv_tag"
--no-pip \ value: "{{ ironic_venv_tag }}"
--no-setuptools \
--no-wheel
when: ironic_get_venv is changed
tags:
- skip_ansible_lint
- name: Install optional pip packages
pip:
name: "{{ ironic_optional_oslomsg_amqp1_pip_packages }}"
state: "{{ ironic_pip_package_state }}"
virtualenv: "{{ ironic_bin | dirname }}"
virtualenv_site_packages: "no"
when: ironic_oslomsg_amqp1_enabled
register: install_optional_packages
until: install_optional_packages is success
retries: 5
delay: 2
notify: Restart ironic services
- name: Record the venv tag deployed
ini_file:
dest: "/etc/ansible/facts.d/openstack_ansible.fact"
section: ironic
option: venv_tag
value: "{{ ironic_venv_tag }}"

View File

@ -154,7 +154,7 @@ ironic_driver_types:
ironic_packages_list: > ironic_packages_list: >
{%- set package_list = [] %} {%- set package_list = [] %}
{%- if ironic_developer_mode | bool %} {%- if ironic_developer_mode | bool %}
{%- set package_list = package_list + ironic_developer_mode_distro_packages %} {%- set package_list = package_list + ironic_devel_distro_packages %}
{%- endif %} {%- endif %}
{%- if ironic_services['ironic-api']['group'] in group_names %} {%- if ironic_services['ironic-api']['group'] in group_names %}
{%- set package_list = package_list + ironic_api_distro_packages %} {%- set package_list = package_list + ironic_api_distro_packages %}

View File

@ -15,7 +15,7 @@
cache_timeout: 600 cache_timeout: 600
ironic_developer_mode_distro_packages: ironic_devel_distro_packages:
- git-core - git-core
- libffi-dev - libffi-dev