From 917b05d9d610bc91d835d736f74602843863e223 Mon Sep 17 00:00:00 2001 From: Emilien Macchi Date: Mon, 8 Sep 2014 18:58:08 -0400 Subject: [PATCH] Basic structure imported from tripleo-image-elements Imported from tripleo-image-elements, this is the basic structure. Signed-off-by: Emilien Macchi --- LICENSE | 7 +- MANIFEST.in | 3 + README.md | 90 ++++++++++++++++ babel.cfg | 1 + doc/source/conf.py | 242 ++++++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 22 ++++ elements/__init__.py | 0 requirements.txt | 1 + run-flake8 | 23 ++++ setup.cfg | 28 +++++ setup.py | 22 ++++ test-requirements.txt | 6 ++ tests/__init__.py | 0 tox.ini | 29 +++++ 14 files changed, 471 insertions(+), 3 deletions(-) create mode 100644 MANIFEST.in create mode 100644 README.md create mode 100644 babel.cfg create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 100644 elements/__init__.py create mode 100644 requirements.txt create mode 100755 run-flake8 create mode 100644 setup.cfg create mode 100755 setup.py create mode 100644 test-requirements.txt create mode 100644 tests/__init__.py create mode 100644 tox.ini diff --git a/LICENSE b/LICENSE index 5c304d1a..d6456956 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,5 @@ -Apache License + + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -178,7 +179,7 @@ Apache License 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 "{}" + 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 @@ -186,7 +187,7 @@ Apache License same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright {yyyy} {name of copyright owner} + 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. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 00000000..9e65a96c --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,3 @@ +include README.md +graft elements +graft docs diff --git a/README.md b/README.md new file mode 100644 index 00000000..83b08c54 --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ +Puppet building rules for OpenStack images +========================================== + +First note +---------- + +This project is not yet official and is work in progress. It aims to move on +Stackforge if the community decides it. + + +These elements are used to build disk images for deploying OpenStack via Heat. +They are built as part of the TripleO (https://wiki.openstack.org/wiki/TripleO) +umbrella project. + +Instructions +------------ + +Checkout this source tree and also the diskimage builder, export an +ELEMENTS\_PATH to add elements from this tree, and build any disk images you +need. + + git clone https://git.openstack.org/openstack/diskimage-builder.git + git clone https://git.openstack.org/openstack/tripleo-puppet-elements.git + export ELEMENTS_PATH=tripleo-puppet-elements/elements + diskimage-builder/bin/disk-image-create -u base vm bootstrap local-config stackuser heat-cfntools -a i386 -o bootstrap + +Common element combinations +--------------------------- + +Always include heat-cfntools in images that you intend to boot via heat : if +that is not done, then the user ssh keys are not reliably pulled down from the +metadata server due to interactions with cloud-init. + +Architecture +------------ + +OpenStack images are intended to be deployed and maintained using Nova + Heat. + +As such they should strive to be stateless, maintained entirely via automation. + +Configuration +------------- + +In a running OpenStack there are several categories of config. + + - per user - e.g. ssh key registration with nova: we repeat this sort + of config every time we add a user. + - local node - e.g. nova.conf or ovs-vsctl add-br br-ex : settings that + apply individually to machines + - inter-node - e.g. credentials on rabbitmq for a given nova compute node + - application state - e.g. 'neutron net-create ...' : settings that + apply to the whole cluster not on a per-user / per-tenant basis + +We have five places we can do configuration in TripleO: + - image build time + - in-instance heat-driven (ORC scripts) + - in-instance first-boot scripts [deprecated] + - from outside via APIs + - orchestrated by Heat + +Our current heuristic for deciding where to do any particular configuration +step: + - per user config should be done from the outside via APIs, even for + users like 'admin' that we know we'll have. Note that service accounts + are different - they are a form of inter-node configuration. + - local node configuration should be done via ORC driven by Heat and/or + configuration management system metadata. + - inter-node configuration should be done by working through Heat. For + instance, creating a rabbit account for a nova compute node is something + that Heat should arrange, though the act of creating is probably done by a + script on the rabbit server - triggered by Heat - and applying the config is + done on the compute node by the local node script - again triggered by Heat. + - application state changes should be done from outside via APIs + - first-boot scripts should not be used. + + +Copyright +========= + +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/babel.cfg b/babel.cfg new file mode 100644 index 00000000..efceab81 --- /dev/null +++ b/babel.cfg @@ -0,0 +1 @@ +[python: **.py] diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 00000000..67097d09 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,242 @@ +# -*- coding: utf-8 -*- +# +# 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. +# + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['oslosphinx'] +templates_path = ['_templates'] +# The suffix of source filenames. +source_suffix = '.rst' +master_doc = 'index' + +# General information about the project. +project = u'TripleO Puppet Elements' +copyright = u'2014, OpenStack Developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.0' +# The full version, including alpha/beta/rc tags. +release = '0.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'TripleOPuppetElementsdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = {} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'TripleOPuppetElements.tex', + u'TripleO Puppet Elements Documentation', + u'OpenStack Developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'tripleoimageelements', u'TripleO Puppet Elements Documentation', + [u'OpenStack Developers'], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'TripleOPuppetElements', + u'TripleO Puppet Elements Documentation', + u'OpenStack Developers', 'TripleOPuppetElements', + 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 00000000..de931f17 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,22 @@ +.. TripleO Puppet Elements documentation master file, created by + sphinx-quickstart on Fri Apr 18 09:19:09 2014. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to TripleO Puppet Elements's documentation! +================================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/elements/__init__.py b/elements/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..4e46b891 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +pbr>=0.5.21,<1.0 diff --git a/run-flake8 b/run-flake8 new file mode 100755 index 00000000..54d9180c --- /dev/null +++ b/run-flake8 @@ -0,0 +1,23 @@ +#!/bin/bash +# Copyright 2014 eNovance +# +# 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. +# +set -eu +set -o pipefail + +flake8 + +extra_python_files=$(egrep -R --null-data --files-with-matches "^#!/usr/bin/env python" elements/) +echo $extra_python_files +flake8 ${extra_python_files} diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..07ee5c9c --- /dev/null +++ b/setup.cfg @@ -0,0 +1,28 @@ +[metadata] +name = tripleo-image-elements +summary = Disk image builder elements for deploying OpenStack. +description-file = + README.md +author = OpenStack +author_email = openstack-dev@lists.openstack.org +license = Apache License (2.0) +home-page = https://git.openstack.org/cgit/openstack/tripleo-image-elements +classifier = + Environment :: OpenStack + Development Status :: 3 - Alpha + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Other + Environment :: Console + +[files] +data_files = + share/tripleo-image-elements = elements/* + +[wheel] +universal = 1 + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source diff --git a/setup.py b/setup.py new file mode 100755 index 00000000..70c2b3f3 --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +#!/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/test-requirements.txt b/test-requirements.txt new file mode 100644 index 00000000..d742d628 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,6 @@ +hacking>=0.8.0,<0.9 + +oslotest +oslosphinx +sphinx>=1.1.2,<1.2 +testrepository>=0.0.18 diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..11ef485d --- /dev/null +++ b/tox.ini @@ -0,0 +1,29 @@ +[tox] +minversion = 1.6 +skipsdist = True +envlist = py26,py27,pep8 + +[testenv] +usedevelop = True +install_command = pip install {opts} {packages} +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt +commands= + python setup.py testr --slowest --testr-args='{posargs}' + +[testenv:py26] +commands = + +[testenv:venv] +commands = {posargs} + +[testenv:pep8] +commands = ./run-flake8 + +[flake8] +ignore = E125,H803 +exclude = .venv,.tox,dist,*.egg +show-source = true + +[tox:jenkins] +downloadcache = ~/cache/pip