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: I3edabacc3978cd42988a6c0c04a011c22159b9fa
Implements: blueprint openstack-distribution-packages

defaults/main.yml

@@ -21,6 +21,9 @@ debug: False
 ceilometer_package_state: "latest"
 ceilometer_pip_package_state: "latest"
 
+# Set installation method.
+ceilometer_install_method: "source"
+
 ## Toggle developer mode
 ceilometer_developer_mode: false
 
@@ -34,7 +37,7 @@ ceilometer_developer_constraints:
 
 # Name of the virtual env to deploy into
 ceilometer_venv_tag: untagged
-ceilometer_bin: "/openstack/venvs/ceilometer-{{ ceilometer_venv_tag }}/bin"
+ceilometer_bin: "{{ _ceilometer_bin }}"
 
 # venv_download, even when true, will use the fallback method of building the
 # venv from scratch if the venv download fails.

releasenotes/notes/openstack-distribution-packages-c6dc58c949068713.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 ``ceilometer_install_method``
+    variable to ``distro``.

tasks/ceilometer_install.yml

@@ -13,9 +13,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+- name: Record the installation method
+  ini_file:
+    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
+    section: "ceilometer"
+    option: "install_method"
+    value: "{{ ceilometer_install_method }}"
+
+- name: Refresh local facts to ensure the ceilometer section is present
+  setup:
+    filter: ansible_local
+    gather_subset: "!all"
+
 - name: Install distro packages
   package:
-    name: "{{ item }}"
+    name: "{{ ceilometer_package_list }}"
     state: "{{ ceilometer_package_state }}"
     update_cache: "{{ (ansible_pkg_mgr in ['apt', 'zypper']) | ternary('yes', omit) }}"
     cache_valid_time: "{{ (ansible_pkg_mgr == 'apt') | ternary(cache_timeout, omit) }}"
@@ -23,7 +35,6 @@
   until: install_packages|success
   retries: 5
   delay: 2
-  with_items: "{{ ceilometer_distro_packages }}"
 
 - name: Install distro packages required in Developer Mode
   package:
@@ -39,114 +50,7 @@
   when:
     - ceilometer_developer_mode | bool
 
-- name: Create developer mode constraint file
-  copy:
-    dest: "/opt/developer-pip-constraints.txt"
-    content: |
-      {% for item in ceilometer_developer_constraints %}
-      {{ item }}
-      {% endfor %}
-  when:
-    - ceilometer_developer_mode | bool
+- name: Install ceilometer packages from PIP
+  include_tasks: ceilometer_install_source.yml
+  when: ceilometer_install_method == 'source'
 
-- name: Install requires pip packages
-  pip:
-    name: "{{ ceilometer_requires_pip_packages }}"
-    state: "{{ ceilometer_pip_package_state }}"
-    extra_args: >-
-      {{ ceilometer_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: "{{ ceilometer_venv_download_url | replace('tgz', 'checksum') }}"
-    return_content: yes
-  register: ceilometer_venv_checksum
-  when: ceilometer_venv_download | bool
-
-- name: Attempt venv download
-  get_url:
-    url: "{{ ceilometer_venv_download_url }}"
-    dest: "/var/cache/{{ ceilometer_venv_download_url | basename }}"
-    checksum: "sha1:{{ ceilometer_venv_checksum.content | trim }}"
-  register: ceilometer_get_venv
-  when: ceilometer_venv_download | bool
-
-- name: Remove existing venv
-  file:
-    path: "{{ ceilometer_bin | dirname }}"
-    state: absent
-  when: ceilometer_get_venv | changed
-
-- name: Create ceilometer venv dir
-  file:
-    path: "{{ ceilometer_bin | dirname }}"
-    state: directory
-  register: ceilometer_venv_dir
-  when: ceilometer_get_venv | changed
-
-- name: Unarchive pre-built venv
-  unarchive:
-    src: "/var/cache/{{ ceilometer_venv_download_url | basename }}"
-    dest: "{{ ceilometer_bin | dirname }}"
-    copy: "no"
-  when: ceilometer_get_venv | changed
-  notify: Restart ceilometer services
-
-- name: Install pip packages
-  pip:
-    name: "{{ ceilometer_pip_packages }}"
-    state: "{{ ceilometer_pip_package_state }}"
-    virtualenv: "{{ ceilometer_bin | dirname }}"
-    virtualenv_site_packages: "no"
-    extra_args: >-
-      {{ ceilometer_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
-      {{ ceilometer_developer_mode | ternary('--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: ceilometer_get_venv | failed or ceilometer_get_venv | skipped
-  notify: Restart ceilometer services
-
-- name: Remove python from path first (CentOS, openSUSE)
-  file:
-    path:  "{{ ceilometer_bin | dirname }}/bin/python2.7"
-    state: "absent"
-  when:
-    - ansible_pkg_mgr in ['yum', 'dnf', 'zypper']
-    - ceilometer_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: Update virtualenv path
-  shell: |
-    find {{ ceilometer_bin }} -name \*.pyc -delete
-    sed -si '1s/^.*python.*$/#!{{ ceilometer_bin | replace ('/','\/') }}\/python/' {{ ceilometer_bin }}/*
-    virtualenv {{ ceilometer_bin | dirname }} \
-        {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
-        --no-pip \
-        --no-setuptools \
-        --no-wheel
-  when: ceilometer_get_venv | changed
-  tags:
-    - skip_ansible_lint
-
-- name: Record the venv tag deployed
-  ini_file:
-    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
-    section: ceilometer
-    option: venv_tag
-    value: "{{ ceilometer_venv_tag }}"

tasks/ceilometer_install_source.yml

@@ -0,0 +1,126 @@
+---
+# 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.
+
+- name: Create developer mode constraint file
+  copy:
+    dest: "/opt/developer-pip-constraints.txt"
+    content: |
+      {% for item in ceilometer_developer_constraints %}
+      {{ item }}
+      {% endfor %}
+  when:
+    - ceilometer_developer_mode | bool
+
+- name: Install requires pip packages
+  pip:
+    name: "{{ ceilometer_requires_pip_packages }}"
+    state: "{{ ceilometer_pip_package_state }}"
+    extra_args: >-
+      {{ ceilometer_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: "{{ ceilometer_venv_download_url | replace('tgz', 'checksum') }}"
+    return_content: yes
+  register: ceilometer_venv_checksum
+  when: ceilometer_venv_download | bool
+
+- name: Attempt venv download
+  get_url:
+    url: "{{ ceilometer_venv_download_url }}"
+    dest: "/var/cache/{{ ceilometer_venv_download_url | basename }}"
+    checksum: "sha1:{{ ceilometer_venv_checksum.content | trim }}"
+  register: ceilometer_get_venv
+  when: ceilometer_venv_download | bool
+
+- name: Remove existing venv
+  file:
+    path: "{{ ceilometer_bin | dirname }}"
+    state: absent
+  when: ceilometer_get_venv | changed
+
+- name: Create ceilometer venv dir
+  file:
+    path: "{{ ceilometer_bin | dirname }}"
+    state: directory
+  register: ceilometer_venv_dir
+  when: ceilometer_get_venv | changed
+
+- name: Unarchive pre-built venv
+  unarchive:
+    src: "/var/cache/{{ ceilometer_venv_download_url | basename }}"
+    dest: "{{ ceilometer_bin | dirname }}"
+    copy: "no"
+  when: ceilometer_get_venv | changed
+  notify: Restart ceilometer services
+
+- name: Install pip packages
+  pip:
+    name: "{{ ceilometer_pip_packages }}"
+    state: "{{ ceilometer_pip_package_state }}"
+    virtualenv: "{{ ceilometer_bin | dirname }}"
+    virtualenv_site_packages: "no"
+    extra_args: >-
+      {{ ceilometer_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
+      {{ ceilometer_developer_mode | ternary('--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: ceilometer_get_venv | failed or ceilometer_get_venv | skipped
+  notify: Restart ceilometer services
+
+- name: Remove python from path first (CentOS, openSUSE)
+  file:
+    path:  "{{ ceilometer_bin | dirname }}/bin/python2.7"
+    state: "absent"
+  when:
+    - ansible_pkg_mgr in ['yum', 'dnf', 'zypper']
+    - ceilometer_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: Update virtualenv path
+  shell: |
+    find {{ ceilometer_bin }} -name \*.pyc -delete
+    sed -si '1s/^.*python.*$/#!{{ ceilometer_bin | replace ('/','\/') }}\/python/' {{ ceilometer_bin }}/*
+    virtualenv {{ ceilometer_bin | dirname }} \
+        {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
+        --no-pip \
+        --no-setuptools \
+        --no-wheel
+  when: ceilometer_get_venv | changed
+  tags:
+    - skip_ansible_lint
+
+- name: Record the venv tag deployed
+  ini_file:
+    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
+    section: ceilometer
+    option: venv_tag
+    value: "{{ ceilometer_venv_tag }}"

tasks/main.yml

@@ -32,6 +32,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.ceilometer is defined
+    - ansible_local.openstack_ansible.ceilometer.install_method is defined
+    - ansible_local.openstack_ansible.ceilometer.install_method != ceilometer_install_method
+
+- name: Gather variables for installation method
+  include_vars: "{{ ceilometer_install_method }}_install.yml"
+  tags:
+    - always
+
 - include: ceilometer_pre_install.yml
   tags:
     - ceilometer-install

tox.ini

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

vars/distro_install.yml

@@ -0,0 +1,18 @@
+---
+# 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.
+
+ceilometer_package_list: "{{ ceilometer_service_distro_packages }}"
+
+_ceilometer_bin: "/usr/bin"

vars/redhat-7.yml

@@ -19,6 +19,13 @@ ceilometer_distro_packages:
   - rsync
   - which
 
+ceilometer_service_distro_packages:
+  - openstack-ceilometer-central
+  - openstack-ceilometer-compute
+  - openstack-ceilometer-ipmi
+  - openstack-ceilometer-notification
+  - openstack-ceilometer-polling
+
 # Packages required in developer mode, where packages are built locally
 ceilometer_developer_mode_distro_packages:
   - libvirt-devel

vars/source_install.yml

@@ -0,0 +1,18 @@
+---
+# 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.
+
+ceilometer_package_list: "{{ ceilometer_distro_packages }}"
+
+_ceilometer_bin: "/openstack/venvs/ceilometer-{{ ceilometer_venv_tag }}/bin"

vars/suse-42.yml

@@ -20,6 +20,14 @@ ceilometer_distro_packages:
   - rsync
   - which
 
+ceilometer_service_distro_packages:
+  - openstack-ceilometer
+  - openstack-ceilometer-agent-central
+  - openstack-ceilometer-agent-compute
+  - openstack-ceilometer-agent-ipmi
+  - openstack-ceilometer-agent-notification
+  - openstack-ceilometer-polling
+
 # Packages required in developer mode, where packages are built locally
 ceilometer_developer_mode_distro_packages:
   - libvirt-devel

vars/ubuntu-16.04.yml

@@ -22,6 +22,11 @@ ceilometer_distro_packages:
   - rpcbind
   - rsync
 
+ceilometer_service_distro_packages:
+  - ceilometer-agent-central
+  - ceilometer-agent-compute
+  - ceilometer-polling
+
 # Packages required in developer mode, where packages are built locally
 ceilometer_developer_mode_distro_packages:
   - libvirt-dev

zuul.d/project.yaml

@@ -19,6 +19,11 @@
         - openstack-ansible-functional-centos-7-nv
         - openstack-ansible-functional-opensuse-423-nv
         - openstack-ansible-functional-ubuntu-xenial
+        - openstack-ansible-functional-distro_install-ubuntu-xenial
+          # NOTE(hwoarang) Centos7 is having some troubles with repo dependencies
+          # so disabling until it's investigated.
+        - openstack-ansible-functional-distro_install-centos-7-nv
+        - openstack-ansible-functional-distro_install-opensuse-423
     experimental:
       jobs:
         - openstack-ansible-integrated-deploy-aio
@@ -26,3 +31,5 @@
       jobs:
         - openstack-ansible-linters
         - openstack-ansible-functional-ubuntu-xenial
+        - openstack-ansible-functional-distro_install-ubuntu-xenial
+        - openstack-ansible-functional-distro_install-opensuse-423