From c9139b0b3ad983b16f36a2be23ddf16463c27c2e Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Fri, 9 Mar 2018 17:50:21 +0000 Subject: [PATCH] Initial commit --- .gitignore | 71 ++++++++++++++++ LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++ README.rst | 20 +++++ defaults/main.yml | 52 ++++++++++++ handlers/main.yml | 22 +++++ meta/main.yml | 38 +++++++++ tasks/main.yml | 210 ++++++++++++++++++++++++++++++++++++++++++++++ tests/inventory | 2 + tests/test.yml | 5 ++ 9 files changed, 622 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 defaults/main.yml create mode 100644 handlers/main.yml create mode 100644 meta/main.yml create mode 100644 tasks/main.yml create mode 100644 tests/inventory create mode 100644 tests/test.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5421f90 --- /dev/null +++ b/.gitignore @@ -0,0 +1,71 @@ +# Compiled source # +################### +*.com +*.class +*.dll +*.exe +*.o +*.so +*.pyc +build/ +dist/ +doc/build/ + +# Packages # +############ +# it's better to unpack these files and commit the raw source +# git has its own built in compression methods +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip + +# Logs and databases # +###################### +*.log +*.sql +*.sqlite +logs/* + +# OS generated files # +###################### +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +.idea +.tox +*.sublime* +*.egg-info +Icon? +ehthumbs.db +Thumbs.db +.eggs + +# User driven backup files # +############################ +*.bak +*.swp + +# Generated by pbr while building docs +###################################### +AUTHORS +ChangeLog + +# Files created by releasenotes build +releasenotes/build + +# Test temp files +tests/common +tests/*.retry + +# Vagrant artifacts +.vagrant + +# Git clones +openstack-ansible-ops diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e06d208 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + 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. + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b49fb27 --- /dev/null +++ b/README.rst @@ -0,0 +1,20 @@ +======================== +Team and repository tags +======================== + +.. image:: https://governance.openstack.org/tc/badges/openstack-ansible-python_venv_build.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html + +.. Change things from this point on + +=================================== +OpenStack-Ansible python_venv_build +=================================== + +This Ansible role prepares a python venv for use in OpenStack-Ansible. + +Documentation for the project can be found at: + https://docs.openstack.org/openstack-ansible-python_venv_build/latest/ + +The project home is at: + http://launchpad.net/openstack-ansible diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100644 index 0000000..733ab48 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,52 @@ +--- +# Copyright 2018, 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. + +# The list of distribution packages to install +distro_package_list: [] + +# Set the package install state for packages +# Options are 'present' and 'latest' +distro_package_state: "latest" + +# The time in seconds that the distribution package +# cache is valid for. This is only used by the apt +# package manager +distro_cache_valid_time: 600 + +# Python packages which must be installed +# on to the host +host_pip_packages: [] + +# Python packages which must be installed +# into the venv +venv_pip_packages: [] + +# General pip install constraints +pip_install_constraints: "" + +# Specific constraints for the venv +pip_install_venv_constraints: "" + +# General pip install extra options +# This is especially useful for proxy options +pip_install_options: "" + +# The path where venvs are stored on the +# deployment host +venv_download_path: "/opt/cache/files" + +# The path where venvs are extracted to +# on the target host, for example: +# venv_destination_path: "/openstack/venvs/myvenv" diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100644 index 0000000..c64ed45 --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,22 @@ +--- +# Copyright 2018, 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. + +- meta: noop + listen: Manage LB + when: false + +- meta: noop + listen: Restart services + when: false diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..e4ab703 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,38 @@ +--- +# Copyright 2018, 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. + +galaxy_info: + author: openstack-ansible + description: Python venv preparation + company: OpenStack + license: Apache2 + min_ansible_version: 2.4 + platforms: + - name: Ubuntu + versions: + - xenial + - name: EL + versions: + - 7 + - name: opensuse + versions: + - 42.1 + - 42.2 + - 42.3 + categories: + - cloud + - python + - development +dependencies: [] diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100644 index 0000000..97f5cbf --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,210 @@ +--- +# Copyright 2018, 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. + +# TODO(odyssey4me): +# 1. Cater for Logan's model where we must just extract +# over the existing folder without wiping it out first. +# 2. Also, wiping the directory out from under it probably +# wrecks the service while it's running. We should figure +# out a better way of atomically replacing the venv without +# ripping the folder out from under it. + +- name: Install distro packages + package: + name: "{{ distro_package_list }}" + state: "{{ distro_package_state }}" + update_cache: "{{ (ansible_pkg_mgr in ['apt', 'zypper']) | ternary('yes', omit) }}" + cache_valid_time: "{{ (ansible_pkg_mgr == 'apt') | ternary(distro_cache_valid_time, omit) }}" + register: _install_distro_packages + until: _install_distro_packages | success + retries: 5 + delay: 2 + +- name: Install required pip packages on the host + pip: + name: "{{ host_pip_packages }}" + state: latest + extra_args: >- + {{ pip_install_constraints }} + {{ pip_install_options }} + register: _install_host_pip_packages + until: _install_host_pip_packages | success + retries: 5 + delay: 2 + +- name: Ensure that venv_download_path exists on the deployment host + file: + path: "{{ venv_download_path }}/{{ venv_destination_path | dirname }}" + state: directory + delegate_to: localhost + run_once: yes + +- name: Check if venv is present on the deployment host + stat: + path: "{{ venv_download_path }}/{{ venv_destination_path }}.tgz" + get_attributes: no + get_checksum: no + get_md5: no + get_mime: no + register: _venv_tgz + delegate_to: localhost + run_once: yes + +- name: Copy the venv checksum file to the target host + copy: + src: "{{ venv_download_path }}/{{ venv_destination_path }}.checksum" + dest: "{{ venv_destination_path | dirname }}" + register: _venv_checksum_copy + when: + - _venv_tgz.stat.exists | bool + +# TODO(odyssey4me): +# 1. Cater for Logan's model where we must just extract +# over the existing folder without wiping it out first. +# 2. Also, removing it like this probably wrecks the service +# while it's running. We should figure out a better way +# of atomically replacing the venv without ripping the +# folder out from under it. + +# Due to our Ansible strategy, a skipped task does not have +# a dictionary result. As such we validate that the register +# is a mapping (dict). +- name: Remove existing venv on target host if it is changing + file: + path: "{{ venv_destination_path }}" + state: absent + when: + - _venv_checksum_copy is mapping + - _venv_checksum_copy | changed + +- name: Create venv directory on the target host + file: + path: "{{ venv_destination_path }}" + state: directory + register: _create_venv_dir + +# Due to our Ansible strategy, a skipped task does not have +# a dictionary result. As such we validate that the register +# is a mapping (dict). +- name: Unarchive pre-built venv + unarchive: + src: "{{ venv_download_path }}/{{ venv_destination_path }}.tgz" + dest: "{{ venv_destination_path }}" + remote_src: no + when: + - _venv_checksum_copy is mapping + - _venv_checksum_copy | changed + notify: + - Manage LB + - Restart services + +#TODO(odyssey4me): +# Split the venv build into multiple parts: +# 1. Create the venv without pip, setuptools, wheel +# 2. Use get-pip.py to install the right versions +# of pip, setuptools, wheel into the venv +# 3. Install the packages into the venv + +- name: Build venv + pip: + name: "{{ venv_pip_packages }}" + state: latest + virtualenv: "{{ venv_destination_path }}" + virtualenv_site_packages: "no" + extra_args: >- + {{ pip_install_venv_constraints }} + {{ pip_install_constraints }} + {{ pip_install_options }} + register: _install_venv_pip_packages + until: _install_venv_pip_packages | success + retries: 5 + delay: 2 + when: + - not _venv_tgz.stat.exists | bool + notify: + - Manage LB + - Restart services + +# Due to our Ansible strategy, a skipped task does not have +# a dictionary result. As such we validate that the register +# is a mapping (dict). +- name: Update virtualenv python and paths + shell: | + sed -si '1s/^.*python.*$/#!{{ (venv_destination_path ~ '/bin') | replace ('/','\/') }}\/python/' {{ venv_destination_path }}/bin/* + virtualenv {{ venv_destination_path }} + when: + - _venv_checksum_copy is mapping + - _venv_checksum_copy | changed + tags: + - skip_ansible_lint + +# Due to our Ansible strategy, a skipped task does not have +# a dictionary result. As such we validate that the register +# is a mapping (dict). +- name: Clean up the virtualenv before packaging + shell: | + find {{ venv_destination_path }}/bin -type f -name '*.pyc' -delete + when: + - _install_venv_pip_packages is mapping + - _install_venv_pip_packages | changed + +# Note(odyssey4me): +# We purposefully use shel instead of the archive module +# here. The archive module's output is far too verbose to +# be practical when debugging. +# +# Due to our Ansible strategy, a skipped task does not have +# a dictionary result. As such we validate that the register +# is a mapping (dict). +- name: Package venv + shell: | + tar czf '{{ venv_destination_path }}.tgz' -C '{{ venv_destination_path }}' . + args: + chdir: "{{ venv_destination_path }}" + executable: /bin/bash + warn: no + register: _venv_package_build + when: + - _install_venv_pip_packages is mapping + - _install_venv_pip_packages | changed + +# Due to our Ansible strategy, a skipped task does not have +# a dictionary result. As such we validate that the register +# is a mapping (dict). +- name: Prepare checksum for packaged venv + shell: | + sha1sum '{{ venv_destination_path }}.tgz' | awk '{print $1}' > '{{ venv_destination_path }}.checksum' + args: + executable: /bin/bash + when: + - _venv_package_build is mapping + - _venv_package_build | changed + +# Due to our Ansible strategy, a skipped task does not have +# a dictionary result. As such we validate that the register +# is a mapping (dict). +- name: Copy the packaged venv and checksum file to the deployment host + fetch: + src: "{{ item.src }}" + dest: "{{ item.dest }}" + flat: yes + with_items: + - src: "{{ venv_destination_path }}.tgz" + dest: "{{ venv_download_path }}/{{ venv_destination_path }}.tgz" + - src: "{{ venv_destination_path }}.checksum" + dest: "{{ venv_download_path }}/{{ venv_destination_path }}.checksum" + when: + - _venv_package_build is mapping + - _venv_package_build | changed diff --git a/tests/inventory b/tests/inventory new file mode 100644 index 0000000..878877b --- /dev/null +++ b/tests/inventory @@ -0,0 +1,2 @@ +localhost + diff --git a/tests/test.yml b/tests/test.yml new file mode 100644 index 0000000..4eb2a08 --- /dev/null +++ b/tests/test.yml @@ -0,0 +1,5 @@ +--- +- hosts: localhost + remote_user: root + roles: + - python_venv_build \ No newline at end of file