Merge "Build a deploy-guide"
This commit is contained in:
commit
a608b02128
|
@ -1,4 +1,5 @@
|
|||
.DS_Store
|
||||
.eggs/
|
||||
.kitchen/
|
||||
.kitchen.local.yml
|
||||
.bundle
|
||||
|
@ -15,5 +16,6 @@ vms/
|
|||
.chef/local-mode-cache/
|
||||
.project
|
||||
.tox
|
||||
deploy-guide/build
|
||||
doc/build
|
||||
*.egg-info
|
||||
|
|
|
@ -30,5 +30,6 @@
|
|||
|
||||
- project:
|
||||
templates:
|
||||
- deploy-guide-jobs
|
||||
- publish-openstack-docs-pti
|
||||
- openstack-chef-jobs
|
||||
|
|
|
@ -0,0 +1,10 @@
|
|||
2. Edit the ``/etc/OpenStackChef/OpenStackChef.conf`` file and complete the following
|
||||
actions:
|
||||
|
||||
* In the ``[database]`` section, configure database access:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[database]
|
||||
...
|
||||
connection = mysql+pymysql://OpenStackChef:OPENSTACKCHEF_DBPASS@controller/OpenStackChef
|
|
@ -0,0 +1,75 @@
|
|||
Prerequisites
|
||||
-------------
|
||||
|
||||
Before you install and configure the OpenStack Chef 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 ``OpenStackChef`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
CREATE DATABASE OpenStackChef;
|
||||
|
||||
* Grant proper access to the ``OpenStackChef`` database:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
GRANT ALL PRIVILEGES ON OpenStackChef.* TO 'OpenStackChef'@'localhost' \
|
||||
IDENTIFIED BY 'OPENSTACKCHEF_DBPASS';
|
||||
GRANT ALL PRIVILEGES ON OpenStackChef.* TO 'OpenStackChef'@'%' \
|
||||
IDENTIFIED BY 'OPENSTACKCHEF_DBPASS';
|
||||
|
||||
Replace ``OPENSTACKCHEF_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 ``OpenStackChef`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack user create --domain default --password-prompt OpenStackChef
|
||||
|
||||
* Add the ``admin`` role to the ``OpenStackChef`` user:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack role add --project service --user OpenStackChef admin
|
||||
|
||||
* Create the OpenStackChef service entities:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack service create --name OpenStackChef --description "OpenStack Chef" openstack chef
|
||||
|
||||
#. Create the OpenStack Chef service API endpoints:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
openstack chef public http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
openstack chef internal http://controller:XXXX/vY/%\(tenant_id\)s
|
||||
$ openstack endpoint create --region RegionOne \
|
||||
openstack chef admin http://controller:XXXX/vY/%\(tenant_id\)s
|
|
@ -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'Deployment Guide for OpenStack Chef Cookbooks'
|
||||
bug_tag = u'deploy-guide'
|
||||
copyright = u'2019, 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'https://git.openstack.org/cgit/openstack/openstack-chef/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": "openstack-chef"}
|
||||
|
||||
# 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
|
||||
# "<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 = []
|
||||
|
||||
# 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 <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 = ''
|
||||
|
||||
# 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 = 'deploy-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')
|
||||
]
|
|
@ -18,9 +18,9 @@ Tempest.
|
|||
* At least 4GB of memory. 8GB or more is recommended.
|
||||
* At least 10GB of storage.
|
||||
|
||||
.. code-block:: bash
|
||||
.. code-block:: shell-session
|
||||
|
||||
$ git clone https://git.openstack.org/openstack/openstack-chef
|
||||
$ cd openstack-chef
|
||||
# git clone https://git.openstack.org/openstack/openstack-chef
|
||||
# cd openstack-chef
|
||||
# mkdir -p /etc/chef && cp .chef/encrypted_data_bag_secret /etc/chef/openstack_data_bag_secret
|
||||
# chef-client -z -E allinone -r 'role[allinone]'
|
|
@ -26,23 +26,25 @@ Releases Summary
|
|||
+----------------------------+------------------------------+------------------------+
|
||||
| 13.z.y | Mitaka | no - EOL (2017-04-10) |
|
||||
+----------------------------+------------------------------+------------------------+
|
||||
| 14.z.y | Newton | yes - EOL (2017-10-11) |
|
||||
| 14.z.y | Newton | no - EOL (2017-10-11) |
|
||||
+----------------------------+------------------------------+------------------------+
|
||||
| 15.z.y | Ocata | yes - EOL (2017-02-26) |
|
||||
| 15.z.y | Ocata | no - Extended Maint. |
|
||||
+----------------------------+------------------------------+------------------------+
|
||||
| 16.z.y | Pike | yes |
|
||||
+----------------------------+------------------------------+------------------------+
|
||||
| 17.z.y | Queens | yes (current master) |
|
||||
| 17.z.y | Queens | yes |
|
||||
+----------------------------+------------------------------+------------------------+
|
||||
| 18.z.y | Rocky | Future |
|
||||
| 18.z.y | Rocky | yes (current master) |
|
||||
+----------------------------+------------------------------+------------------------+
|
||||
| 19.z.y | Stein | Future |
|
||||
+----------------------------+------------------------------+------------------------+
|
||||
|
||||
Supermarket releases
|
||||
====================
|
||||
|
||||
- From Ocata, the cookbooks are released on the Chef Supermarket_.
|
||||
- From Ocata on, the cookbooks are released on the Chef Supermarket_.
|
||||
|
||||
.. _Supermarket: https://supermarket.chef.io/openstack
|
||||
.. _Supermarket: https://supermarket.chef.io/users/openstack
|
||||
|
||||
How to release Chef cookbooks
|
||||
=============================
|
|
@ -0,0 +1,14 @@
|
|||
=========================
|
||||
OpenStack Chef deployment
|
||||
=========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:includehidden:
|
||||
|
||||
get_started.rst
|
||||
quickstart
|
||||
deploy
|
||||
genealogy
|
||||
supported-platforms
|
||||
|
|
@ -58,7 +58,7 @@ packages are updated and then rebooted into the new kernel:
|
|||
# yum upgrade
|
||||
# reboot
|
||||
|
||||
Start by cloing the OpenStack chef-repo repository and changing into the root directory:
|
||||
Start by cloning the OpenStack Chef repository and changing into the root directory:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
|
@ -71,23 +71,23 @@ from the head of a branch may result in an unstable build due to changes in
|
|||
flight and upstream OpenStack changes. For a test (not a development) build, it
|
||||
is usually best to checkout the latest tagged version.
|
||||
|
||||
.. parsed-literal::
|
||||
.. code-block:: shell-session
|
||||
|
||||
## List all existing branches.
|
||||
# git branch -v
|
||||
# git branch -av
|
||||
|
||||
## Checkout the stable branch
|
||||
# git checkout master
|
||||
## Checkout some stable branch
|
||||
# git checkout stable/queens
|
||||
|
||||
.. note::
|
||||
The master release is compatible with Ubuntu 18.04
|
||||
The current master release is compatible with Ubuntu 18.04
|
||||
(Bionic Beaver) and CentOS 7
|
||||
|
||||
By default the cookbooks deploy all OpenStack services with sensible defaults
|
||||
for the purpose of a gate check, development or testing system.
|
||||
|
||||
Deployers have the option to change how the build is configured by overriding
|
||||
in the respective kitche YAML file. This can be useful when you want to make
|
||||
in the respective kitchen YAML file. This can be useful when you want to make
|
||||
use of different services or test new cookbooks.
|
||||
|
||||
To use a different driver for Test Kitchen, such as for a multi-node
|
|
@ -3,14 +3,17 @@ Supported Platforms
|
|||
|
||||
The following operating systems and versions are supported by the OpenStack cookbooks:
|
||||
|
||||
* RHEL / CentOS 7
|
||||
* Ubuntu 18.04 LTS (Bionic Beaver)
|
||||
|
||||
The cookbooks are tested and verified to work on the Chef stable track using
|
||||
the `Chef Development Kit <https://docs.chef.io/about_chefdk.html>`_.
|
||||
|
||||
Support for RHEL / CentOS 7 is mostly still present, but currently not maintained or
|
||||
tested. Contributions are welcome.
|
||||
|
||||
Your success rate may vary with the bleeding edge. Chef 12 and older is NOT
|
||||
supported.
|
||||
|
||||
See `Chef CI <https://docs.openstack.org/openstack-chef/latest/contributor/ci.html>`_
|
||||
Have a look at
|
||||
`OpenStack Chef Continuous Integration <https://docs.openstack.org/openstack-chef/latest/contributor/ci.html>`_
|
||||
to see what is currently tested.
|
8
tox.ini
8
tox.ini
|
@ -16,3 +16,11 @@ commands = {posargs}
|
|||
basepython = python3
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -b html doc/source doc/build/html
|
||||
|
||||
[testenv:deploy-guide]
|
||||
basepython = python3
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
whitelist_externals = rm
|
||||
commands =
|
||||
rm -rf deploy-guide/build
|
||||
sphinx-build -a -E -W -d deploy-guide/build/doctrees -b html deploy-guide/source deploy-guide/build/html
|
||||
|
|
Loading…
Reference in New Issue