Add initial Zun API documentation

This patch adds the initial Zun API reference
documents and also add the /v1/services API documents.

Change-Id: I5ae6e313bce7d44fc1e42b982b4446123281c8d8
Partial-Implement: blueprint zun-api-doc

api-ref/source/conf.py

@@ -0,0 +1,238 @@
+# -*- 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.
+#
+# Zun documentation build configuration file
+#
+# 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 os
+import subprocess
+import sys
+import warnings
+
+extensions = [
+    'os_api_ref',
+]
+
+import openstackdocstheme  # noqa
+
+html_theme = 'openstackdocs'
+html_theme_path = [openstackdocstheme.get_html_theme_path()]
+html_theme_options = {
+    "sidebar_mode": "toc",
+}
+
+# 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('../../'))
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('./'))
+
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#
+# source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Container Management Service API Reference'
+copyright = u'2010-present, OpenStack Foundation'
+
+# 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.
+#
+from zun.version import version_info
+# The full version, including alpha/beta/rc tags.
+release = version_info.release_string()
+# The short X.Y version.
+version = version_info.version_string()
+
+# 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'
+
+# 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'
+
+# Config logABug feature
+# source tree
+giturl = (
+    u'http://git.openstack.org/cgit/openstack/zun/tree/api-ref/source')
+# html_context allows us to pass arbitrary values into the html template
+html_context = {'bug_tag': 'api-ref',
+                'giturl': giturl,
+                'bug_project': 'zun'}
+
+# -- Options for man page output ----------------------------------------------
+
+# Grouping the document tree for man pages.
+# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
+
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+
+# 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
+# "<project> v<release> 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']
+
+# 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'
+git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
+           "-n1"]
+try:
+    html_last_updated_fmt = subprocess.Popen(
+        git_cmd, stdout=subprocess.PIPE).communicate()[0].decode()
+except Exception:
+    warnings.warn('Cannot get last updated time from git repository. '
+                  'Not setting "html_last_updated_fmt".')
+
+# 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_use_modindex = 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, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'zundoc'
+
+
+# -- Options for LaTeX output -------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+# latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+# latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index', 'Zun.tex',
+     u'OpenStack Container Management Service API Documentation',
+     u'OpenStack Foundation', '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
+
+# Additional stuff for the LaTeX preamble.
+# latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_use_modindex = True

api-ref/source/index.rst

@@ -0,0 +1,12 @@
+:tocdepth: 2
+
+=================================
+ Container Management Service API
+=================================
+
+.. rest_expand_all::
+
+.. include:: urls.inc
+.. include:: containers.inc
+.. include:: images.inc
+.. include:: services.inc

api-ref/source/parameters.yaml

@@ -0,0 +1,103 @@
+request_id:
+  type: UUID
+  in: header
+  required: true
+  description: |
+    A unique ID for tracking service request. The request ID associated
+    with the request by default appears in the service logs.
+binary:
+  type: string
+  in: body
+  required: true
+  description: |
+    The name of the binary form of the Zun service.
+created_at:
+  description: |
+    The date and time when the resource was created.
+
+    The date and time stamp format is `ISO 8601
+    <https://en.wikipedia.org/wiki/ISO_8601>`_:
+
+    ::
+
+       CCYY-MM-DDThh:mm:ss±hh:mm
+
+    For example, ``2015-08-27T09:49:58-05:00``.
+
+    The ``±hh:mm`` value, if included, is the time zone as an offset
+    from UTC.
+  in: body
+  required: true
+  type: string
+disabled:
+  description: |
+     Whether or not this service is disabled or not.
+  in: body
+  required: true
+  type: boolean
+disabled_reason:
+  description: |
+    The disable reason of the service, ``null`` if the service is enabled or
+    disabled without reason provided.
+  in: body
+  required: true
+  type: string
+forced_down:
+  description: |
+    Whether or not this service was forced down manually by an
+    administrator. This value is useful to know that some 3rd party has
+    verified the service should be marked down.
+  in: body
+  required: true
+  type: boolean
+host:
+  description: |
+    The host for the service.
+  in: body
+  required: true
+  type: string
+id_s:
+  description: |
+    The ID of the Zun service.
+  in: body
+  required: true
+  type: string
+report_count:
+  description: |
+    The total number of report.
+  in: body
+  required: true
+  type: integer
+services:
+  description: |
+    A list of Zun services.
+  in: body
+  required: true
+  type: array
+state:
+  description: |
+    The current state of Zun services.
+  in: body
+  required: true
+  type: string
+updated_at:
+  description: |
+    The date and time when the resource was updated.
+
+    The date and time stamp format is `ISO 8601
+    <https://en.wikipedia.org/wiki/ISO_8601>`_:
+
+    ::
+
+       CCYY-MM-DDThh:mm:ss±hh:mm
+
+    For example, ``2015-08-27T09:49:58-05:00``.
+
+    The ``±hh:mm`` value, if included, is the time zone as an offset
+    from UTC. In the previous example, the offset value is ``-05:00``.
+
+    If the ``updated_at`` date and time stamp is not set, its value is
+    ``null``.
+  in: body
+  required: true
+  type: string

api-ref/source/samples/service-get-resp.json

@@ -0,0 +1,17 @@
+{
+    "services":[
+      {
+        "binary":"zun-compute",
+        "state":"up",
+        "created_at":"2017-02-01 03:25:07+00:00",
+        "updated_at":"2017-02-01 06:13:07+00:00",
+        "report_count":166,
+        "disabled":false,
+        "host":"instance-1",
+        "forced_down":false,
+        "last_seen_up":"2017-02-01 06:13:07+00:00",
+        "disabled_reason":null,
+        "id": 1
+      }
+    ]
+}

api-ref/source/services.inc

@@ -0,0 +1,50 @@
+.. -*- rst -*-
+
+==================
+Manage Zun service
+==================
+
+Show container management service status
+========================================
+
+.. rest_method::  GET /v1/services
+
+Enables administrative users to view details for all Zun services.
+
+Container management service status details include service id, binary,
+host, report count, creation time, last updated time, health status, and
+the reason for disabling service.
+
+Response Codes
+--------------
+
+.. rest_status_code:: success status.yaml
+
+   - 200
+
+.. rest_status_code:: error status.yaml
+
+   - 401
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+   - X-Openstack-Request-Id: request_id
+   - services: services
+   - binary: binary
+   - created_at: created_at
+   - state: state
+   - report_count: report_count
+   - updated_at: updated_at
+   - host: host
+   - disabled_reason: disabled_reason
+   - id: id_s
+
+Response Example
+----------------
+
+.. literalinclude:: samples/service-get-resp.json
+   :language: javascript
+

api-ref/source/status.yaml

@@ -0,0 +1,61 @@
+#################
+# Success Codes #
+#################
+200:
+  default: |
+    Request was successful.
+201:
+  default: |
+    Resource was created and is ready to use.
+202:
+  default: |
+    Request was accepted for processing, but the processing has not been
+    completed. A 'location' header is included in the response which contains
+    a link to check the progress of the request.
+204:
+  default: |
+    The server has fulfilled the request by deleting the resource.
+300:
+  default: |
+    There are multiple choices for resources. The request has to be more
+    specific to successfully retrieve one of these resources.
+302:
+  default: |
+    The response is about a redirection hint. The header of the response
+    usually contains a 'location' value where requesters can check to track
+    the real location of the resource.
+#################
+#  Error Codes  #
+#################
+
+400:
+  default: |
+    Some content in the request was invalid.
+  resource_signal: |
+    The target resource doesn't support receiving a signal.
+401:
+  default: |
+    User must authenticate before making a request.
+403:
+  default: |
+    Policy does not allow current user to do this operation.
+404:
+  default: |
+    The requested resource could not be found.
+405:
+  default: |
+    Method is not valid for this endpoint.
+409:
+ default: |
+    This operation conflicted with another operation on this resource.
+ duplicate_zone: |
+    There is already a zone with this name.
+500:
+  default: |
+    Something went wrong inside the service. This should not happen usually.
+    If it does happen, it means the server has experienced some serious
+    problems.
+503:
+  default: |
+    Service is not available. This is mostly caused by service configuration
+    errors which prevents the service from successful start up.

api-ref/source/urls.inc

@@ -0,0 +1,31 @@
+.. -*- rst -*-
+
+=================
+ Zun Base URLs
+=================
+
+All API calls through the rest of this document require authentication
+with the OpenStack Identity service. They also required a ``url`` that
+is extracted from the Identity token of type
+``container``. This will be the root url that every call below will be
+added to build a full path.
+
+Note that if using OpenStack Identity service API v2, ``url`` can be
+represented via ``adminURL``, ``internalURL`` or ``publicURL`` in endpoint
+catalog. In Identity service API v3, ``url`` is represented with field
+``interface`` including ``admin``, ``internal`` and ``public``.
+
+For instance, if the ``url`` is
+``http://my-zun-url.org/zun/v1`` then the full API call for
+``/containers`` is ``http://my-zun-url.org/zun/v1/containers``.
+
+Depending on the deployment the container management service
+url might be http or https, a custom port, a custom path, and include your
+project id. The only way to know the urls for your deployment is by using the
+service catalog. The container management service URL should never be
+hard coded in applications, even if they are only expected to work at a
+single site. It should always be discovered from the Identity token.
+
+As such, for the rest of this document we will be using short hand
+where ``GET /containers`` really means
+``GET {your_zun_url}/containers``.

test-requirements.txt

@@ -19,3 +19,4 @@ testrepository>=0.0.18 # Apache-2.0/BSD
 testscenarios>=0.4 # Apache-2.0/BSD
 testtools>=1.4.0 # MIT
 reno>=1.8.0 # Apache-2.0
+os-api-ref>=1.0.0 # Apache-2.0

tox.ini

@@ -66,3 +66,11 @@ commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasen
 envdir = {toxworkdir}/venv
 commands =
     oslo-config-generator --config-file etc/zun/zun-config-generator.conf
+
+# we do not used -W here because we are doing some slightly tricky
+# things to build a single page document, and as such, we are ok
+# ignoring the duplicate stanzas warning.
+[testenv:api-ref]
+commands =
+  rm -rf api-ref/build
+  sphinx-build -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html