From 016bd6aa56d0c37a594b0e8fc7e60d7d4ed616c6 Mon Sep 17 00:00:00 2001 From: James Page Date: Mon, 19 Jun 2017 10:15:07 +0100 Subject: [PATCH] Initial baseline --- .tox/log/tox-0.log | 21 ++ deploy-guide/source/common_configure.rst | 10 + deploy-guide/source/common_prerequisites.rst | 75 +++++ deploy-guide/source/conf.py | 301 +++++++++++++++++++ deploy-guide/source/get_started.rst | 9 + deploy-guide/source/index.rst | 17 ++ deploy-guide/source/install-obs.rst | 34 +++ deploy-guide/source/install-rdo.rst | 33 ++ deploy-guide/source/install-ubuntu.rst | 31 ++ deploy-guide/source/install.rst | 20 ++ deploy-guide/source/next-steps.rst | 9 + deploy-guide/source/verify.rst | 24 ++ setup.cfg | 23 ++ setup.py | 21 ++ test-requirements.txt | 1 + tox.ini | 2 + 16 files changed, 631 insertions(+) create mode 100644 .tox/log/tox-0.log create mode 100644 deploy-guide/source/common_configure.rst create mode 100644 deploy-guide/source/common_prerequisites.rst create mode 100644 deploy-guide/source/conf.py create mode 100644 deploy-guide/source/get_started.rst create mode 100644 deploy-guide/source/index.rst create mode 100644 deploy-guide/source/install-obs.rst create mode 100644 deploy-guide/source/install-rdo.rst create mode 100644 deploy-guide/source/install-ubuntu.rst create mode 100644 deploy-guide/source/install.rst create mode 100644 deploy-guide/source/next-steps.rst create mode 100644 deploy-guide/source/verify.rst create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.tox/log/tox-0.log b/.tox/log/tox-0.log new file mode 100644 index 0000000..f3985d5 --- /dev/null +++ b/.tox/log/tox-0.log @@ -0,0 +1,21 @@ +actionid: tox +msg: packaging +cmdargs: ['/usr/bin/python3', local('/home/jamespage/src/charms/openstack/docs/charm-deployment-guide/setup.py'), 'sdist', '--formats=zip', '--dist-dir', local('/home/jamespage/src/charms/openstack/docs/charm-deployment-guide/.tox/dist')] +env: None + +ERROR:root:Error parsing +Traceback (most recent call last): + File "/home/jamespage/.local/lib/python3.5/site-packages/pbr/core.py", line 111, in pbr + attrs = util.cfg_to_args(path, dist.script_args) + File "/home/jamespage/.local/lib/python3.5/site-packages/pbr/util.py", line 249, in cfg_to_args + pbr.hooks.setup_hook(config) + File "/home/jamespage/.local/lib/python3.5/site-packages/pbr/hooks/__init__.py", line 25, in setup_hook + metadata_config.run() + File "/home/jamespage/.local/lib/python3.5/site-packages/pbr/hooks/base.py", line 27, in run + self.hook() + File "/home/jamespage/.local/lib/python3.5/site-packages/pbr/hooks/metadata.py", line 26, in hook + self.config['name'], self.config.get('version', None)) + File "/home/jamespage/.local/lib/python3.5/site-packages/pbr/packaging.py", line 750, in get_version + name=package_name)) +Exception: Versioning for this project requires either an sdist tarball, or access to an upstream git repository. It's also possible that there is a mismatch between the package name in setup.cfg and the argument given to pbr.version.VersionInfo. Project name charm-deployment-guide was given, but was not able to be found. +error in setup command: Error parsing /home/jamespage/src/charms/openstack/docs/charm-deployment-guide/setup.cfg: Exception: Versioning for this project requires either an sdist tarball, or access to an upstream git repository. It's also possible that there is a mismatch between the package name in setup.cfg and the argument given to pbr.version.VersionInfo. Project name charm-deployment-guide was given, but was not able to be found. diff --git a/deploy-guide/source/common_configure.rst b/deploy-guide/source/common_configure.rst new file mode 100644 index 0000000..6053095 --- /dev/null +++ b/deploy-guide/source/common_configure.rst @@ -0,0 +1,10 @@ +2. Edit the ``/etc/charms/charms.conf`` file and complete the following + actions: + + * In the ``[database]`` section, configure database access: + + .. code-block:: ini + + [database] + ... + connection = mysql+pymysql://charms:CHARMS_DBPASS@controller/charms diff --git a/deploy-guide/source/common_prerequisites.rst b/deploy-guide/source/common_prerequisites.rst new file mode 100644 index 0000000..294fe8a --- /dev/null +++ b/deploy-guide/source/common_prerequisites.rst @@ -0,0 +1,75 @@ +Prerequisites +------------- + +Before you install and configure the charms service, +you must create a database, service credentials, and API endpoints. + +#. To create the database, complete these steps: + + * Use the database access client to connect to the database + server as the ``root`` user: + + .. code-block:: console + + $ mysql -u root -p + + * Create the ``charms`` database: + + .. code-block:: none + + CREATE DATABASE charms; + + * Grant proper access to the ``charms`` database: + + .. code-block:: none + + GRANT ALL PRIVILEGES ON charms.* TO 'charms'@'localhost' \ + IDENTIFIED BY 'CHARMS_DBPASS'; + GRANT ALL PRIVILEGES ON charms.* TO 'charms'@'%' \ + IDENTIFIED BY 'CHARMS_DBPASS'; + + Replace ``CHARMS_DBPASS`` with a suitable password. + + * Exit the database access client. + + .. code-block:: none + + exit; + +#. Source the ``admin`` credentials to gain access to + admin-only CLI commands: + + .. code-block:: console + + $ . admin-openrc + +#. To create the service credentials, complete these steps: + + * Create the ``charms`` user: + + .. code-block:: console + + $ openstack user create --domain default --password-prompt charms + + * Add the ``admin`` role to the ``charms`` user: + + .. code-block:: console + + $ openstack role add --project service --user charms admin + + * Create the charms service entities: + + .. code-block:: console + + $ openstack service create --name charms --description "charms" charms + +#. Create the charms service API endpoints: + + .. code-block:: console + + $ openstack endpoint create --region RegionOne \ + charms public http://controller:XXXX/vY/%\(tenant_id\)s + $ openstack endpoint create --region RegionOne \ + charms internal http://controller:XXXX/vY/%\(tenant_id\)s + $ openstack endpoint create --region RegionOne \ + charms admin http://controller:XXXX/vY/%\(tenant_id\)s diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py new file mode 100644 index 0000000..6d5aa94 --- /dev/null +++ b/deploy-guide/source/conf.py @@ -0,0 +1,301 @@ +# 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 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 sys + + +import openstackdocstheme + +# 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. +# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' +# extensions = + +# 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'Installation Guide for charms Service' +bug_tag = u'install-guide' +copyright = u'2016, OpenStack contributors' + +# 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.1' +# The full version, including alpha/beta/rc tags. +release = '0.1' + +# A few variables have to be set for the log-a-bug feature. +# giturl: The location of conf.py on Git. Must be set manually. +# gitsha: The SHA checksum of the bug description. Automatically extracted +# from git log. +# bug_tag: Tag for categorizing the bug. Must be set manually. +# These variables are passed to the logabug code via html_context. +giturl = u'http://git.openstack.org/cgit/openstack/charms/tree/install-guide/source' # noqa +git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" +gitsha = os.popen(git_cmd).read().strip('\n') +html_context = {"gitsha": gitsha, "bug_tag": bug_tag, + "giturl": giturl, + "bug_project": "charms"} + +# 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 = ["common_prerequisites.rst", "common_configure.rst"] + +# 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 = 'openstackdocs' + +# 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 = [openstackdocstheme.get_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 = [] + +# 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. +# So that we can enable "log-a-bug" links from each output HTML page, this +# variable must be set to a format that includes year, month, day, hours and +# minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + + +# 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 = 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 = False + +# 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 = 'install-guide' + +# If true, publish source files +html_copy_source = False + +# -- 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, or own class]). +latex_documents = [ + ('index', 'InstallGuide.tex', u'Install Guide', + u'OpenStack contributors', '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', 'installguide', u'Install Guide', + [u'OpenStack contributors'], 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', 'InstallGuide', u'Install Guide', + u'OpenStack contributors', 'InstallGuide', + 'This guide shows OpenStack end users how to install ' + 'an OpenStack cloud.', '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 + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] + +# -- Options for PDF output -------------------------------------------------- + +pdf_documents = [ + ('index', u'InstallGuide', u'Install Guide', + u'OpenStack contributors') +] diff --git a/deploy-guide/source/get_started.rst b/deploy-guide/source/get_started.rst new file mode 100644 index 0000000..8a57e67 --- /dev/null +++ b/deploy-guide/source/get_started.rst @@ -0,0 +1,9 @@ +======================= +charms service overview +======================= +The charms service provides... + +The charms service consists of the following components: + +``charms-api`` service + Accepts and responds to end user compute API calls... diff --git a/deploy-guide/source/index.rst b/deploy-guide/source/index.rst new file mode 100644 index 0000000..ff96711 --- /dev/null +++ b/deploy-guide/source/index.rst @@ -0,0 +1,17 @@ +============== +charms service +============== + +.. toctree:: + :maxdepth: 2 + + get_started.rst + install.rst + verify.rst + next-steps.rst + +The charms service (charms) provides... + +This chapter assumes a working setup of OpenStack following the +`OpenStack Installation Tutorial +`_. diff --git a/deploy-guide/source/install-obs.rst b/deploy-guide/source/install-obs.rst new file mode 100644 index 0000000..49ebcab --- /dev/null +++ b/deploy-guide/source/install-obs.rst @@ -0,0 +1,34 @@ +.. _install-obs: + + +Install and configure for openSUSE and SUSE Linux Enterprise +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This section describes how to install and configure the charms service +for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1. + +.. include:: common_prerequisites.rst + +Install and configure components +-------------------------------- + +#. Install the packages: + + .. code-block:: console + + # zypper --quiet --non-interactive install + +.. include:: common_configure.rst + + +Finalize installation +--------------------- + +Start the charms services and configure them to start when +the system boots: + +.. code-block:: console + + # systemctl enable openstack-charms-api.service + + # systemctl start openstack-charms-api.service diff --git a/deploy-guide/source/install-rdo.rst b/deploy-guide/source/install-rdo.rst new file mode 100644 index 0000000..4fa02a2 --- /dev/null +++ b/deploy-guide/source/install-rdo.rst @@ -0,0 +1,33 @@ +.. _install-rdo: + +Install and configure for Red Hat Enterprise Linux and CentOS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +This section describes how to install and configure the charms service +for Red Hat Enterprise Linux 7 and CentOS 7. + +.. include:: common_prerequisites.rst + +Install and configure components +-------------------------------- + +#. Install the packages: + + .. code-block:: console + + # yum install + +.. include:: common_configure.rst + +Finalize installation +--------------------- + +Start the charms services and configure them to start when +the system boots: + +.. code-block:: console + + # systemctl enable openstack-charms-api.service + + # systemctl start openstack-charms-api.service diff --git a/deploy-guide/source/install-ubuntu.rst b/deploy-guide/source/install-ubuntu.rst new file mode 100644 index 0000000..e2393ee --- /dev/null +++ b/deploy-guide/source/install-ubuntu.rst @@ -0,0 +1,31 @@ +.. _install-ubuntu: + +Install and configure for Ubuntu +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This section describes how to install and configure the charms +service for Ubuntu 14.04 (LTS). + +.. include:: common_prerequisites.rst + +Install and configure components +-------------------------------- + +#. Install the packages: + + .. code-block:: console + + # apt-get update + + # apt-get install + +.. include:: common_configure.rst + +Finalize installation +--------------------- + +Restart the charms services: + +.. code-block:: console + + # service openstack-charms-api restart diff --git a/deploy-guide/source/install.rst b/deploy-guide/source/install.rst new file mode 100644 index 0000000..eb854f3 --- /dev/null +++ b/deploy-guide/source/install.rst @@ -0,0 +1,20 @@ +.. _install: + +Install and configure +~~~~~~~~~~~~~~~~~~~~~ + +This section describes how to install and configure the +charms service, code-named charms, on the controller node. + +This section assumes that you already have a working OpenStack +environment with at least the following components installed: +.. (add the appropriate services here and further notes) + +Note that installation and configuration vary by distribution. + +.. toctree:: + :maxdepth: 2 + + install-obs.rst + install-rdo.rst + install-ubuntu.rst diff --git a/deploy-guide/source/next-steps.rst b/deploy-guide/source/next-steps.rst new file mode 100644 index 0000000..2216225 --- /dev/null +++ b/deploy-guide/source/next-steps.rst @@ -0,0 +1,9 @@ +.. _next-steps: + +Next steps +~~~~~~~~~~ + +Your OpenStack environment now includes the charms service. + +To add additional services, see +https://docs.openstack.org/project-install-guide/ocata/. diff --git a/deploy-guide/source/verify.rst b/deploy-guide/source/verify.rst new file mode 100644 index 0000000..a2a937c --- /dev/null +++ b/deploy-guide/source/verify.rst @@ -0,0 +1,24 @@ +.. _verify: + +Verify operation +~~~~~~~~~~~~~~~~ + +Verify operation of the charms service. + +.. note:: + + Perform these commands on the controller node. + +#. Source the ``admin`` project credentials to gain access to + admin-only CLI commands: + + .. code-block:: console + + $ . admin-openrc + +#. List service components to verify successful launch and registration + of each process: + + .. code-block:: console + + $ openstack charms service list diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..d81eb55 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,23 @@ +[metadata] +name = charm-deployment-guide +summary = OpenStack Charm Deployment Guide +description-file = + README.rst +author = OpenStack +author-email = openstack@lists.openstack.org +home-page = https://docs.openstack.org/project-deploy-guide/charm-deployment-guide +classifier = + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source + +[pbr] +warnerrors = True + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..c0a24ea --- /dev/null +++ b/setup.py @@ -0,0 +1,21 @@ +#!/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. + +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..d71247c --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1 @@ +openstackdocstheme>=1.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..198d846 --- /dev/null +++ b/tox.ini @@ -0,0 +1,2 @@ +[testenv:deploy-guide] +commands = sphinx-build -a -E -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html