diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2c6aad0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.tox +AUTHORS +ChangeLog +doc/build +*egg-info diff --git a/README.rst b/README.rst index 466b242..2a8892d 100644 --- a/README.rst +++ b/README.rst @@ -3,9 +3,9 @@ Service Types Authority ======================= The following is a central authority for handing out service types to -projects. +projects for their services. -OpenStack Projects with REST APIs must have a well known service type. +Each OpenStack Service with a REST API must have a well known service type. The well known service type guarantees a documented API is available for that service. Users of this service can trust that it will be the same between different OpenStack environments. @@ -15,6 +15,11 @@ Attributes The following attributes are required for a service type registration: +service-type (required) +----------------------- + +The unique identifier for the service to be used in the service catalog. + project (required) ------------------ @@ -44,7 +49,7 @@ Naming Service types should be: - English words -- Be matched by the regex [a-z\-]+ +- Be matched by the regex ^[a-z][a-z-]+$ - Be meaningful - Not use terms which are incredibly overloaded in OpenStack space (i.e. policy) diff --git a/doc/source/README.rst b/doc/source/README.rst new file mode 120000 index 0000000..c768ff7 --- /dev/null +++ b/doc/source/README.rst @@ -0,0 +1 @@ +../../README.rst \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..4721189 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,258 @@ +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import datetime +import subprocess +import sys +import os + +# 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'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Service Types Authority' +copyright = u'%s, OpenStack API Working Group Team' % datetime.date.today().year + +# 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 = False + +# 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 = [] + +# -- Options for man page output ---------------------------------------------- +man_pages = [] + +# -- 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 = 'nature' + +# 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 + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", + "-n1"] +html_last_updated_fmt = subprocess.Popen( + git_cmd, stdout=subprocess.PIPE).communicate()[0] + +# 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 = False + +# If false, no index is generated. +html_use_index = False + +# 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 = 'ServiceTypesAuthority' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'service-types-authority.tex', u'API Working Group', + u'OpenStack API Working Group Team', '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 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 = [] + +# 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' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'Service Types Authority' +epub_author = u'OpenStack API Working Group Team' +epub_publisher = u'OpenStack API Working Group Team' +epub_copyright = u'%s, OpenStack API Working Group Team' % datetime.date.today().year + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..92569f5 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,15 @@ +.. include:: README.rst + +Service Data +============ + +The :download:`Service Types Authority ` information is +kept in downloadable form in YAML. + +.. literalinclude:: service-types.yaml + :language: yaml + +It is described by a :download:`Service Types Authority Schema `. + +.. literalinclude:: schema.json + :language: json diff --git a/doc/source/schema.json b/doc/source/schema.json new file mode 120000 index 0000000..3a5f772 --- /dev/null +++ b/doc/source/schema.json @@ -0,0 +1 @@ +../../schema.json \ No newline at end of file diff --git a/doc/source/service-types.yaml b/doc/source/service-types.yaml new file mode 120000 index 0000000..58957d0 --- /dev/null +++ b/doc/source/service-types.yaml @@ -0,0 +1 @@ +../../service-types.yaml \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..64853bb --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +hacking +jsonschema +PyYAML>=3.10.0 # MIT +oslosphinx>=4.7.0 # Apache-2.0 +sphinx>=1.5.1 # BSD diff --git a/schema.json b/schema.json new file mode 100644 index 0000000..8c954f1 --- /dev/null +++ b/schema.json @@ -0,0 +1,53 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "id": "https://specs.openstack.org/openstack/service-types-authority/_downloads/schema.json#", + "type": "object", + "required": ["services"], + "additionalProperties": false, + "properties": { + "services": { + "type": "array", + "items": { + "$ref": "#/definitions/service" + } + } + }, + "definitions":{ + "service":{ + "properties": { + "service_type": { + "type":"string", + "pattern":"^[a-z][a-z-]+$", + "description": "The unique identifier for the service to be used in the service catalog" + }, + "project": { + "type":"string", + "description": "An OpenStack git project that contains the definition of the API" + }, + "api_reference": { + "type":"string", + "format": "url", + "description": "A published API reference document for the API identified by this service type." + }, + "description": { + "type":"string", + "description": "A short description about the service in question." + }, + "aliases": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[a-z]+$" + }, + "description": "An ordered list of historical aliases for this service type." + } + }, + "additionalProperties":false, + "required":[ + "api_reference", + "project", + "service_type" + ] + } + } +} diff --git a/service-types.yaml b/service-types.yaml index aa453f3..6888533 100644 --- a/service-types.yaml +++ b/service-types.yaml @@ -1,18 +1,18 @@ services: - identity: - project: openstack/keystone - # TODO(sdague): this should be an overall pointer to the service - # API, this is just a subset. - api_reference: http://developer.openstack.org/api-ref/identity/v3/index.html - compute: - project: openstack/nova - api_reference: http://developer.openstack.org/api-ref/compute/ - image: - project: openstack/glance - api_reference: http://developer.openstack.org/api-ref/image/ - load-balancer: - project: openstack/octavia - api_reference: http://developer.openstack.org/api-ref/load-balancer/ - object-store: - project: openstack/swift - api_reference: http://developer.openstack.org/api-ref/object-storage/ +- service_type: identity + project: openstack/keystone + # TODO(sdague): this should be an overall pointer to the service + # API, this is just a subset. + api_reference: http://developer.openstack.org/api-ref/identity/v3/index.html +- service_type: compute + project: openstack/nova + api_reference: http://developer.openstack.org/api-ref/compute/ +- service_type: image + project: openstack/glance + api_reference: http://developer.openstack.org/api-ref/image/ +- service_type: load-balancer + project: openstack/octavia + api_reference: http://developer.openstack.org/api-ref/load-balancer/ +- service_type: object-store + project: openstack/swift + api_reference: http://developer.openstack.org/api-ref/object-storage/ diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..d1b01a2 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,32 @@ +[metadata] +name = service_types_authority +summary = OpenStack Service Types Authority +description-file = + README.rst +author = OpenStack +author-email = openstack-dev@lists.openstack.org +home-page = http://git.openstack.org/cgit/openstack/service-types-authority +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + +[egg_info] +tag_build = +tag_date = 0 +tag_svn_revision = 0 + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source + +[wheel] +universal = 1 + +[pbr] +# Treat sphinx warnings as errors during the docs build; this helps us keep +# the documentation clean. +warnerrors = true diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..782bb21 --- /dev/null +++ b/setup.py @@ -0,0 +1,29 @@ +# 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 + +# In python < 2.7.4, a lazy loading of package `pbr` will break +# setuptools if some other modules registered functions in `atexit`. +# solution from: http://bugs.python.org/issue15881#msg170215 +try: + import multiprocessing # noqa +except ImportError: + pass + +setuptools.setup( + setup_requires=['pbr>=1.8'], + pbr=True) diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..3371e05 --- /dev/null +++ b/tox.ini @@ -0,0 +1,30 @@ +[tox] +minversion = 1.6 +envlist = pep8,validate,docs +skipdist = True + +[testenv] +install_command = pip install -U {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} +deps = -r{toxinidir}/requirements.txt + +[testenv:validate] +deps = jsonschema +commands = + python validate.py + +[testenv:pep8] +deps = hacking +commands = flake8 + +[testenv:docs] +commands = python setup.py build_sphinx + +[testenv:venv] +commands = {posargs} + +[flake8] +show-source = True +builtins = _ +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build diff --git a/validate.py b/validate.py new file mode 100644 index 0000000..b84d4d0 --- /dev/null +++ b/validate.py @@ -0,0 +1,35 @@ +# Copyright (c) 2017 Red Hat, 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. + +import json +import sys + +import jsonschema +import yaml + + +def main(): + ret = 0 + schema = json.load(open('schema.json', 'r')) + validator = jsonschema.Draft4Validator(schema) + data = yaml.load(open('service-types.yaml', 'r')) + for error in validator.iter_errors(data): + print(error.message) + ret = 1 + return ret + + +if __name__ == '__main__': + sys.exit(main())