summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Prince <dprince@redhat.com>2018-10-04 10:57:30 -0400
committerDan Prince <dprince@redhat.com>2018-10-15 14:20:14 -0400
commit1c745473f2d1062b4b5529be7c98402fbe00b344 (patch)
treeff16bbd88a46df1f6e232903a2f4b832a56d20e6
Initial commit.HEADmaster
-rw-r--r--.gitignore16
-rw-r--r--.gitreview4
-rw-r--r--Gemfile27
-rw-r--r--LICENSE176
-rw-r--r--README.md85
-rw-r--r--Rakefile1
-rw-r--r--bindep.txt12
-rw-r--r--doc/requirements.txt6
-rw-r--r--manifests/config.pp73
-rw-r--r--manifests/init.pp15
-rw-r--r--metadata.json50
-rw-r--r--setup.cfg13
-rw-r--r--setup.py22
-rw-r--r--templates/crane-httpd.conf.erb21
-rw-r--r--templates/crane.conf.erb11
-rw-r--r--tox.ini12
16 files changed, 544 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..8550737
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,16 @@
1pkg/
2Gemfile.lock
3vendor/
4spec/fixtures/
5.vagrant/
6.bundle/
7coverage/
8.idea/
9*.swp
10*.iml
11/openstack
12/log
13
14# Files created by releasenotes build
15releasenotes/build
16.tox
diff --git a/.gitreview b/.gitreview
new file mode 100644
index 0000000..1387441
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,4 @@
1[gerrit]
2host=review.openstack.org
3port=29418
4project=openstack/puppet-crane.git
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..def52b6
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,27 @@
1source ENV['GEM_SOURCE'] || "https://rubygems.org"
2
3group :development, :test, :system_tests do
4 if ENV['ZUUL_PROJECT'] == 'openstack/puppet-openstack_spec_helper'
5 gem 'puppet-openstack_spec_helper',
6 :path => '../..',
7 :require => 'false'
8 else
9 gem 'puppet-openstack_spec_helper',
10 :git => 'https://git.openstack.org/openstack/puppet-openstack_spec_helper',
11 :require => 'false'
12 end
13end
14
15if facterversion = ENV['FACTER_GEM_VERSION']
16 gem 'facter', facterversion, :require => false
17else
18 gem 'facter', :require => false
19end
20
21if puppetversion = ENV['PUPPET_GEM_VERSION']
22 gem 'puppet', puppetversion, :require => false
23else
24 gem 'puppet', :require => false
25end
26
27# vim:ft=ruby
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..68c771a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,176 @@
1
2 Apache License
3 Version 2.0, January 2004
4 http://www.apache.org/licenses/
5
6 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
8 1. Definitions.
9
10 "License" shall mean the terms and conditions for use, reproduction,
11 and distribution as defined by Sections 1 through 9 of this document.
12
13 "Licensor" shall mean the copyright owner or entity authorized by
14 the copyright owner that is granting the License.
15
16 "Legal Entity" shall mean the union of the acting entity and all
17 other entities that control, are controlled by, or are under common
18 control with that entity. For the purposes of this definition,
19 "control" means (i) the power, direct or indirect, to cause the
20 direction or management of such entity, whether by contract or
21 otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 outstanding shares, or (iii) beneficial ownership of such entity.
23
24 "You" (or "Your") shall mean an individual or Legal Entity
25 exercising permissions granted by this License.
26
27 "Source" form shall mean the preferred form for making modifications,
28 including but not limited to software source code, documentation
29 source, and configuration files.
30
31 "Object" form shall mean any form resulting from mechanical
32 transformation or translation of a Source form, including but
33 not limited to compiled object code, generated documentation,
34 and conversions to other media types.
35
36 "Work" shall mean the work of authorship, whether in Source or
37 Object form, made available under the License, as indicated by a
38 copyright notice that is included in or attached to the work
39 (an example is provided in the Appendix below).
40
41 "Derivative Works" shall mean any work, whether in Source or Object
42 form, that is based on (or derived from) the Work and for which the
43 editorial revisions, annotations, elaborations, or other modifications
44 represent, as a whole, an original work of authorship. For the purposes
45 of this License, Derivative Works shall not include works that remain
46 separable from, or merely link (or bind by name) to the interfaces of,
47 the Work and Derivative Works thereof.
48
49 "Contribution" shall mean any work of authorship, including
50 the original version of the Work and any modifications or additions
51 to that Work or Derivative Works thereof, that is intentionally
52 submitted to Licensor for inclusion in the Work by the copyright owner
53 or by an individual or Legal Entity authorized to submit on behalf of
54 the copyright owner. For the purposes of this definition, "submitted"
55 means any form of electronic, verbal, or written communication sent
56 to the Licensor or its representatives, including but not limited to
57 communication on electronic mailing lists, source code control systems,
58 and issue tracking systems that are managed by, or on behalf of, the
59 Licensor for the purpose of discussing and improving the Work, but
60 excluding communication that is conspicuously marked or otherwise
61 designated in writing by the copyright owner as "Not a Contribution."
62
63 "Contributor" shall mean Licensor and any individual or Legal Entity
64 on behalf of whom a Contribution has been received by Licensor and
65 subsequently incorporated within the Work.
66
67 2. Grant of Copyright License. Subject to the terms and conditions of
68 this License, each Contributor hereby grants to You a perpetual,
69 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 copyright license to reproduce, prepare Derivative Works of,
71 publicly display, publicly perform, sublicense, and distribute the
72 Work and such Derivative Works in Source or Object form.
73
74 3. Grant of Patent License. Subject to the terms and conditions of
75 this License, each Contributor hereby grants to You a perpetual,
76 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 (except as stated in this section) patent license to make, have made,
78 use, offer to sell, sell, import, and otherwise transfer the Work,
79 where such license applies only to those patent claims licensable
80 by such Contributor that are necessarily infringed by their
81 Contribution(s) alone or by combination of their Contribution(s)
82 with the Work to which such Contribution(s) was submitted. If You
83 institute patent litigation against any entity (including a
84 cross-claim or counterclaim in a lawsuit) alleging that the Work
85 or a Contribution incorporated within the Work constitutes direct
86 or contributory patent infringement, then any patent licenses
87 granted to You under this License for that Work shall terminate
88 as of the date such litigation is filed.
89
90 4. Redistribution. You may reproduce and distribute copies of the
91 Work or Derivative Works thereof in any medium, with or without
92 modifications, and in Source or Object form, provided that You
93 meet the following conditions:
94
95 (a) You must give any other recipients of the Work or
96 Derivative Works a copy of this License; and
97
98 (b) You must cause any modified files to carry prominent notices
99 stating that You changed the files; and
100
101 (c) You must retain, in the Source form of any Derivative Works
102 that You distribute, all copyright, patent, trademark, and
103 attribution notices from the Source form of the Work,
104 excluding those notices that do not pertain to any part of
105 the Derivative Works; and
106
107 (d) If the Work includes a "NOTICE" text file as part of its
108 distribution, then any Derivative Works that You distribute must
109 include a readable copy of the attribution notices contained
110 within such NOTICE file, excluding those notices that do not
111 pertain to any part of the Derivative Works, in at least one
112 of the following places: within a NOTICE text file distributed
113 as part of the Derivative Works; within the Source form or
114 documentation, if provided along with the Derivative Works; or,
115 within a display generated by the Derivative Works, if and
116 wherever such third-party notices normally appear. The contents
117 of the NOTICE file are for informational purposes only and
118 do not modify the License. You may add Your own attribution
119 notices within Derivative Works that You distribute, alongside
120 or as an addendum to the NOTICE text from the Work, provided
121 that such additional attribution notices cannot be construed
122 as modifying the License.
123
124 You may add Your own copyright statement to Your modifications and
125 may provide additional or different license terms and conditions
126 for use, reproduction, or distribution of Your modifications, or
127 for any such Derivative Works as a whole, provided Your use,
128 reproduction, and distribution of the Work otherwise complies with
129 the conditions stated in this License.
130
131 5. Submission of Contributions. Unless You explicitly state otherwise,
132 any Contribution intentionally submitted for inclusion in the Work
133 by You to the Licensor shall be under the terms and conditions of
134 this License, without any additional terms or conditions.
135 Notwithstanding the above, nothing herein shall supersede or modify
136 the terms of any separate license agreement you may have executed
137 with Licensor regarding such Contributions.
138
139 6. Trademarks. This License does not grant permission to use the trade
140 names, trademarks, service marks, or product names of the Licensor,
141 except as required for reasonable and customary use in describing the
142 origin of the Work and reproducing the content of the NOTICE file.
143
144 7. Disclaimer of Warranty. Unless required by applicable law or
145 agreed to in writing, Licensor provides the Work (and each
146 Contributor provides its Contributions) on an "AS IS" BASIS,
147 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 implied, including, without limitation, any warranties or conditions
149 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 PARTICULAR PURPOSE. You are solely responsible for determining the
151 appropriateness of using or redistributing the Work and assume any
152 risks associated with Your exercise of permissions under this License.
153
154 8. Limitation of Liability. In no event and under no legal theory,
155 whether in tort (including negligence), contract, or otherwise,
156 unless required by applicable law (such as deliberate and grossly
157 negligent acts) or agreed to in writing, shall any Contributor be
158 liable to You for damages, including any direct, indirect, special,
159 incidental, or consequential damages of any character arising as a
160 result of this License or out of the use or inability to use the
161 Work (including but not limited to damages for loss of goodwill,
162 work stoppage, computer failure or malfunction, or any and all
163 other commercial damages or losses), even if such Contributor
164 has been advised of the possibility of such damages.
165
166 9. Accepting Warranty or Additional Liability. While redistributing
167 the Work or Derivative Works thereof, You may choose to offer,
168 and charge a fee for, acceptance of support, warranty, indemnity,
169 or other liability obligations and/or rights consistent with this
170 License. However, in accepting such obligations, You may act only
171 on Your own behalf and on Your sole responsibility, not on behalf
172 of any other Contributor, and only if You agree to indemnify,
173 defend, and hold each Contributor harmless for any liability
174 incurred by, or claims asserted against, such Contributor by reason
175 of your accepting any such warranty or additional liability.
176
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5533e63
--- /dev/null
+++ b/README.md
@@ -0,0 +1,85 @@
1Team and repository tags
2========================
3
4[![Team and repository tags](https://governance.openstack.org/tc/badges/puppet-crane.svg)](https://governance.openstack.org/tc/reference/tags/index.html)
5
6<!-- Change things from this point on -->
7
8crane
9======
10
11#### Table of Contents
12
131. [Overview - What is the crane module?](#overview)
142. [Module Description - What does the module do?](#module-description)
153. [Setup - The basics of getting started with crane](#setup)
164. [Implementation - An under-the-hood peek at what the module is doing](#implementation)
175. [Limitations - OS compatibility, etc.]
186. [Development - Guide for contributing to the module](#development)
197. [Contributors - Those with commits](#contributors)
208. [Release Notes - Release notes for the project](#release-notes)
219. [Repository - The project source code repository](#repository)
22
23Overview
24--------
25
26Crane is a lightweight docker pull API.
27
28Module Description
29------------------
30
31The crane module is an attempt to make Puppet capable of managing the
32entirety of crane.
33
34Setup
35-----
36
37### Beginning with crane
38
39To use the crane module's functionality you will need to declare multiple
40resources. This is not an exhaustive list of all the components needed; we
41recommend you consult and understand the
42[core of openstack](http://docs.openstack.org) documentation.
43
44
45Implementation
46--------------
47
48### Crane
49
50puppet-crane is a combination of Puppet manifests and ruby code to deliver
51configuration and extra functionality through types and providers.
52
53Beaker-Rspec
54------------
55
56This module has beaker-rspec tests
57
58To run:
59
60```shell
61bundle install
62bundle exec rspec spec/acceptance
63```
64
65Development
66-----------
67
68Developer documentation for the entire puppet-openstack project.
69
70* https://docs.openstack.org/puppet-openstack-guide/latest/
71
72Contributors
73------------
74
75* https://github.com/openstack/puppet-crane/graphs/contributors
76
77Release Notes
78-------------
79
80* https://docs.openstack.org/releasenotes/puppet-crane
81
82Repository
83----------
84
85* https://git.openstack.org/cgit/openstack/puppet-crane
diff --git a/Rakefile b/Rakefile
new file mode 100644
index 0000000..168d108
--- /dev/null
+++ b/Rakefile
@@ -0,0 +1 @@
require 'puppet-openstack_spec_helper/rake_tasks'
diff --git a/bindep.txt b/bindep.txt
new file mode 100644
index 0000000..d6645f8
--- /dev/null
+++ b/bindep.txt
@@ -0,0 +1,12 @@
1# This is a cross-platform list tracking distribution packages needed by tests;
2# see https://docs.openstack.org/infra/bindep/ for additional information.
3
4libxml2-devel [test platform:rpm]
5libxml2-dev [test platform:dpkg]
6libxslt-devel [test platform:rpm]
7libxslt1-dev [test platform:dpkg]
8ruby-devel [test platform:rpm]
9ruby-dev [test platform:dpkg]
10zlib1g-dev [test platform:dpkg]
11zlib-devel [test platform:rpm]
12puppet [build]
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..aa9dd6b
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,6 @@
1# This is required for the docs build jobs
2sphinx # BSD
3openstackdocstheme # Apache-2.0
4
5# This is required for the releasenotes build jobs
6reno # Apache-2.0
diff --git a/manifests/config.pp b/manifests/config.pp
new file mode 100644
index 0000000..b744d61
--- /dev/null
+++ b/manifests/config.pp
@@ -0,0 +1,73 @@
1# == Class: crane::config
2#
3# Crane configuration
4#
5# === Parameters
6# [*data_dir*]
7# (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.
8# Defaults to /var/lib/crane/metadata/.
9#
10# [*debug*]
11# (Required) Controls whether debug logging is enabled or disable for crane.
12# Defaults to false.
13#
14# [*endpoint*]
15# (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.
16# Defaults to http://localhost:8787/.
17#
18# [*data_dir_polling_interval*]
19# (Required) The number of seconds between checks for updates to metadata files in the data_dir. This defaults to checking once every 10 seconds.
20# Defaults to 10.
21#
22# [*serve_content_enable*]
23# (Required) Put Crane into "serve content" mode when true. Defaults to false, i.e. Crane uses 302 redirects by default.
24# Defaults to true.
25#
26# [*serve_content_dir_v1*]
27# (Required) Full path to the directory from which images should be served for Docker clients using the 'v1' API.
28# Defaults to /var/lib/crane/data/.
29#
30# [*serve_content_dir_v2*]
31# (Required) Full path to the directory from which images should be served for Docker clients using the 'v1' API.
32# Defaults to /var/lib/crane/data/.
33#
34# [*serve_content_use_x_sendfile*]
35# (Required) Use Apache XSENDFILE to send the data.
36# Defaults to true.
37#
38# [*port*]
39# (Required) The port where Apache/Crane will listen.
40# Defaults to 8787.
41#
42# [*host*]
43# (Required) The host where Apache/Crane will listen.
44# Defaults to localhost.
45#
46class crane::config(
47 $data_dir = '/var/lib/crane/metadata/',
48 $debug = false,
49 $endpoint = 'http://localhost:8787/',
50 $data_dir_polling_interval = '10',
51 $serve_content_enable = true,
52 $serve_content_dir_v1 = '/var/lib/crane/data/',
53 $serve_content_dir_v2 = '/var/lib/crane/data/',
54 $serve_content_use_x_sendfile = true,
55 $host = 'localhost',
56 $port = 8787,
57){
58
59 file { '/etc/crane.conf':
60 content => template('crane/crane.conf.erb')
61 }
62
63 file { '/etc/httpd/conf.d/crane.conf':
64 content => template('crane/crane-httpd.conf.erb')
65 }
66
67 file_line { '/etc/httpd/conf/httpd.conf:Listen':
68 path => '/etc/httpd/conf/httpd.conf',
69 match => '^Listen 80*',
70 line => "Listen $port",
71 }
72
73}
diff --git a/manifests/init.pp b/manifests/init.pp
new file mode 100644
index 0000000..3497c74
--- /dev/null
+++ b/manifests/init.pp
@@ -0,0 +1,15 @@
1# == Class: Crane
2#
3# Crane init
4#
5# === Parameters
6# [*package_ensure*]
7# (Optional) Ensure state for package.
8# Defaults to 'present'.
9class crane(
10 $package_ensure = 'present',
11){
12
13 include ::crane::config
14
15}
diff --git a/metadata.json b/metadata.json
new file mode 100644
index 0000000..47009cb
--- /dev/null
+++ b/metadata.json
@@ -0,0 +1,50 @@
1{
2 "author": "OpenStack Contributors",
3 "dependencies": [
4 {
5 "name": "puppetlabs/stdlib",
6 "version_requirement": ">= 4.0.0 <5.0.0"
7 }
8 ],
9 "description": "Installs and configures OpenStack crane.",
10 "issues_url": "https://bugs.launchpad.net/puppet-crane",
11 "license": "Apache-2.0",
12 "name": "openstack-crane",
13 "operatingsystem_support": [
14 {
15 "operatingsystem": "Debian",
16 "operatingsystemrelease": [
17 "9"
18 ]
19 },
20 {
21 "operatingsystem": "Fedora",
22 "operatingsystemrelease": [
23 "24"
24 ]
25 },
26 {
27 "operatingsystem": "RedHat",
28 "operatingsystemrelease": [
29 "7"
30 ]
31 },
32 {
33 "operatingsystem": "Ubuntu",
34 "operatingsystemrelease": [
35 "16.04",
36 "18.04"
37 ]
38 }
39 ],
40 "project_page": "https://launchpad.net/puppet-crane",
41 "requirements": [
42 {
43 "name": "puppet",
44 "version_requirement": "4.x"
45 }
46 ],
47 "source": "git://github.com/openstack/puppet-crane.git",
48 "summary": "Puppet module for Crane",
49 "version": "14.0.0"
50}
diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..83b4298
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,13 @@
1[metadata]
2name = puppet-crane
3summary = Puppet module for Crane
4description-file =
5 README.md
6author = Dan Prince
7author-email = openstack-dev@lists.openstack.org
8home-page = https://docs.openstack.org/puppet-openstack-guide/latest
9classifier =
10 Intended Audience :: Developers
11 Intended Audience :: System Administrators
12 License :: OSI Approved :: Apache Software License
13 Operating System :: POSIX :: Linux
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..70c2b3f
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,22 @@
1#!/usr/bin/env python
2# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13# implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16
17# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
18import setuptools
19
20setuptools.setup(
21 setup_requires=['pbr'],
22 pbr=True)
diff --git a/templates/crane-httpd.conf.erb b/templates/crane-httpd.conf.erb
new file mode 100644
index 0000000..201ceca
--- /dev/null
+++ b/templates/crane-httpd.conf.erb
@@ -0,0 +1,21 @@
1<VirtualHost <%= @host %>:<%= @port %>>
2 WSGIScriptAlias / /usr/share/crane/crane.wsgi
3 CustomLog /var/log/crane/crane-access.log combined
4 ErrorLog /var/log/crane/crane-error.log
5 <Location /crane>
6 Require host localhost
7 </Location>
8 <Location /v2/>
9 Require all granted
10 XSendFile on
11 XSendFilePath <%= @serve_content_dir_v2 %>
12 </Location>
13 <Location /v1/>
14 Require all granted
15 XSendFile on
16 XSendFilePath <%= @serve_content_dir_v1 %>
17 </Location>
18 <Directory /usr/share/crane/>
19 Require all granted
20 </Directory>
21</VirtualHost>
diff --git a/templates/crane.conf.erb b/templates/crane.conf.erb
new file mode 100644
index 0000000..663a621
--- /dev/null
+++ b/templates/crane.conf.erb
@@ -0,0 +1,11 @@
1[general]
2debug: <%= scope['crane::config::debug'] %>
3data_dir: <%= scope['crane::config::data_dir'] %>
4endpoint: <%= scope['crane::config::endpoint'] %>
5data_dir_polling_interval: <%= scope['crane::config::data_dir_polling_interval'] %>
6
7[serve_content]
8enable: <%= scope['crane::config::serve_content_enable'] %>
9content_dir_v1: <%= scope['crane::config::serve_content_dir_v1'] %>
10content_dir_v2: <%= scope['crane::config::serve_content_dir_v2'] %>
11use_x_sendfile: <%= scope['crane::config::serve_content_use_x_sendfile'] %>
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..cb4ba51
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,12 @@
1[tox]
2minversion = 1.6
3skipsdist = True
4envlist = releasenotes
5
6[testenv]
7install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
8
9[testenv:releasenotes]
10basepython = python3
11deps = -r{toxinidir}/doc/requirements.txt
12commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html