From 7126647d7d9f21242df9c57c5b8820fdf772cab1 Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Sun, 2 Sep 2018 20:16:11 +0100 Subject: [PATCH] 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: Iecb64d28afe3acfbae7060af55c1a891310e5ef4 Implements: blueprint python-build-install-simplification Signed-off-by: Jesse Pretorius --- defaults/main.yml | 13 +++- handlers/main.yml | 2 + tasks/swift_install_source.yml | 111 +++++++-------------------------- 3 files changed, 37 insertions(+), 89 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 127f9ba5..54d2aee7 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -47,8 +47,19 @@ swift_developer_constraints: - "git+{{ swift_git_repo }}@{{ swift_git_install_branch }}#egg=swift" - "git+{{ swift_swift3_git_repo }}@{{ swift_swift3_git_install_branch }}#egg=swift3" +# 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. +swift_pip_install_args: >- + {{ swift_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 -swift_venv_tag: untagged +swift_venv_tag: "{{ venv_tag | default('untagged') }}" swift_bin: "{{ _swift_bin }}" # venv_download, even when true, will use the fallback method of building the diff --git a/handlers/main.yml b/handlers/main.yml index a3a4437a..39347242 100644 --- a/handlers/main.yml +++ b/handlers/main.yml @@ -20,6 +20,8 @@ state: "restarted" daemon_reload: yes with_items: "{{ filtered_swift_services }}" + listen: + - "venv changed" - name: Restart rsyslog service: diff --git a/tasks/swift_install_source.yml b/tasks/swift_install_source.yml index 6727427c..a46ee41e 100644 --- a/tasks/swift_install_source.yml +++ b/tasks/swift_install_source.yml @@ -13,6 +13,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +# 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. - name: Create developer mode constraint file copy: dest: "/opt/developer-pip-constraints.txt" @@ -23,93 +29,22 @@ when: - swift_developer_mode | bool -- name: Retrieve checksum for venv download - uri: - url: "{{ swift_venv_download_url | replace('tgz', 'checksum') }}" - return_content: yes - register: swift_venv_checksum - when: swift_venv_download | bool - -- name: Attempt venv download - get_url: - url: "{{ swift_venv_download_url }}" - dest: "/var/cache/{{ swift_venv_download_url | basename }}" - checksum: "sha1:{{ swift_venv_checksum.content | trim }}" - register: swift_get_venv - when: swift_venv_download | bool - -- name: Remove existing venv - file: - path: "{{ swift_bin | dirname }}" - state: absent - when: swift_get_venv is changed - -- name: Create swift venv dir - file: - path: "{{ swift_bin | dirname }}" - state: directory - mode: "0755" - register: swift_venv_dir - when: swift_get_venv is changed - -- name: Unarchive pre-built venv - unarchive: - src: "/var/cache/{{ swift_venv_download_url | basename }}" - dest: "{{ swift_bin | dirname }}" - copy: "no" - when: swift_get_venv is changed - notify: - - Restart swift services - -- name: Install pip packages - pip: - name: "{{ swift_pip_packages }}" - state: "{{ swift_pip_package_state }}" - virtualenv: "{{ swift_bin | dirname }}" - virtualenv_site_packages: "no" - extra_args: >- - {{ swift_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: swift_get_venv | failed or swift_get_venv | skipped - notify: - - Restart swift services - -- name: Remove python from path first (CentOS, openSUSE) - file: - path: "{{ swift_bin | dirname }}/bin/python2.7" - state: "absent" +- name: Ensure remote wheel building is disabled in developer mode + set_fact: + venv_build_host: "{{ ansible_hostname }}" when: - - ansible_pkg_mgr in ['yum', 'dnf', 'zypper'] - - swift_get_venv is changed + - swift_developer_mode | bool -# NOTE(odyssey4me): -# We reinitialize the venv to ensure that the right -# version of python is in the venv, but we do not -# want virtualenv to also replace pip, setuptools -# and wheel so we tell it not to. -# We do not use --always-copy for CentOS/SuSE due -# to https://github.com/pypa/virtualenv/issues/565 -- name: Update virtualenv path - shell: | - find {{ swift_bin }} -name \*.pyc -delete - sed -si '1s/^.*python.*$/#!{{ swift_bin | replace ('/','\/') }}\/python/' {{ swift_bin }}/* - virtualenv {{ swift_bin | dirname }} \ - {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \ - --no-pip \ - --no-setuptools \ - --no-wheel - when: swift_get_venv is changed - tags: - - skip_ansible_lint - -- name: Record the venv tag deployed - ini_file: - dest: "/etc/ansible/facts.d/openstack_ansible.fact" - section: swift - option: venv_tag - value: "{{ swift_venv_tag }}" +- name: Install the python venv + include_role: + name: "python_venv_build" + private: yes + vars: + venv_install_destination_path: "{{ swift_bin | dirname }}" + venv_install_distro_package_list: "{{ swift_distro_packages }}" + venv_pip_install_args: "{{ swift_pip_install_args }}" + venv_pip_packages: "{{ swift_pip_packages }}" + venv_facts_when_changed: + - section: "swift" + option: "venv_tag" + value: "{{ swift_venv_tag }}"