diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..30da83ac --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +.DS_Store +*.xpr + +# Packages +.venv +*.egg +*.egg-info + +# Testenvironment +.tox + +# Build directories +doc/build + +# Transifex Client Setting +.tx + +# Editors +*~ +.*.swp +.bak +*.pyc + +doc/source/.doctrees diff --git a/.gitreview b/.gitreview new file mode 100644 index 00000000..ebfed28e --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.openstack.org +port=29418 +project=openstack/ha-guide.git diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 00000000..16dab159 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,6 @@ +- project: + templates: + - build-openstack-docs-pti + post: + jobs: + - publish-openstack-tox-docs-direct diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..68c771a0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + 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. + diff --git a/README.rst b/README.rst index cd0f8453..6cd1f23d 100644 --- a/README.rst +++ b/README.rst @@ -1,13 +1,81 @@ -This project is no longer maintained. +================================= +OpenStack High Availability Guide +================================= -The contents of this repository are still available in the Git -source code management system. To see the contents of this -repository before it reached its end of life, please check out the -previous commit with "git checkout HEAD^1". +This repository contains the source files for the OpenStack High Availability +Guide. -The content has been merged into the openstack-manuals repository at -http://git.openstack.org/cgit/openstack/openstack-manuals/ +You can read this guide at `docs.openstack.org/ha-guide +`_. -For any further questions, please email -openstack-docs@lists.openstack.org or join #openstack-doc on -Freenode. +Prerequisites +------------- + +At a minimum, you will need git and the git-review tool installed in order to +contribute documentation. You will also need a `Gerrit account +`_ to +submit the change. + +Git is available for Linux, Mac, and Windows environments. Some platforms come +with it preinstalled, but you can review the `installation instructions +`_ if you +do not have it by default. + +Once git is installed, you can follow the instructions for your platform to +`install git-review `_. + +The last step is to configure git with your name and email address used for +your Gerrit account set up so it can link you patch to your user. Run the +following to set these values: + +.. code-block:: console + + git config --global user.name "First Last" + git config --global user.email "your_email@youremail.com" + + +Submitting Updates +------------------ +Proposing updates to the documentation is fairly straight forward once you've +done it, but there are a few steps that can appear intimidating your first +couple times through. Here is a suggested workflow to help you along the way. + +.. code-block:: console + + git clone https://git.openstack.org/openstack/ha-guide + cd ha-guide + + # it is useful to make changes on a separate branch in case you need to make + # other changes + git checkout -b my-topic + + # edit your files + git add . + git commit # Add a descriptive commit message + + # submit your changes for review + git review + +The changes will then be run through a few tests to make sure the docs build +and it will be ready for reviews. Once reviewed, if no problems are found with +the changes they will be merged to the repo and the changes will be published +to the docs.openstack.org site. + +Local Testing +------------- +If you would like to build the docs locally to make sure there are no issues +with the changes, and to view locally generated HTML files, you will need to do +a couple extra steps. + +The jobs are run using a tool called `tox`. You will need to install tox on +your platform first following its `installation guide +`_. + +You can then run the following to perform a local build with some tests: + +.. code-block:: console + + tox -e docs + +If you have any questions, please reach out on the #openstack-operators IRC +channel or through the openstack-ops mailing list. diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..d68d1264 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +openstackdocstheme>=1.18.1 # Apache-2.0 +doc8>=0.6.0 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 00000000..2d8316b1 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,61 @@ +# 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 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. +extensions = ['openstackdocstheme'] + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +repository_name = "openstack/ha-guide" +bug_project = 'openstack-manuals' +project = u'High Availability Guide' +bug_tag = u'ha-guide' +copyright = u'2016-present, OpenStack contributors' + +# -- 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' + +# 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' + +# 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', 'HAGuide.tex', u'HA Guide', + u'OpenStack contributors', 'manual'), +] + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 00000000..b7ce2dd6 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,12 @@ +================================= +OpenStack High Availability Guide +================================= + +Abstract +~~~~~~~~ + +This guide provides information about configuring OpenStack services for high +availability. + +This is a placeholder while we migrate information over from another repo. + diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..721ad3f4 --- /dev/null +++ b/tox.ini @@ -0,0 +1,16 @@ +[tox] +minversion = 2.0 +skipsdist = True +envlist = docs + +[testenv] +basepython = python3 +setenv = VIRTUAL_ENV={envdir} +passenv = *_proxy *_PROXY ZUUL_* + +[testenv:docs] +deps = + -r{toxinidir}/doc/requirements.txt +commands = + doc8 doc/source -e txt -e rst + sphinx-build -E -W -b html doc/source doc/build/html