Add support for using distribution packages for OpenStack services

Distributions provide packages for the OpenStack services so we add
support for using these instead of the pip ones.

Change-Id: I4ff3cbf5e1e1ce04cd4cdc9c1ce97afdeace5159
Depends-On: I5a78e2120e596d36629b4ba978b2b5df76b149b0
Implements: blueprint openstack-distribution-packages

defaults/main.yml

@@ -18,6 +18,9 @@
 cinder_package_state: "latest"
 cinder_pip_package_state: "latest"
 
+# Set installation method.
+cinder_install_method: "source"
+
 cinder_log_dir: /var/log/cinder
 
 cinder_git_repo: https://git.openstack.org/openstack/cinder
@@ -28,7 +31,7 @@ cinder_developer_constraints:
 
 # Name of the virtual env to deploy into
 cinder_venv_tag: untagged
-cinder_bin: "/openstack/venvs/cinder-{{ cinder_venv_tag }}/bin"
+cinder_bin: "{{ _cinder_bin }}"
 
 # venv_download, even when true, will use the fallback method of building the
 # venv from scratch if the venv download fails.
@@ -304,7 +307,7 @@ cinder_services:
     wsgi_name: cinder-wsgi
     uwsgi_port: "{{ cinder_service_port }}"
     uwsgi_bind_address: "{{ cinder_uwsgi_bind_address }}"
-    program_override: "{{ cinder_bin }}/uwsgi --autoload --ini /etc/uwsgi/cinder-api.ini"
+    program_override: "{{ _cinder_wsgi_bin }}/uwsgi --autoload --ini /etc/uwsgi/cinder-api.ini"
     start_order: 4
 
 # Cinder uWSGI settings

releasenotes/notes/openstack-distribution-packages-292a6cb46e3adc32.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    The role now supports using the distribution packages for the OpenStack
+    services instead of the pip ones. This feature is disabled by default
+    and can be enabled by simply setting the ``cinder_install_method``
+    variable to ``distro``.--

tasks/cinder_install.yml

@@ -24,112 +24,9 @@
   retries: 5
   delay: 2
 
-- name: Create developer mode constraint file
-  copy:
-    dest: "/opt/developer-pip-constraints.txt"
-    content: |
-      {% for item in cinder_developer_constraints %}
-      {{ item }}
-      {% endfor %}
-  when: cinder_developer_mode | bool
-
-- name: Install requires pip packages
-  pip:
-    name: "{{ cinder_requires_pip_packages }}"
-    state: "{{ cinder_pip_package_state }}"
-    extra_args: >-
-      {{ cinder_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|success
-  retries: 5
-  delay: 2
-
-- name: Retrieve checksum for venv download
-  uri:
-    url: "{{ cinder_venv_download_url | replace('tgz', 'checksum') }}"
-    return_content: yes
-  register: cinder_venv_checksum
-  when: cinder_venv_download | bool
-
-- name: Attempt venv download
-  get_url:
-    url: "{{ cinder_venv_download_url }}"
-    dest: "/var/cache/{{ cinder_venv_download_url | basename }}"
-    checksum: "sha1:{{ cinder_venv_checksum.content | trim }}"
-  register: cinder_get_venv
-  when: cinder_venv_download | bool
-
-- name: Remove existing venv
-  file:
-    path: "{{ cinder_bin | dirname }}"
-    state: absent
-  when: cinder_get_venv | changed
-
-- name: Create cinder venv dir
-  file:
-    path: "{{ cinder_bin | dirname }}"
-    state: directory
-  register: cinder_venv_dir
-  when: cinder_get_venv | changed
-
-- name: Unarchive pre-built venv
-  unarchive:
-    src: "/var/cache/{{ cinder_venv_download_url | basename }}"
-    dest: "{{ cinder_bin | dirname }}"
-    copy: "no"
-  when: cinder_get_venv | changed
-  notify:
-    - Manage LB
-    - Restart cinder services
-
-- name: Install pip packages
-  pip:
-    name: "{{ cinder_pip_packages }}"
-    state: "{{ cinder_pip_package_state }}"
-    virtualenv: "{{ cinder_bin | dirname }}"
-    virtualenv_site_packages: "no"
-    extra_args: >-
-      {{ cinder_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|success
-  retries: 5
-  delay: 2
-  when: cinder_get_venv | failed or cinder_get_venv | skipped
-  notify:
-    - Manage LB
-    - Restart cinder services
-
-- name: Remove python from path first (CentOS, openSUSE)
-  file:
-    path:  "{{ cinder_bin | dirname }}/bin/python2.7"
-    state: "absent"
-  when:
-    - ansible_pkg_mgr in ['yum', 'dnf', 'zypper']
-    - cinder_get_venv | changed
-
-# 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: Reset virtualenv and update its paths
-  shell: |
-    find {{ cinder_bin }} -name \*.pyc -delete
-    sed -si '1s/^.*python.*$/#!{{ cinder_bin | replace ('/','\/') }}\/python/' {{ cinder_bin }}/*
-    virtualenv {{ cinder_bin | dirname }} \
-        {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
-        --no-pip \
-        --no-setuptools \
-        --no-wheel
-  when: cinder_get_venv | changed
-  tags:
-    - skip_ansible_lint
+- name: Install cinder packages from PIP
+  include_tasks: cinder_install_source.yml
+  when: cinder_install_method == 'source'
 
 - name: Initialise the upgrade facts
   ini_file:
@@ -138,20 +35,18 @@
     option: "{{ item }}"
     value: "True"
   with_items:
-    - "need_online_data_migrations"
-    - "need_service_restart"
-  when: (cinder_get_venv | changed) or
-        (cinder_venv_dir | changed) or
+    - name: "need_online_data_migrations"
+      state: "True"
+    - name: "need_service_restart"
+      state: "True"
+    - name: "install_method"
+      state: "{{ cinder_install_method }}"
+  when: (cinder_install_method == 'source' and
+         ((cinder_get_venv | changed) or
+          (cinder_venv_dir | changed))) or
         (install_packages | changed) or
         (ansible_local is not defined) or
         ('openstack_ansible' not in ansible_local) or
         ('cinder' not in ansible_local['openstack_ansible']) or
         ('need_online_data_migrations' not in ansible_local['openstack_ansible']['cinder']) or
         ('need_service_restart' not in ansible_local['openstack_ansible']['cinder'])
-
-- name: Record the venv tag deployed
-  ini_file:
-    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
-    section: cinder
-    option: venv_tag
-    value: "{{ cinder_venv_tag }}"

tasks/cinder_install_source.yml

@@ -0,0 +1,128 @@
+---
+# Copyright 2014, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+- name: Create developer mode constraint file
+  copy:
+    dest: "/opt/developer-pip-constraints.txt"
+    content: |
+      {% for item in cinder_developer_constraints %}
+      {{ item }}
+      {% endfor %}
+  when: cinder_developer_mode | bool
+
+- name: Install requires pip packages
+  pip:
+    name: "{{ cinder_requires_pip_packages }}"
+    state: "{{ cinder_pip_package_state }}"
+    extra_args: >-
+      {{ cinder_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|success
+  retries: 5
+  delay: 2
+
+- name: Retrieve checksum for venv download
+  uri:
+    url: "{{ cinder_venv_download_url | replace('tgz', 'checksum') }}"
+    return_content: yes
+  register: cinder_venv_checksum
+  when: cinder_venv_download | bool
+
+- name: Attempt venv download
+  get_url:
+    url: "{{ cinder_venv_download_url }}"
+    dest: "/var/cache/{{ cinder_venv_download_url | basename }}"
+    checksum: "sha1:{{ cinder_venv_checksum.content | trim }}"
+  register: cinder_get_venv
+  when: cinder_venv_download | bool
+
+- name: Remove existing venv
+  file:
+    path: "{{ cinder_bin | dirname }}"
+    state: absent
+  when: cinder_get_venv | changed
+
+- name: Create cinder venv dir
+  file:
+    path: "{{ cinder_bin | dirname }}"
+    state: directory
+  register: cinder_venv_dir
+  when: cinder_get_venv | changed
+
+- name: Unarchive pre-built venv
+  unarchive:
+    src: "/var/cache/{{ cinder_venv_download_url | basename }}"
+    dest: "{{ cinder_bin | dirname }}"
+    copy: "no"
+  when: cinder_get_venv | changed
+  notify:
+    - Manage LB
+    - Restart cinder services
+
+- name: Install pip packages
+  pip:
+    name: "{{ cinder_pip_packages }}"
+    state: "{{ cinder_pip_package_state }}"
+    virtualenv: "{{ cinder_bin | dirname }}"
+    virtualenv_site_packages: "no"
+    extra_args: >-
+      {{ cinder_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|success
+  retries: 5
+  delay: 2
+  when: cinder_get_venv | failed or cinder_get_venv | skipped
+  notify:
+    - Manage LB
+    - Restart cinder services
+
+- name: Remove python from path first (CentOS, openSUSE)
+  file:
+    path:  "{{ cinder_bin | dirname }}/bin/python2.7"
+    state: "absent"
+  when:
+    - ansible_pkg_mgr in ['yum', 'dnf', 'zypper']
+    - cinder_get_venv | changed
+
+# 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: Reset virtualenv and update its paths
+  shell: |
+    find {{ cinder_bin }} -name \*.pyc -delete
+    sed -si '1s/^.*python.*$/#!{{ cinder_bin | replace ('/','\/') }}\/python/' {{ cinder_bin }}/*
+    virtualenv {{ cinder_bin | dirname }} \
+        {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
+        --no-pip \
+        --no-setuptools \
+        --no-wheel
+  when: cinder_get_venv | changed
+  tags:
+    - skip_ansible_lint
+
+- name: Record the venv tag deployed
+  ini_file:
+    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
+    section: cinder
+    option: venv_tag
+    value: "{{ cinder_venv_tag }}"

tasks/main.yml

@@ -25,6 +25,21 @@
   tags:
     - always
 
+- name: Fail if service was deployed using a different installation method
+  fail:
+    msg: "Switching installation methods for OpenStack services is not supported"
+  when:
+    - ansible_local is defined
+    - ansible_local.openstack_ansible is defined
+    - ansible_local.openstack_ansible.cinder is defined
+    - ansible_local.openstack_ansible.cinder.install_method is defined
+    - ansible_local.openstack_ansible.cinder.install_method != cinder_install_method
+
+- name: Gather variables for installation method
+  include_vars: "{{ cinder_install_method }}_install.yml"
+  tags:
+    - always
+
 - include: cinder_pre_install.yml
   tags:
     - cinder-install

templates/cinder-uwsgi.ini.j2

@@ -2,7 +2,9 @@
 uid = {{ cinder_system_user_name }}
 gid = {{ cinder_system_group_name }}
 
+{% if cinder_install_method == 'source' %}
 virtualenv = /openstack/venvs/cinder-{{ cinder_venv_tag }}
+{% endif %}
 wsgi-file = {{ cinder_bin }}/{{ item.wsgi_name }}
 http = {{ item.uwsgi_bind_address }}:{{ item.uwsgi_port }}
 

tox.ini

@@ -101,6 +101,14 @@ deps =
 commands =
     bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
 
+[testenv:distro_install]
+deps =
+    {[testenv:ansible]deps}
+setenv =
+    {[testenv]setenv}
+    ANSIBLE_PARAMETERS=-e cinder_install_method=distro
+commands =
+    bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"
 
 [testenv:upgrade]
 deps =

vars/distro_install.yml

@@ -0,0 +1,36 @@
+---
+# Copyright 2018, SUSE Linux GmbH.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+# Compile a list of the distro packages to install based on
+# whether the host is in the host group and the service is
+# enabled.
+#
+cinder_package_list: |-
+  {% set packages = cinder_distro_packages %}
+  {% if cinder_services['cinder-volume']['group'] in group_names %}
+  {%   set _ = packages.extend(cinder_volume_distro_packages) %}
+  {%   if cinder_backend_lvm_inuse | bool %}
+  {%     set _ = packages.extend(cinder_lvm_volume_distro_packages) %}
+  {%   endif %}
+  {% endif %}
+  {% if cinder_developer_mode | bool %}
+  {%   set _ = packages.extend(cinder_developer_mode_distro_packages) %}
+  {% endif %}
+  {% set _ = packages.extend(cinder_service_distro_packages) %}
+  {{ packages }}
+
+_cinder_bin: "/usr/bin"
+_cinder_wsgi_bin: "{{ cinder_wsgi_bin }}"

vars/main.yml

@@ -13,24 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-#
-# Compile a list of the distro packages to install based on
-# whether the host is in the host group and the service is
-# enabled.
-#
-cinder_package_list: |-
-  {% set packages = cinder_distro_packages %}
-  {% if cinder_services['cinder-volume']['group'] in group_names %}
-  {%   set _ = packages.extend(cinder_volume_distro_packages) %}
-  {%   if cinder_backend_lvm_inuse | bool %}
-  {%     set _ = packages.extend(cinder_lvm_volume_distro_packages) %}
-  {%   endif %}
-  {% endif %}
-  {% if cinder_developer_mode | bool %}
-  {%   set _ = packages.extend(cinder_developer_mode_distro_packages) %}
-  {% endif %}
-  {{ packages }}
-
 #
 # Compile a list of the services on a host based on whether
 # the host is in the host group and the service is enabled.

vars/redhat-7.yml

@@ -28,6 +28,13 @@ cinder_distro_packages:
   - which
   - iscsi-initiator-utils
 
+cinder_service_distro_packages:
+  - openstack-cinder
+  - python-cinderclient
+  - python2-shade
+  - uwsgi
+  - uwsgi-plugin-python
+
 cinder_developer_mode_distro_packages:
   - git
 
@@ -39,3 +46,5 @@ cinder_lvm_volume_distro_packages:
   - lvm2
   - parted
   - scsi-target-utils
+
+cinder_wsgi_bin: '/usr/sbin'

vars/source_install.yml

@@ -0,0 +1,35 @@
+---
+# Copyright 2017, Rackspace US, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+# Compile a list of the distro packages to install based on
+# whether the host is in the host group and the service is
+# enabled.
+#
+cinder_package_list: |-
+  {% set packages = cinder_distro_packages %}
+  {% if cinder_services['cinder-volume']['group'] in group_names %}
+  {%   set _ = packages.extend(cinder_volume_distro_packages) %}
+  {%   if cinder_backend_lvm_inuse | bool %}
+  {%     set _ = packages.extend(cinder_lvm_volume_distro_packages) %}
+  {%   endif %}
+  {% endif %}
+  {% if cinder_developer_mode | bool %}
+  {%   set _ = packages.extend(cinder_developer_mode_distro_packages) %}
+  {% endif %}
+  {{ packages }}
+
+_cinder_bin: "/openstack/venvs/cinder-{{ cinder_venv_tag }}/bin"
+_cinder_wsgi_bin: "{{ _cinder_bin }}"

vars/suse-42.yml

@@ -29,6 +29,17 @@ cinder_distro_packages:
   - which
   - open-iscsi
 
+cinder_service_distro_packages:
+  - openstack-cinder
+  - openstack-cinder-api
+  - openstack-cinder-backup
+  - openstack-cinder-scheduler
+  - openstack-cinder-volume
+  - python-cinderclient
+  - python-shade
+  - uwsgi
+  - uwsgi-python
+
 cinder_developer_mode_distro_packages:
   - git-core
 
@@ -40,3 +51,5 @@ cinder_lvm_volume_distro_packages:
   - lvm2
   - parted
   - tgt
+
+cinder_wsgi_bin: '/usr/sbin'

vars/ubuntu-16.04.yml

@@ -35,6 +35,16 @@ cinder_distro_packages:
   - zlib1g
   - zlibc
 
+cinder_service_distro_packages:
+  - cinder-api
+  - cinder-backup
+  - cinder-scheduler
+  - cinder-volume
+  - python-cinderclient
+  - python-shade
+  - uwsgi
+  - uwsgi-plugin-python
+
 cinder_developer_mode_distro_packages:
   - git-core
 
@@ -47,3 +57,5 @@ cinder_lvm_volume_distro_packages:
   - parted
   - tgt
   - thin-provisioning-tools
+
+cinder_wsgi_bin: '/usr/bin'

zuul.d/project.yaml

@@ -21,6 +21,9 @@
         - openstack-ansible-functional-ubuntu-xenial
         - openstack-ansible-upgrade-ubuntu-xenial
         - openstack-ansible-cinder-ssl-nv
+        - openstack-ansible-functional-distro_install-ubuntu-xenial
+        - openstack-ansible-functional-distro_install-centos-7
+        - openstack-ansible-functional-distro_install-opensuse-423
     experimental:
       jobs:
         - openstack-ansible-integrated-deploy-aio