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.

Depends-On: https://review.openstack.org/598957
Change-Id: I7a6acaa94265b21fb886a775c3b5b86a4142a905
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:03:04 +01:00 committed by Jesse Pretorius (odyssey4me)
parent 2d8475e602
commit 48aaa17291
3 changed files with 43 additions and 128 deletions

View File

@ -54,8 +54,18 @@ gnocchi_secure_proxy_ssl_header: HTTP_X_FORWARDED_PROTO
#: Set this to false to disable API service through Apache + mod_wsgi
gnocchi_use_mod_wsgi: true
# 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.
gnocchi_pip_install_args: >-
{{ gnocchi_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
{{ pip_install_options | default('') }}
#: Name of the virtual env to deploy into
gnocchi_venv_tag: untagged
gnocchi_venv_tag: "{{ venv_tag | default('untagged') }}"
gnocchi_bin: "/openstack/venvs/gnocchi-{{ gnocchi_venv_tag }}/bin"
gnocchi_venv_pkgs: "/openstack/venvs/gnocchi-{{ gnocchi_venv_tag }}/lib/python2.7/site-packages"

View File

@ -27,7 +27,9 @@
until: _stop is success
retries: 5
delay: 2
listen: Restart gnocchi services
listen:
- "Restart gnocchi services"
- "venv changed"
# Note (odyssey4me):
# The policy.json file is currently read continually by the services
@ -45,7 +47,9 @@
group: "{{ gnocchi_system_group_name }}"
mode: "0640"
remote_src: yes
listen: Restart gnocchi services
listen:
- "Restart gnocchi services"
- "venv changed"
- name: Start services
service:
@ -61,7 +65,9 @@
until: _start is success
retries: 5
delay: 2
listen: Restart gnocchi services
listen:
- "Restart gnocchi services"
- "venv changed"
- name: Restart web server
service:

View File

@ -13,17 +13,12 @@
# See the License for the specific language governing permissions and
# limitations under the License.
- name: Install distro packages
package:
name: "{{ gnocchi_distro_packages }}"
state: "{{ gnocchi_package_state }}"
update_cache: "{{ (ansible_pkg_mgr in ['apt', 'zypper']) | ternary('yes', omit) }}"
cache_valid_time: "{{ (ansible_pkg_mgr == 'apt') | ternary(cache_timeout, omit) }}"
register: install_packages
until: install_packages is 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"
@ -33,118 +28,22 @@
{% endfor %}
when: gnocchi_developer_mode | bool
- name: Retrieve checksum for venv download
uri:
url: "{{ gnocchi_venv_download_url | replace('tgz', 'checksum') }}"
return_content: yes
register: gnocchi_venv_checksum
when: gnocchi_venv_download | bool
- name: Attempt venv download
get_url:
url: "{{ gnocchi_venv_download_url }}"
dest: "/var/cache/{{ gnocchi_venv_download_url | basename }}"
checksum: "sha1:{{ gnocchi_venv_checksum.content | trim }}"
register: gnocchi_get_venv
when: gnocchi_venv_download | bool
- name: Remove existing venv
file:
path: "{{ gnocchi_bin | dirname }}"
state: absent
when: gnocchi_get_venv is changed
- name: Create gnocchi venv dir
file:
path: "{{ gnocchi_bin | dirname }}"
state: directory
mode: "0755"
register: gnocchi_venv_dir
when: gnocchi_get_venv is changed
- name: Unarchive pre-built venv
unarchive:
src: "/var/cache/{{ gnocchi_venv_download_url | basename }}"
dest: "{{ gnocchi_bin | dirname }}"
copy: "no"
when: gnocchi_get_venv is changed
notify:
- Restart gnocchi services
- Restart web server
- name: Create the python venv and install packages into it
when: gnocchi_get_venv | failed or gnocchi_get_venv | skipped
block:
- name: Create the virtualenv (if it does not exist)
command: "virtualenv --never-download --no-site-packages {{ gnocchi_bin | dirname }}"
args:
creates: "{{ gnocchi_bin }}/activate"
- name: Upgrade pip/setuptools/wheel to the versions we want
pip:
name:
- pip
- setuptools
- wheel
state: "{{ gnocchi_pip_package_state }}"
virtualenv: "{{ gnocchi_bin | dirname }}"
virtualenv_site_packages: "no"
extra_args: >-
{{ gnocchi_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
{{ pip_install_options | default('') }}
register: install_packages
until: install_packages is success
retries: 5
delay: 2
- name: Install pip packages
pip:
name: "{{ gnocchi_pip_packages }}"
state: "{{ gnocchi_pip_package_state }}"
virtualenv: "{{ gnocchi_bin | dirname }}"
virtualenv_site_packages: "no"
extra_args: >-
{{ gnocchi_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
{{ pip_install_options | default('') }}
register: install_packages
until: install_packages is success
retries: 5
delay: 2
notify:
- Restart gnocchi services
- Restart web server
- name: Remove python from path first (CentOS, openSUSE)
file:
path: "{{ gnocchi_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']
- gnocchi_get_venv is changed
- gnocchi_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 {{ gnocchi_bin }} -name \*.pyc -delete
sed -si '1s/^.*python.*$/#!{{ gnocchi_bin | replace ('/','\/') }}\/python/' {{ gnocchi_bin }}/*
virtualenv {{ gnocchi_bin | dirname }} \
{{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
--no-pip \
--no-setuptools \
--no-wheel
when: gnocchi_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: gnocchi
option: venv_tag
value: "{{ gnocchi_venv_tag }}"
- name: Install the python venv
include_role:
name: "python_venv_build"
private: yes
vars:
venv_install_destination_path: "{{ gnocchi_bin | dirname }}"
venv_install_distro_package_list: "{{ gnocchi_distro_packages }}"
venv_pip_install_args: "{{ gnocchi_pip_install_args }}"
venv_pip_packages: "{{ gnocchi_pip_packages }}"
venv_facts_when_changed:
- section: "gnocchi"
option: "venv_tag"
value: "{{ gnocchi_venv_tag }}"