Implement ceilometer venv support

This commit conditionally allows the os_ceilometer role to
install build and deploy within a venv. This is the new
default behavior of the role however the functionality
can be disabled.

Change-Id: Ic12d0cb2151124fc5150170205d5d226dab53e5b
Implements: blueprint enable-venv-support-within-the-roles
Signed-off-by: Kevin Carter <kevin.carter@rackspace.com>

defaults/main.yml

@@ -20,6 +20,18 @@ is_metal: true
 debug: False
 verbose: True
 
+# Name of the virtual env to deploy into
+ceilometer_venv_tag: untagged
+ceilometer_venv_bin: "/openstack/venvs/ceilometer-{{ ceilometer_venv_tag }}/bin"
+
+# Set this to enable or disable installing in a venv
+ceilometer_venv_enabled: true
+
+# The bin path defaults to the venv path however if installation in a
+#  venv is disabled the bin path will be dynamically set based on the
+#  system path used when the installing.
+ceilometer_bin: "{{ ceilometer_venv_bin }}"
+
 ## System info
 ceilometer_system_user_name: ceilometer
 ceilometer_system_group_name: ceilometer
@@ -78,6 +90,11 @@ ceilometer_apt_packages:
   - rsync
   - git
 
+# ceilometer packages that must be installed before anything else
+ceilometer_requires_pip_packages:
+  - virtualenv
+  - python-keystoneclient # Keystoneclient needed to OSA keystone lib
+
 # Common pip packages
 ceilometer_pip_packages:
   - ceilometer

tasks/ceilometer_install.yml

@@ -25,10 +25,43 @@
   delay: 2
   with_items: ceilometer_apt_packages
   tags:
+    - ceilometer-install
     - ceilometer-apt-packages
 
+- name: Install requires pip packages
+  pip:
+    name: "{{ item }}"
+    state: present
+    extra_args: "{{ pip_install_options|default('') }}"
+  register: install_packages
+  until: install_packages|success
+  retries: 5
+  delay: 2
+  with_items:
+    - "{{ ceilometer_requires_pip_packages }}"
+  tags:
+    - ceilometer-install
+    - ceilometer-pip-packages
 
-- name: Install pip packages
+- name: Install pip packages (venv)
+  pip:
+    name: "{{ item }}"
+    state: present
+    virtualenv: "{{ ceilometer_venv_bin | dirname }}"
+    virtualenv_site_packages: "no"
+    extra_args: "{{ pip_install_options|default('') }}"
+  register: install_packages
+  until: install_packages|success
+  retries: 5
+  delay: 2
+  with_items:
+    - "{{ ceilometer_pip_packages }}"
+  when: ceilometer_venv_enabled | bool
+  tags:
+    - ceilometer-install
+    - ceilometer-pip-packages
+
+- name: Install pip packages (no venv)
   pip:
     name: "{{ item }}"
     state: present
@@ -39,5 +72,7 @@
   delay: 2
   with_items:
     - "{{ ceilometer_pip_packages }}"
+  when: not ceilometer_venv_enabled | bool
   tags:
+    - ceilometer-install
     - ceilometer-pip-packages

tasks/ceilometer_post_install.yml

@@ -52,3 +52,18 @@
     - ceilometer-config
     - ceilometer-post-install
 
+- name: Get ceilometer command path
+  command: which ceilometer
+  register: ceilometer_command_path
+  when:
+    - not ceilometer_venv_enabled | bool
+  tags:
+    - ceilometer-command-bin
+
+- name: Set ceilometer command path
+  set_fact:
+    ceilometer_bin: "{{ ceilometer_command_path.stdout | dirname }}"
+  when:
+    - not ceilometer_venv_enabled | bool
+  tags:
+    - ceilometer-command-bin

tasks/ceilometer_pre_install.yml

@@ -54,6 +54,7 @@
     group: "{{ item.group|default(ceilometer_system_group_name) }}"
     mode: "{{ item.mode|default('0755') }}"
   with_items:
+    - { path: "/openstack", mode: "0755", owner: "root", group: "root" }
     - { path: "/etc/ceilometer" }
     - { path: "{{ ceilometer_system_user_home }}" }
     - { path: "{{ ceilometer_system_user_home }}/.ssh", mode: "0700" }
@@ -61,6 +62,19 @@
   tags:
     - ceilometer-dirs
 
+- name: Create ceilometer venv dir
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    owner: "{{ item.owner|default(ceilometer_system_user_name) }}"
+    group: "{{ item.group|default(ceilometer_system_group_name) }}"
+  with_items:
+    - { path: "/openstack/venvs", mode: "0755", owner: "root", group: "root" }
+    - { path: "{{ ceilometer_venv_bin }}" }
+  when: ceilometer_venv_enabled | bool
+  tags:
+    - ceilometer-dirs
+
 - name: Test for log directory or link
   shell: |
     if [ -h "/var/log/ceilometer"  ]; then
@@ -90,17 +104,6 @@
     - ceilometer-dirs
     - ceilometer-logs
 
-- name: Drop sudoers file
-  template:
-    src: "sudoers.j2"
-    dest: "/etc/sudoers.d/{{ ceilometer_system_user_name }}_sudoers"
-    mode: "0440"
-    owner: "root"
-    group: "root"
-  tags:
-    - sudoers
-    - ceilometer-sudoers
-
 - include: ceilometer_messaging_setup.yml
   when: >
     inventory_hostname == groups['ceilometer_api'][0]

tasks/ceilometer_upstart_common_init.yml

@@ -1,3 +1,18 @@
+---
+# Copyright 2015, 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: Place the init script
   template:
     src: "ceilometer-upstart-init.j2"

templates/ceilometer-upstart-init.j2

@@ -12,7 +12,7 @@ respawn
 respawn limit 10 5
 
 # Set the RUNBIN environment variable
-env RUNBIN="/usr/local/bin/{{ program_name }}"
+env RUNBIN="{{ ceilometer_bin }}/{{ program_name }}"
 
 # Change directory to service users home
 chdir "{{ service_home }}"
@@ -24,6 +24,11 @@ pre-start script
 
   mkdir -p "/var/lock/{{ program_name }}"
   chown {{ system_user }}:{{ system_group }} "/var/lock/{{ program_name }}"
+
+  {% if ceilometer_venv_enabled | bool -%}
+  . {{ ceilometer_venv_bin }}/activate
+  {%- endif %}
+
 end script
 
 # Post stop actions

templates/sudoers.j2

@@ -1,3 +0,0 @@
-# {{ ansible_managed }}
-# Defaults:{{ ceilometer_system_user_name }}!requiretty
-{{ ceilometer_system_user_name }} ALL = (root) NOPASSWD: /usr/local/bin/{{ ceilometer_service_name }}-rootwrap