From faee049e24566267c1658ff6a3d6cdc104a041a9 Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Tue, 27 Mar 2018 21:59:07 +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: I29833c41eba9b3ff80200b7f567a120f589e170e Implements: blueprint python-build-install-simplification Signed-off-by: Jesse Pretorius --- defaults/main.yml | 13 ++- handlers/main.yml | 12 ++- tasks/designate_install_source.yml | 139 +++++------------------------ vars/redhat-7.yml | 2 +- vars/suse-42.yml | 2 +- vars/ubuntu.yml | 2 +- 6 files changed, 48 insertions(+), 122 deletions(-) diff --git a/defaults/main.yml b/defaults/main.yml index 8d0a57b..68c1226 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -42,8 +42,19 @@ designate_developer_mode: False designate_developer_constraints: - "git+{{ designate_git_repo }}@{{ designate_git_install_branch }}#egg=designate" +# 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. +designate_pip_install_args: >- + {{ designate_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 -designate_venv_tag: untagged +designate_venv_tag: "{{ venv_tag | default('untagged') }}" designate_bin: "{{ _designate_bin }}" # Set the etc dir path where designate is installed. diff --git a/handlers/main.yml b/handlers/main.yml index 2aad106..9c45783 100644 --- a/handlers/main.yml +++ b/handlers/main.yml @@ -23,7 +23,9 @@ until: _stop is success retries: 5 delay: 2 - listen: Restart designate services + listen: + - "Restart designate services" + - "venv changed" # Note (odyssey4me): # The policy.json file is currently read continually by the services @@ -41,7 +43,9 @@ group: "{{ designate_system_group_name }}" mode: "0640" remote_src: yes - listen: Restart designate services + listen: + - "Restart designate services" + - "venv changed" - name: Start services systemd: @@ -52,4 +56,6 @@ until: _start is success retries: 5 delay: 2 - listen: Restart designate services + listen: + - "Restart designate services" + - "venv changed" diff --git a/tasks/designate_install_source.yml b/tasks/designate_install_source.yml index 170a338..1d0660e 100644 --- a/tasks/designate_install_source.yml +++ b/tasks/designate_install_source.yml @@ -13,18 +13,12 @@ # See the License for the specific language governing permissions and # limitations under the License. -- name: Install designate distro packages - package: - name: "{{ designate_developer_mode_distro_packages }}" - state: "{{ designate_package_state }}" - update_cache: "{{ (ansible_pkg_mgr in ['apt', 'zypper']) | ternary('yes', omit) }}" - cache_valid_time: "{{ (ansible_pkg_mgr == 'apt') | ternary(cache_timeout, omit) }}" - when: designate_developer_mode | bool - register: install_packages - until: install_packages|success - retries: 5 - delay: 2 - +# 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" @@ -34,108 +28,23 @@ {% endfor %} when: designate_developer_mode | bool -- name: Retrieve checksum for venv download - uri: - url: "{{ designate_venv_download_url | replace('tgz', 'checksum') }}" - return_content: yes - register: designate_venv_checksum - when: designate_venv_download | bool - -- name: Attempt venv download - get_url: - url: "{{ designate_venv_download_url }}" - dest: "/var/cache/{{ designate_venv_download_url | basename }}" - checksum: "sha1:{{ designate_venv_checksum.content | trim }}" - register: designate_get_venv - when: designate_venv_download | bool - -- name: Remove existing venv - file: - path: "{{ designate_bin | dirname }}" - state: absent - when: designate_get_venv is changed - -- name: Create designate venv dir - file: - path: "{{ designate_bin | dirname }}" - state: directory - mode: "0755" - register: designate_venv_dir - when: designate_get_venv is changed - -- name: Unarchive pre-built venv - unarchive: - src: "/var/cache/{{ designate_venv_download_url | basename }}" - dest: "{{ designate_bin | dirname }}" - copy: "no" - when: designate_get_venv is changed - notify: - - Restart designate services - -- name: Install pip packages - pip: - name: "{{ designate_pip_packages }}" - state: "{{ designate_pip_package_state }}" - virtualenv: "{{ designate_bin | dirname }}" - virtualenv_site_packages: "no" - extra_args: >- - {{ designate_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: designate_get_venv | failed or designate_get_venv | skipped - notify: - - Restart designate services - -- name: Remove python from path first (CentOS, openSUSE) - file: - path: "{{ designate_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'] - - not designate_developer_mode | bool - - designate_get_venv is changed + - designate_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 {{ designate_bin }} -name \*.pyc -delete - sed -si '1s/^.*python.*$/#!{{ designate_bin | replace ('/','\/') }}\/python/' {{ designate_bin }}/* - virtualenv {{ designate_bin | dirname }} \ - {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \ - --no-pip \ - --no-setuptools \ - --no-wheel - when: designate_get_venv is changed - tags: - - skip_ansible_lint - -- name: Install optional pip packages - pip: - name: "{{ designate_optional_oslomsg_amqp1_pip_packages }}" - state: "{{ designate_pip_package_state }}" - virtualenv: "{{ designate_bin | dirname }}" - virtualenv_site_packages: "no" - when: designate_oslomsg_amqp1_enabled - register: install_optional_packages - until: install_optional_packages is success - retries: 5 - delay: 2 - notify: - - Restart designate services - -- name: Record the venv tag deployed - ini_file: - dest: "/etc/ansible/facts.d/openstack_ansible.fact" - section: designate - option: venv_tag - value: "{{ designate_venv_tag }}" +- name: Install the python venv + include_role: + name: "python_venv_build" + private: yes + vars: + venv_build_distro_package_list: "{{ designate_devel_distro_packages }}" + venv_install_destination_path: "{{ designate_bin | dirname }}" + venv_install_distro_package_list: "{{ designate_distro_packages }}" + venv_pip_install_args: "{{ designate_pip_install_args }}" + venv_pip_packages: "{{ (designate_oslomsg_amqp1_enabled | bool) | ternary(designate_pip_packages + designate_optional_oslomsg_amqp1_pip_packages, designate_pip_packages) }}" + venv_facts_when_changed: + - section: "designate" + option: "venv_tag" + value: "{{ designate_venv_tag }}" diff --git a/vars/redhat-7.yml b/vars/redhat-7.yml index ab0ef2f..673546d 100644 --- a/vars/redhat-7.yml +++ b/vars/redhat-7.yml @@ -32,5 +32,5 @@ designate_service_distro_packages: designate_rndc_packages: - bind -designate_developer_mode_distro_packages: +designate_devel_distro_packages: - systemd-devel diff --git a/vars/suse-42.yml b/vars/suse-42.yml index 5ca1fb6..6a7f2e0 100644 --- a/vars/suse-42.yml +++ b/vars/suse-42.yml @@ -30,6 +30,6 @@ designate_service_distro_packages: designate_rndc_packages: - bind-utils -designate_developer_mode_distro_packages: +designate_devel_distro_packages: - pkg-config - systemd-devel diff --git a/vars/ubuntu.yml b/vars/ubuntu.yml index ed6389a..9739ee1 100644 --- a/vars/ubuntu.yml +++ b/vars/ubuntu.yml @@ -35,7 +35,7 @@ designate_service_distro_packages: designate_rndc_packages: - bind9utils -designate_developer_mode_distro_packages: +designate_devel_distro_packages: - build-essential - libsystemd-dev - pkg-config