From 2889d8d44311ed3e68a5064bac67a9be726e42f4 Mon Sep 17 00:00:00 2001 From: Mike Heald Date: Wed, 25 Mar 2015 16:16:53 +0000 Subject: [PATCH] Initial import of puppet-bandersnatch module Module based on the existing bandersnatch manifests. Change-Id: Ida13ff6ffa3505c48330e35bcf04ad459d975d9b --- LICENSE | 202 ++++++++++++++++++++++++++++++++ README.md | 5 + Rakefile | 8 ++ files/robots.txt | 2 + files/run_bandersnatch.py | 51 ++++++++ manifests/init.pp | 54 +++++++++ manifests/mirror.pp | 73 ++++++++++++ metadata.json | 11 ++ templates/bandersnatch.conf.erb | 39 ++++++ 9 files changed, 445 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 Rakefile create mode 100644 files/robots.txt create mode 100644 files/run_bandersnatch.py create mode 100644 manifests/init.pp create mode 100644 manifests/mirror.pp create mode 100644 metadata.json create mode 100644 templates/bandersnatch.conf.erb diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /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.md b/README.md new file mode 100644 index 0000000..8692554 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# OpenStack Bandersnatch Module + +## Overview + +Installs and configures Bandersnatch. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..ff1f0d7 --- /dev/null +++ b/Rakefile @@ -0,0 +1,8 @@ +require 'rubygems' +require 'puppetlabs_spec_helper/rake_tasks' +require 'puppet-lint/tasks/puppet-lint' +PuppetLint.configuration.fail_on_warnings = true +PuppetLint.configuration.send('disable_80chars') +PuppetLint.configuration.send('disable_autoloader_layout') +PuppetLint.configuration.send('disable_class_inherits_from_params_class') +PuppetLint.configuration.send('disable_class_parameter_defaults') diff --git a/files/robots.txt b/files/robots.txt new file mode 100644 index 0000000..1f53798 --- /dev/null +++ b/files/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / diff --git a/files/run_bandersnatch.py b/files/run_bandersnatch.py new file mode 100644 index 0000000..c3636f8 --- /dev/null +++ b/files/run_bandersnatch.py @@ -0,0 +1,51 @@ +#!/usr/bin/python +# Copyright (c) 2014 Hewlett-Packard Development Company, L.P. +# +# 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. + +import logging +import requests +import subprocess + + +def setup_logging(logger): + ch = logging.StreamHandler() + formatter = logging.Formatter( + '%(asctime)s %(levelname)s: %(message)s') + ch.setFormatter(formatter) + logger.setLevel(logging.INFO) + logger.addHandler(ch) + + +def main(): + logger = logging.getLogger('bandersnatch') + setup_logging(logger) + + stale = dict() + output = subprocess.check_output( + ['bandersnatch', 'mirror'], stderr=subprocess.STDOUT) + for line in output.split('\n'): + print(line) + if 'Expected PyPI serial' in line: + url = line.split("for request ")[1].split()[0] + stale[url] = True + for url in stale.keys(): + logger.info('Purging %s' % url) + response = requests.request('PURGE', url) + if not response.ok: + logger.error('Failed to purge %s: %s' % (url, response.text)) + + +if __name__ == '__main__': + main() diff --git a/manifests/init.pp b/manifests/init.pp new file mode 100644 index 0000000..f0ed89f --- /dev/null +++ b/manifests/init.pp @@ -0,0 +1,54 @@ +# Copyright 2015 Hewlett-Packard Development Company, L.P. +# +# 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. +# +# = Class: bandersnatch +# +# Class to install common bandersnatch items. +# +class bandersnatch { + + package { 'bandersnatch': + ensure => 'present', + provider => 'pip', + } + + file { '/var/log/bandersnatch': + ensure => directory, + } + + file { '/var/run/bandersnatch': + ensure => directory, + } + + include logrotate + logrotate::file { 'bandersnatch': + log => '/var/log/bandersnatch/mirror.log', + options => [ + 'compress', + 'copytruncate', + 'missingok', + 'rotate 7', + 'daily', + 'notifempty', + ], + } + + file { '/usr/local/bin/run-bandersnatch': + ensure => present, + owner => 'root', + group => 'root', + mode => '0755', + source => 'puppet:///modules/bandersnatch/run_bandersnatch.py', + } +} diff --git a/manifests/mirror.pp b/manifests/mirror.pp new file mode 100644 index 0000000..4ca09a9 --- /dev/null +++ b/manifests/mirror.pp @@ -0,0 +1,73 @@ +# Copyright 2015 Hewlett-Packard Development Company, L.P. +# +# 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. +# +# = Class: bandersnatch::mirror +# +# Class to set up bandersnatch mirroring. +# +class bandersnatch::mirror ( + $vhost_name, + $mirror_root = '/srv/static/mirror', + $static_root = '/srv/static' +) { + + if ! defined(File[$static_root]) { + file { $static_root: + ensure => directory, + } + } + + file { $mirror_root: + ensure => directory, + owner => 'root', + group => 'root', + require => File[$static_root], + } + + file { "${mirror_root}/web": + ensure => directory, + owner => 'root', + group => 'root', + require => File[$mirror_root], + } + + include apache + + apache::vhost { $vhost_name: + port => 80, + priority => '50', + docroot => "${mirror_root}/web", + require => File["${mirror_root}/web"], + } + + file { "${mirror_root}/web/robots.txt": + ensure => present, + owner => 'root', + group => 'root', + mode => '0444', + source => 'puppet:///modules/bandersnatch/robots.txt', + require => File["${mirror_root}/web"], + } + + file { '/etc/bandersnatch.conf': + ensure => present, + content => template('bandersnatch/bandersnatch.conf.erb'), + } + + cron { 'bandersnatch': + minute => '*/5', + command => 'flock -n /var/run/bandersnatch/mirror.lock timeout -k 2m 30m run-bandersnatch >>/var/log/bandersnatch/mirror.log 2>&1', + environment => 'PATH=/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin', + } +} \ No newline at end of file diff --git a/metadata.json b/metadata.json new file mode 100644 index 0000000..68f81a5 --- /dev/null +++ b/metadata.json @@ -0,0 +1,11 @@ +{ + "name": "openstackci-bandersnatch", + "version": "0.0.1", + "author": "Openstack CI", + "summary": "Puppet module for Bandersnatch", + "license": "Apache 2.0", + "source": "https://github.com/notnownikki/puppet-bandersnatch.git", + "project_page": "https://github.com/notnownikki/puppet-bandersnatch", + "issues_url": "https://github.com/notnownikki/puppet-bandersnatch/issues", + "dependencies": [] +} diff --git a/templates/bandersnatch.conf.erb b/templates/bandersnatch.conf.erb new file mode 100644 index 0000000..d731f5e --- /dev/null +++ b/templates/bandersnatch.conf.erb @@ -0,0 +1,39 @@ +[mirror] +; The directory where the mirror data will be stored. +directory = <%= @mirror_root -%> + +; The PyPI server which will be mirrored. +; master = https://testpypi.python.org +; scheme for PyPI server MUST be https +master = https://pypi.python.org + +; The network socket timeout to use for all connections. This is set to a +; somewhat aggressively low value: rather fail quickly temporarily and re-run +; the client soon instead of having a process hang infinitely and have TCP not +; catching up for ages. +timeout = 10 + +; Number of worker threads to use for parallel downloads. +; Recommendations for worker thread setting: +; - leave the default of 3 to avoid overloading the pypi master +; - official servers located in data centers could run 20 workers +; - anything beyond 50 is probably unreasonable and avoided by bandersnatch +workers = 3 + +; Whether to stop a sync quickly after an error is found or whether to continue +; syncing but not marking the sync as successful. Value should be "true" or +; "false". +stop-on-error = false + +; Whether or not files that have been deleted on the master should be deleted +; on the mirror, too. +; IMPORTANT: if you are running an official mirror than you *need* to leave +; this on. +delete-packages = true + +[statistics] +; A glob pattern matching all access log files that should be processed to +; generate daily access statistics that will be aggregated on the master PyPI. +access-log-pattern = /var/log/apache2/pypi.*openstack.org_access.* + +; vim: set ft=cfg: