From 6f73e1681f869ef6c7a0b711d70f7b01f750af9b Mon Sep 17 00:00:00 2001 From: James Page Date: Mon, 19 Jun 2017 10:17:32 +0100 Subject: [PATCH] Extra bits --- .gitignore | 20 ++ .tox/log/tox-0.log | 21 -- LICENSE | 202 ++++++++++++++++++ README.rst | 0 deploy-guide/source/about.rst | 12 ++ .../source/{next-steps.rst => appendices.rst} | 0 deploy-guide/source/architecture.rst | 4 + deploy-guide/source/charms.rst | 6 + deploy-guide/source/common_configure.rst | 10 - deploy-guide/source/common_prerequisites.rst | 75 ------- deploy-guide/source/conf.py | 18 +- deploy-guide/source/configure_deployment.rst | 4 + deploy-guide/source/deploy.rst | 4 + deploy-guide/source/deployment_workflow.rst | 4 + deploy-guide/source/get_started.rst | 9 - deploy-guide/source/index.rst | 23 +- 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/installation.rst | 0 deploy-guide/source/juju.rst | 6 + deploy-guide/source/lxd.rst | 6 + deploy-guide/source/maas.rst | 6 + deploy-guide/source/overview.rst | 11 + deploy-guide/source/prepare_env.rst | 4 + deploy-guide/source/verify.rst | 24 +-- requirements.txt | 4 + test-requirements.txt | 1 - tox.ini | 17 +- 30 files changed, 331 insertions(+), 278 deletions(-) create mode 100644 .gitignore delete mode 100644 .tox/log/tox-0.log create mode 100644 LICENSE create mode 100644 README.rst create mode 100644 deploy-guide/source/about.rst rename deploy-guide/source/{next-steps.rst => appendices.rst} (100%) create mode 100644 deploy-guide/source/architecture.rst create mode 100644 deploy-guide/source/charms.rst delete mode 100644 deploy-guide/source/common_configure.rst delete mode 100644 deploy-guide/source/common_prerequisites.rst create mode 100644 deploy-guide/source/configure_deployment.rst create mode 100644 deploy-guide/source/deploy.rst create mode 100644 deploy-guide/source/deployment_workflow.rst delete mode 100644 deploy-guide/source/get_started.rst delete mode 100644 deploy-guide/source/install-obs.rst delete mode 100644 deploy-guide/source/install-rdo.rst delete mode 100644 deploy-guide/source/install-ubuntu.rst delete mode 100644 deploy-guide/source/install.rst create mode 100644 deploy-guide/source/installation.rst create mode 100644 deploy-guide/source/juju.rst create mode 100644 deploy-guide/source/lxd.rst create mode 100644 deploy-guide/source/maas.rst create mode 100644 deploy-guide/source/overview.rst create mode 100644 deploy-guide/source/prepare_env.rst create mode 100644 requirements.txt delete mode 100644 test-requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f4b0cd7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +# Testenvironment +.tox/* + +# Build directories +*/build/* + +# generated during doc builds +AUTHORS +ChangeLog + +# Packages +*.egg-info/* + +# Editors +*~ +.*.swp +.bak + +# For Mac Users +.DS_Store diff --git a/.tox/log/tox-0.log b/.tox/log/tox-0.log deleted file mode 100644 index f3985d5..0000000 --- a/.tox/log/tox-0.log +++ /dev/null @@ -1,21 +0,0 @@ -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/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + 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 "[]" + 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 + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + 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. + 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/README.rst b/README.rst new file mode 100644 index 0000000..e69de29 diff --git a/deploy-guide/source/about.rst b/deploy-guide/source/about.rst new file mode 100644 index 0000000..711fc79 --- /dev/null +++ b/deploy-guide/source/about.rst @@ -0,0 +1,12 @@ +.. _about: + +About OpenStack Charms +~~~~~~~~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + charms.rst + juju.rst + maas.rst + lxd.rst diff --git a/deploy-guide/source/next-steps.rst b/deploy-guide/source/appendices.rst similarity index 100% rename from deploy-guide/source/next-steps.rst rename to deploy-guide/source/appendices.rst diff --git a/deploy-guide/source/architecture.rst b/deploy-guide/source/architecture.rst new file mode 100644 index 0000000..845440d --- /dev/null +++ b/deploy-guide/source/architecture.rst @@ -0,0 +1,4 @@ +.. _architecture: + +Deployment architecture +~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/deploy-guide/source/charms.rst b/deploy-guide/source/charms.rst new file mode 100644 index 0000000..6000ea8 --- /dev/null +++ b/deploy-guide/source/charms.rst @@ -0,0 +1,6 @@ +.. _charms: + +Charms +~~~~~~ + +TODO: general overview of charms in the context of this project. diff --git a/deploy-guide/source/common_configure.rst b/deploy-guide/source/common_configure.rst deleted file mode 100644 index 6053095..0000000 --- a/deploy-guide/source/common_configure.rst +++ /dev/null @@ -1,10 +0,0 @@ -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 deleted file mode 100644 index 294fe8a..0000000 --- a/deploy-guide/source/common_prerequisites.rst +++ /dev/null @@ -1,75 +0,0 @@ -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 index 6d5aa94..05ae958 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -55,8 +55,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Installation Guide for charms Service' -bug_tag = u'install-guide' +project = u'OpenStack Charms Deployment Guide' +bug_tag = u'deployment-guide' copyright = u'2016, OpenStack contributors' # The version info for the project you're documenting, acts as replacement for @@ -74,12 +74,12 @@ release = '0.1' # 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 +giturl = u'http://git.openstack.org/cgit/openstack/charm-deployment-guide/tree/deploy-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"} + "bug_project": "charm-deployment-guide"} # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -228,7 +228,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'InstallGuide.tex', u'Install Guide', + ('index', 'DeploymentGuide.tex', u'Deployment Guide', u'OpenStack contributors', 'manual'), ] @@ -258,7 +258,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'installguide', u'Install Guide', + ('index', 'deploymentguide', u'Deployment Guide', [u'OpenStack contributors'], 1) ] @@ -272,8 +272,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'InstallGuide', u'Install Guide', - u'OpenStack contributors', 'InstallGuide', + ('index', 'DeploymentGuide', u'Deployment Guide', + u'OpenStack contributors', 'DeploymentGuide', 'This guide shows OpenStack end users how to install ' 'an OpenStack cloud.', 'Miscellaneous'), ] @@ -296,6 +296,6 @@ locale_dirs = ['locale/'] # -- Options for PDF output -------------------------------------------------- pdf_documents = [ - ('index', u'InstallGuide', u'Install Guide', + ('index', u'DeploymentGuide', u'Deployment Guide', u'OpenStack contributors') ] diff --git a/deploy-guide/source/configure_deployment.rst b/deploy-guide/source/configure_deployment.rst new file mode 100644 index 0000000..dea3c66 --- /dev/null +++ b/deploy-guide/source/configure_deployment.rst @@ -0,0 +1,4 @@ +.. _configure_deployment: + +Configure the deployment +~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/deploy-guide/source/deploy.rst b/deploy-guide/source/deploy.rst new file mode 100644 index 0000000..f7486bf --- /dev/null +++ b/deploy-guide/source/deploy.rst @@ -0,0 +1,4 @@ +.. _deploy: + +Deploy +~~~~~~ diff --git a/deploy-guide/source/deployment_workflow.rst b/deploy-guide/source/deployment_workflow.rst new file mode 100644 index 0000000..9a810de --- /dev/null +++ b/deploy-guide/source/deployment_workflow.rst @@ -0,0 +1,4 @@ +.. _deployment_workflow: + +Deployment workflow +~~~~~~~~~~~~~~~~~~~ diff --git a/deploy-guide/source/get_started.rst b/deploy-guide/source/get_started.rst deleted file mode 100644 index 8a57e67..0000000 --- a/deploy-guide/source/get_started.rst +++ /dev/null @@ -1,9 +0,0 @@ -======================= -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 index ff96711..78a9ce8 100644 --- a/deploy-guide/source/index.rst +++ b/deploy-guide/source/index.rst @@ -1,17 +1,16 @@ -============== -charms service -============== +================================= +OpenStack Charms Deployment Guide +================================= + +This guide provides instructions for performing a deployment of +OpenStack using the OpenStack Charms with Juju and MAAS. .. toctree:: :maxdepth: 2 - get_started.rst - install.rst + overview.rst + prepare_env.rst + configure_deployment.rst + deploy.rst verify.rst - next-steps.rst - -The charms service (charms) provides... - -This chapter assumes a working setup of OpenStack following the -`OpenStack Installation Tutorial -`_. + appendices.rst diff --git a/deploy-guide/source/install-obs.rst b/deploy-guide/source/install-obs.rst deleted file mode 100644 index 49ebcab..0000000 --- a/deploy-guide/source/install-obs.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. _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 deleted file mode 100644 index 4fa02a2..0000000 --- a/deploy-guide/source/install-rdo.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. _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 deleted file mode 100644 index e2393ee..0000000 --- a/deploy-guide/source/install-ubuntu.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _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 deleted file mode 100644 index eb854f3..0000000 --- a/deploy-guide/source/install.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _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/installation.rst b/deploy-guide/source/installation.rst new file mode 100644 index 0000000..e69de29 diff --git a/deploy-guide/source/juju.rst b/deploy-guide/source/juju.rst new file mode 100644 index 0000000..26ccadf --- /dev/null +++ b/deploy-guide/source/juju.rst @@ -0,0 +1,6 @@ +.. _juju: + +Juju +~~~~ + +TODO: general overview of juju in the context of this project. diff --git a/deploy-guide/source/lxd.rst b/deploy-guide/source/lxd.rst new file mode 100644 index 0000000..17de69d --- /dev/null +++ b/deploy-guide/source/lxd.rst @@ -0,0 +1,6 @@ +.. _lxd: + +LXD +~~~ + +TODO: general overview of LXD in the context of this project. diff --git a/deploy-guide/source/maas.rst b/deploy-guide/source/maas.rst new file mode 100644 index 0000000..458403e --- /dev/null +++ b/deploy-guide/source/maas.rst @@ -0,0 +1,6 @@ +.. _maas: + +MAAS +~~~~ + +TODO: general overview of MAAS in the context of this project. diff --git a/deploy-guide/source/overview.rst b/deploy-guide/source/overview.rst new file mode 100644 index 0000000..d6d1009 --- /dev/null +++ b/deploy-guide/source/overview.rst @@ -0,0 +1,11 @@ +.. _overview: + +Overview +~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + about.rst + architecture.rst + deployment_workflow.rst diff --git a/deploy-guide/source/prepare_env.rst b/deploy-guide/source/prepare_env.rst new file mode 100644 index 0000000..bffd04a --- /dev/null +++ b/deploy-guide/source/prepare_env.rst @@ -0,0 +1,4 @@ +.. _prepare_env.rst: + +Prepare the deployment environment +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/deploy-guide/source/verify.rst b/deploy-guide/source/verify.rst index a2a937c..d25eef2 100644 --- a/deploy-guide/source/verify.rst +++ b/deploy-guide/source/verify.rst @@ -1,24 +1,4 @@ .. _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 +Verify the deployment +~~~~~~~~~~~~~~~~~~~~~ diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..26c0d35 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 # BSD +oslosphinx>=2.5.0,!=3.4.0 # Apache-2.0 +pbr>=1.6 # Apache-2.0 +openstackdocstheme>=1.5.0 # Apache-2.0 diff --git a/test-requirements.txt b/test-requirements.txt deleted file mode 100644 index d71247c..0000000 --- a/test-requirements.txt +++ /dev/null @@ -1 +0,0 @@ -openstackdocstheme>=1.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 198d846..74310da 100644 --- a/tox.ini +++ b/tox.ini @@ -1,2 +1,17 @@ +[tox] +minversion = 1.6 +envlist = deploy-guide +skipsdist = True + +[testenv] +basepython = python2.7 +usedevelop = True +setenv = VIRTUAL_ENV={envdir} +install_command = pip install -U {opts} {packages} +deps = -r{toxinidir}/requirements.txt + +[testenv:venv] +commands = {posargs} + [testenv:deploy-guide] -commands = sphinx-build -a -E -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html +commands = sphinx-build -a -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html