From 403648fa97b493c469f528e8c1d85c274d095399 Mon Sep 17 00:00:00 2001 From: Alex Schultz Date: Wed, 17 Jul 2019 07:18:32 -0600 Subject: [PATCH] Retire puppet-crane http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007846.html Depends-On: https://review.opendev.org/#/c/671263/ Change-Id: Ib0708d3c8e8f7e6650974e1d9eb1e96e6716ff1c --- .gitignore | 16 --- .gitreview | 4 - Gemfile | 27 ----- LICENSE | 176 --------------------------------- README.md | 91 ++--------------- Rakefile | 1 - bindep.txt | 12 --- doc/requirements.txt | 6 -- manifests/config.pp | 73 -------------- manifests/init.pp | 15 --- metadata.json | 50 ---------- setup.cfg | 13 --- setup.py | 22 ----- templates/crane-httpd.conf.erb | 21 ---- templates/crane.conf.erb | 11 --- tox.ini | 12 --- 16 files changed, 8 insertions(+), 542 deletions(-) delete mode 100644 .gitignore delete mode 100644 .gitreview delete mode 100644 Gemfile delete mode 100644 LICENSE delete mode 100644 Rakefile delete mode 100644 bindep.txt delete mode 100644 doc/requirements.txt delete mode 100644 manifests/config.pp delete mode 100644 manifests/init.pp delete mode 100644 metadata.json delete mode 100644 setup.cfg delete mode 100644 setup.py delete mode 100644 templates/crane-httpd.conf.erb delete mode 100644 templates/crane.conf.erb delete mode 100644 tox.ini diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 8550737..0000000 --- a/.gitignore +++ /dev/null @@ -1,16 +0,0 @@ -pkg/ -Gemfile.lock -vendor/ -spec/fixtures/ -.vagrant/ -.bundle/ -coverage/ -.idea/ -*.swp -*.iml -/openstack -/log - -# Files created by releasenotes build -releasenotes/build -.tox diff --git a/.gitreview b/.gitreview deleted file mode 100644 index 5a425f0..0000000 --- a/.gitreview +++ /dev/null @@ -1,4 +0,0 @@ -[gerrit] -host=review.opendev.org -port=29418 -project=openstack/puppet-crane.git diff --git a/Gemfile b/Gemfile deleted file mode 100644 index def52b6..0000000 --- a/Gemfile +++ /dev/null @@ -1,27 +0,0 @@ -source ENV['GEM_SOURCE'] || "https://rubygems.org" - -group :development, :test, :system_tests do - if ENV['ZUUL_PROJECT'] == 'openstack/puppet-openstack_spec_helper' - gem 'puppet-openstack_spec_helper', - :path => '../..', - :require => 'false' - else - gem 'puppet-openstack_spec_helper', - :git => 'https://git.openstack.org/openstack/puppet-openstack_spec_helper', - :require => 'false' - end -end - -if facterversion = ENV['FACTER_GEM_VERSION'] - gem 'facter', facterversion, :require => false -else - gem 'facter', :require => false -end - -if puppetversion = ENV['PUPPET_GEM_VERSION'] - gem 'puppet', puppetversion, :require => false -else - gem 'puppet', :require => false -end - -# vim:ft=ruby diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 68c771a..0000000 --- a/LICENSE +++ /dev/null @@ -1,176 +0,0 @@ - - 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. - diff --git a/README.md b/README.md index 5533e63..86e34d6 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,10 @@ -Team and repository tags -======================== +This project is no longer maintained. -[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-crane.svg)](https://governance.openstack.org/tc/reference/tags/index.html) +The contents of this repository are still available in the Git +source code management system. To see the contents of this +repository before it reached its end of life, please check out the +previous commit with "git checkout HEAD^1". - - -crane -====== - -#### Table of Contents - -1. [Overview - What is the crane module?](#overview) -2. [Module Description - What does the module do?](#module-description) -3. [Setup - The basics of getting started with crane](#setup) -4. [Implementation - An under-the-hood peek at what the module is doing](#implementation) -5. [Limitations - OS compatibility, etc.] -6. [Development - Guide for contributing to the module](#development) -7. [Contributors - Those with commits](#contributors) -8. [Release Notes - Release notes for the project](#release-notes) -9. [Repository - The project source code repository](#repository) - -Overview --------- - -Crane is a lightweight docker pull API. - -Module Description ------------------- - -The crane module is an attempt to make Puppet capable of managing the -entirety of crane. - -Setup ------ - -### Beginning with crane - -To use the crane module's functionality you will need to declare multiple -resources. This is not an exhaustive list of all the components needed; we -recommend you consult and understand the -[core of openstack](http://docs.openstack.org) documentation. - - -Implementation --------------- - -### Crane - -puppet-crane is a combination of Puppet manifests and ruby code to deliver -configuration and extra functionality through types and providers. - -Beaker-Rspec ------------- - -This module has beaker-rspec tests - -To run: - -```shell -bundle install -bundle exec rspec spec/acceptance -``` - -Development ------------ - -Developer documentation for the entire puppet-openstack project. - -* https://docs.openstack.org/puppet-openstack-guide/latest/ - -Contributors ------------- - -* https://github.com/openstack/puppet-crane/graphs/contributors - -Release Notes -------------- - -* https://docs.openstack.org/releasenotes/puppet-crane - -Repository ----------- - -* https://git.openstack.org/cgit/openstack/puppet-crane +For any further questions, please email +openstack-discuss@lists.openstack.org or join #openstack-dev on +Freenode. diff --git a/Rakefile b/Rakefile deleted file mode 100644 index 168d108..0000000 --- a/Rakefile +++ /dev/null @@ -1 +0,0 @@ -require 'puppet-openstack_spec_helper/rake_tasks' diff --git a/bindep.txt b/bindep.txt deleted file mode 100644 index d6645f8..0000000 --- a/bindep.txt +++ /dev/null @@ -1,12 +0,0 @@ -# This is a cross-platform list tracking distribution packages needed by tests; -# see https://docs.openstack.org/infra/bindep/ for additional information. - -libxml2-devel [test platform:rpm] -libxml2-dev [test platform:dpkg] -libxslt-devel [test platform:rpm] -libxslt1-dev [test platform:dpkg] -ruby-devel [test platform:rpm] -ruby-dev [test platform:dpkg] -zlib1g-dev [test platform:dpkg] -zlib-devel [test platform:rpm] -puppet [build] diff --git a/doc/requirements.txt b/doc/requirements.txt deleted file mode 100644 index aa9dd6b..0000000 --- a/doc/requirements.txt +++ /dev/null @@ -1,6 +0,0 @@ -# This is required for the docs build jobs -sphinx # BSD -openstackdocstheme # Apache-2.0 - -# This is required for the releasenotes build jobs -reno # Apache-2.0 diff --git a/manifests/config.pp b/manifests/config.pp deleted file mode 100644 index b744d61..0000000 --- a/manifests/config.pp +++ /dev/null @@ -1,73 +0,0 @@ -# == Class: crane::config -# -# Crane configuration -# -# === Parameters -# [*data_dir*] -# (Required) Full path to the directory from which metadata files should be loaded. The app files may optionally be in the root data_dir, or in subdirectories as desired. -# Defaults to /var/lib/crane/metadata/. -# -# [*debug*] -# (Required) Controls whether debug logging is enabled or disable for crane. -# Defaults to false. -# -# [*endpoint*] -# (Required) hostname and optional port, in the form hostname:port, where crane is deployed. This is the value that will be returned for the X-Docker-Endpoint header. defaults to the host and port used by the requesting client. -# Defaults to http://localhost:8787/. -# -# [*data_dir_polling_interval*] -# (Required) The number of seconds between checks for updates to metadata files in the data_dir. This defaults to checking once every 10 seconds. -# Defaults to 10. -# -# [*serve_content_enable*] -# (Required) Put Crane into "serve content" mode when true. Defaults to false, i.e. Crane uses 302 redirects by default. -# Defaults to true. -# -# [*serve_content_dir_v1*] -# (Required) Full path to the directory from which images should be served for Docker clients using the 'v1' API. -# Defaults to /var/lib/crane/data/. -# -# [*serve_content_dir_v2*] -# (Required) Full path to the directory from which images should be served for Docker clients using the 'v1' API. -# Defaults to /var/lib/crane/data/. -# -# [*serve_content_use_x_sendfile*] -# (Required) Use Apache XSENDFILE to send the data. -# Defaults to true. -# -# [*port*] -# (Required) The port where Apache/Crane will listen. -# Defaults to 8787. -# -# [*host*] -# (Required) The host where Apache/Crane will listen. -# Defaults to localhost. -# -class crane::config( - $data_dir = '/var/lib/crane/metadata/', - $debug = false, - $endpoint = 'http://localhost:8787/', - $data_dir_polling_interval = '10', - $serve_content_enable = true, - $serve_content_dir_v1 = '/var/lib/crane/data/', - $serve_content_dir_v2 = '/var/lib/crane/data/', - $serve_content_use_x_sendfile = true, - $host = 'localhost', - $port = 8787, -){ - - file { '/etc/crane.conf': - content => template('crane/crane.conf.erb') - } - - file { '/etc/httpd/conf.d/crane.conf': - content => template('crane/crane-httpd.conf.erb') - } - - file_line { '/etc/httpd/conf/httpd.conf:Listen': - path => '/etc/httpd/conf/httpd.conf', - match => '^Listen 80*', - line => "Listen $port", - } - -} diff --git a/manifests/init.pp b/manifests/init.pp deleted file mode 100644 index 3497c74..0000000 --- a/manifests/init.pp +++ /dev/null @@ -1,15 +0,0 @@ -# == Class: Crane -# -# Crane init -# -# === Parameters -# [*package_ensure*] -# (Optional) Ensure state for package. -# Defaults to 'present'. -class crane( - $package_ensure = 'present', -){ - - include ::crane::config - -} diff --git a/metadata.json b/metadata.json deleted file mode 100644 index 47009cb..0000000 --- a/metadata.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "author": "OpenStack Contributors", - "dependencies": [ - { - "name": "puppetlabs/stdlib", - "version_requirement": ">= 4.0.0 <5.0.0" - } - ], - "description": "Installs and configures OpenStack crane.", - "issues_url": "https://bugs.launchpad.net/puppet-crane", - "license": "Apache-2.0", - "name": "openstack-crane", - "operatingsystem_support": [ - { - "operatingsystem": "Debian", - "operatingsystemrelease": [ - "9" - ] - }, - { - "operatingsystem": "Fedora", - "operatingsystemrelease": [ - "24" - ] - }, - { - "operatingsystem": "RedHat", - "operatingsystemrelease": [ - "7" - ] - }, - { - "operatingsystem": "Ubuntu", - "operatingsystemrelease": [ - "16.04", - "18.04" - ] - } - ], - "project_page": "https://launchpad.net/puppet-crane", - "requirements": [ - { - "name": "puppet", - "version_requirement": "4.x" - } - ], - "source": "git://github.com/openstack/puppet-crane.git", - "summary": "Puppet module for Crane", - "version": "14.0.0" -} diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 83b4298..0000000 --- a/setup.cfg +++ /dev/null @@ -1,13 +0,0 @@ -[metadata] -name = puppet-crane -summary = Puppet module for Crane -description-file = - README.md -author = Dan Prince -author-email = openstack-dev@lists.openstack.org -home-page = https://docs.openstack.org/puppet-openstack-guide/latest -classifier = - Intended Audience :: Developers - Intended Audience :: System Administrators - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux diff --git a/setup.py b/setup.py deleted file mode 100644 index 70c2b3f..0000000 --- a/setup.py +++ /dev/null @@ -1,22 +0,0 @@ -#!/usr/bin/env python -# Copyright (c) 2013 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. - -# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT -import setuptools - -setuptools.setup( - setup_requires=['pbr'], - pbr=True) diff --git a/templates/crane-httpd.conf.erb b/templates/crane-httpd.conf.erb deleted file mode 100644 index 201ceca..0000000 --- a/templates/crane-httpd.conf.erb +++ /dev/null @@ -1,21 +0,0 @@ -:<%= @port %>> - WSGIScriptAlias / /usr/share/crane/crane.wsgi - CustomLog /var/log/crane/crane-access.log combined - ErrorLog /var/log/crane/crane-error.log - - Require host localhost - - - Require all granted - XSendFile on - XSendFilePath <%= @serve_content_dir_v2 %> - - - Require all granted - XSendFile on - XSendFilePath <%= @serve_content_dir_v1 %> - - - Require all granted - - diff --git a/templates/crane.conf.erb b/templates/crane.conf.erb deleted file mode 100644 index 663a621..0000000 --- a/templates/crane.conf.erb +++ /dev/null @@ -1,11 +0,0 @@ -[general] -debug: <%= scope['crane::config::debug'] %> -data_dir: <%= scope['crane::config::data_dir'] %> -endpoint: <%= scope['crane::config::endpoint'] %> -data_dir_polling_interval: <%= scope['crane::config::data_dir_polling_interval'] %> - -[serve_content] -enable: <%= scope['crane::config::serve_content_enable'] %> -content_dir_v1: <%= scope['crane::config::serve_content_dir_v1'] %> -content_dir_v2: <%= scope['crane::config::serve_content_dir_v2'] %> -use_x_sendfile: <%= scope['crane::config::serve_content_use_x_sendfile'] %> diff --git a/tox.ini b/tox.ini deleted file mode 100644 index cb4ba51..0000000 --- a/tox.ini +++ /dev/null @@ -1,12 +0,0 @@ -[tox] -minversion = 1.6 -skipsdist = True -envlist = releasenotes - -[testenv] -install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages} - -[testenv:releasenotes] -basepython = python3 -deps = -r{toxinidir}/doc/requirements.txt -commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html