openstack/openstack-ansible-os_neutron
Code Issues Proposed changes

Use a common python build/install role

Browse Source 
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: I1c1dcd73c9d5d78c0a8e40149ff84cbba828f3e2
Implements: blueprint python-build-install-simplification
Signed-off-by: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>
This commit is contained in:
Jesse Pretorius 2018-09-02 18:00:33 +01:00 committed by Jesse Pretorius (odyssey4me)
parent 0485e812fc
commit b0241f8100
4 changed files with 56 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
defaults/main.yml
View File

@ -79,8 +79,19 @@ networking_ovn_git_install_branch: master
# Developer mode
neutron_developer_mode: false
# 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.
neutron_pip_install_args: >-
{{ neutron_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
neutron_venv_tag: untagged
neutron_venv_tag: "{{ venv_tag | default('untagged') }}"
# venv_download, even when true, will use the fallback method of building the
# venv from scratch if the venv download fails.

16
handlers/main.yml
View File

@ -24,7 +24,9 @@
until: _stop is success
retries: 5
delay: 2
listen: "Restart neutron services"
listen:
- "Restart neutron services"
- "venv changed"
# NOTE(cloudnull):
# When installing or upgrading it is possible that an old metadata proxy process will not
@ -43,7 +45,9 @@
fi
done
when: "'neutron-metadata-agent' in (filtered_neutron_services | map(attribute='service_key') | list)"
listen: "Restart neutron services"
listen:
- "Restart neutron services"
- "venv changed"
- name: Perform a DB contract
command: "{{ neutron_bin }}/neutron-db-manage upgrade --contract"
@ -54,7 +58,9 @@
- "ansible_local['openstack_ansible']['neutron']['need_db_contract'] | bool"
- "neutron_services['neutron-server']['group'] in group_names"
- "inventory_hostname == ((groups[neutron_services['neutron-server']['group']] | intersect(ansible_play_hosts)) | list)[0]"
listen: "Restart neutron services"
listen:
- "Restart neutron services"
- "venv changed"
- name: Start services
service:
@ -67,4 +73,6 @@
until: _start is success
retries: 5
delay: 2
listen: "Restart neutron services"
listen:
- "Restart neutron services"
- "venv changed"

6
tasks/neutron_install.yml
View File

@ -61,11 +61,7 @@
state: "True"
- name: "need_db_contract"
state: "True"
when: (neutron_install_method == 'source' and
((neutron_get_venv | changed) or
(neutron_venv_dir | changed) or
(install_optional_packages | changed))) or
(install_packages | changed) or
when: (install_packages | changed) or
(ansible_local is not defined) or
('openstack_ansible' not in ansible_local) or
('neutron' not in ansible_local['openstack_ansible']) or

140
tasks/neutron_install_source.yml
View File

@ -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"
@ -22,118 +28,34 @@
{% endfor %}
when: neutron_developer_mode | bool
- name: Retrieve checksum for venv download
uri:
url: "{{ neutron_venv_download_url | replace('tgz', 'checksum') }}"
return_content: yes
register: neutron_venv_checksum
when: neutron_venv_download | bool
- name: Attempt venv download
get_url:
url: "{{ neutron_venv_download_url }}"
dest: "/var/cache/{{ neutron_venv_download_url | basename }}"
checksum: "sha1:{{ neutron_venv_checksum.content | trim }}"
register: neutron_get_venv
when: neutron_venv_download | bool
- name: Remove existing venv
file:
path: "{{ neutron_bin | dirname }}"
state: absent
when: neutron_get_venv is changed
- name: Create neutron venv dir
file:
path: "{{ neutron_bin | dirname }}"
state: directory
register: neutron_venv_dir
when: neutron_get_venv is changed
- name: Unarchive pre-built venv
unarchive:
src: "/var/cache/{{ neutron_venv_download_url | basename }}"
dest: "{{ neutron_bin | dirname }}"
copy: "no"
when: neutron_get_venv is changed
notify: Restart neutron services
- name: Install pip packages
pip:
name: "{{ neutron_pip_packages }}"
state: "{{ neutron_pip_package_state }}"
virtualenv: "{{ neutron_bin | dirname }}"
virtualenv_site_packages: "no"
extra_args: >-
{{ neutron_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: neutron_get_venv | failed or neutron_get_venv | skipped
notify: Restart neutron services
- name: Remove python from path first (CentOS, openSUSE)
file:
path: "{{ neutron_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']
- neutron_get_venv is changed
- neutron_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: |
set -o errexit
find {{ neutron_bin }} -name \*.pyc -delete
if test -d {{ neutron_bin }}/__pycache__; then rmdir {{ neutron_bin }}/__pycache__; fi
sed -si '1s/^.*python.*$/#!{{ neutron_bin | replace ('/','\/') }}\/python/' {{ neutron_bin }}/*
virtualenv {{ neutron_bin | dirname }} \
{{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
--no-pip \
--no-setuptools \
--no-wheel
when: neutron_get_venv is changed
tags:
- skip_ansible_lint
- name: Install optional pip packages
pip:
name: >-
{{ (neutron_bgp | bool) | ternary(neutron_optional_bgp_pip_packages, []) +
- name: Install the python venv
include_role:
name: "python_venv_build"
private: yes
vars:
venv_install_destination_path: "{{ neutron_bin | dirname }}"
venv_install_distro_package_list: "{{ neutron_package_list }}"
venv_pip_install_args: "{{ neutron_pip_install_args }}"
venv_pip_packages: >-
{{ neutron_pip_packages +
(neutron_bgp | bool) | ternary(neutron_optional_bgp_pip_packages, []) +
(neutron_fwaas | bool) | ternary(neutron_optional_fwaas_pip_packages, []) +
(neutron_fwaas_v2 | bool) | ternary(neutron_optional_fwaas_pip_packages, []) +
(neutron_lbaasv2 | bool) | ternary(neutron_optional_lbaas_pip_packages, []) +
(neutron_vpnaas | bool) | ternary(neutron_optional_vpnaas_pip_packages, []) }}
state: "{{ neutron_pip_package_state }}"
virtualenv: "{{ neutron_bin | dirname }}"
virtualenv_site_packages: "no"
extra_args: >-
{{ neutron_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('') }}
when: neutron_bgp | bool or
neutron_fwaas | bool or
neutron_fwaas_v2 | bool or
neutron_lbaasv2 | bool or
neutron_vpnaas | bool
register: install_optional_packages
until: install_optional_packages is success
retries: 5
delay: 2
notify: Restart neutron services
- name: Record the venv tag deployed
ini_file:
dest: "/etc/ansible/facts.d/openstack_ansible.fact"
section: neutron
option: venv_tag
value: "{{ neutron_venv_tag }}"
venv_facts_when_changed:
- section: "neutron"
option: "need_db_expand"
value: "True"
- section: "neutron"
option: "need_db_contract"
value: "True"
- section: "neutron"
option: "venv_tag"
value: "{{ neutron_venv_tag }}"