diff --git a/README.rst b/README.rst index 98218a5..c6733d7 100644 --- a/README.rst +++ b/README.rst @@ -1,27 +1,13 @@ -======================== -Team and repository tags -======================== +This project is no longer maintained. -.. image:: https://governance.openstack.org/badges/installguide-cookiecutter.svg - :target: https://governance.openstack.org/reference/tags/index.html +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". -========================== -Install Guide Cookiecutter -========================== +For an alternative project, please see cookiecutter at +https://review.openstack.org/gitweb?p=openstack-dev/cookiecutter.git;a=summary. -Cookiecutter template for an Install Guide skeleton. See -https://github.com/audreyr/cookiecutter for full information about -cookiecutter. - -Usage ------ - -The usage of this tool is documented in the `OpenStack Contributor Guide -`_. - -Contribution ------------- - -This repo is part of the OpenStack docs team, see our -`Contributor Guide `_ on how to -contribute. +For any further questions, please email +openstack-dev@lists.openstack.org or join #openstack-doc on +Freenode. diff --git a/cookiecutter.json b/cookiecutter.json deleted file mode 100644 index 6bcf988..0000000 --- a/cookiecutter.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "service": "replace with the name of the service like Networking or Compute", - "codename": "replace with the codename like neutron or nova", - "directory_name": "install-guide" -} diff --git a/{{cookiecutter.directory_name}}/source/common_configure.rst b/{{cookiecutter.directory_name}}/source/common_configure.rst deleted file mode 100644 index edd65d0..0000000 --- a/{{cookiecutter.directory_name}}/source/common_configure.rst +++ /dev/null @@ -1,10 +0,0 @@ -2. Edit the ``/etc/{{cookiecutter.codename}}/{{cookiecutter.codename}}.conf`` file and complete the following - actions: - - * In the ``[database]`` section, configure database access: - - .. code-block:: ini - - [database] - ... - connection = mysql+pymysql://{{cookiecutter.codename}}:{{cookiecutter.codename|upper}}_DBPASS@controller/{{cookiecutter.codename}} diff --git a/{{cookiecutter.directory_name}}/source/common_prerequisites.rst b/{{cookiecutter.directory_name}}/source/common_prerequisites.rst deleted file mode 100644 index 1dee686..0000000 --- a/{{cookiecutter.directory_name}}/source/common_prerequisites.rst +++ /dev/null @@ -1,75 +0,0 @@ -Prerequisites -------------- - -Before you install and configure the {{cookiecutter.service}} 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 ``{{cookiecutter.codename}}`` database: - - .. code-block:: none - - CREATE DATABASE {{cookiecutter.codename}}; - - * Grant proper access to the ``{{cookiecutter.codename}}`` database: - - .. code-block:: none - - GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'localhost' \ - IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS'; - GRANT ALL PRIVILEGES ON {{cookiecutter.codename}}.* TO '{{cookiecutter.codename}}'@'%' \ - IDENTIFIED BY '{{cookiecutter.codename|upper}}_DBPASS'; - - Replace ``{{cookiecutter.codename|upper}}_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 ``{{cookiecutter.codename}}`` user: - - .. code-block:: console - - $ openstack user create --domain default --password-prompt {{cookiecutter.codename}} - - * Add the ``admin`` role to the ``{{cookiecutter.codename}}`` user: - - .. code-block:: console - - $ openstack role add --project service --user {{cookiecutter.codename}} admin - - * Create the {{cookiecutter.codename}} service entities: - - .. code-block:: console - - $ openstack service create --name {{cookiecutter.codename}} --description "{{cookiecutter.service}}" {{cookiecutter.service|lower}} - -#. Create the {{cookiecutter.service}} service API endpoints: - - .. code-block:: console - - $ openstack endpoint create --region RegionOne \ - {{cookiecutter.service|lower}} public http://controller:XXXX/vY/%\(tenant_id\)s - $ openstack endpoint create --region RegionOne \ - {{cookiecutter.service|lower}} internal http://controller:XXXX/vY/%\(tenant_id\)s - $ openstack endpoint create --region RegionOne \ - {{cookiecutter.service|lower}} admin http://controller:XXXX/vY/%\(tenant_id\)s diff --git a/{{cookiecutter.directory_name}}/source/conf.py b/{{cookiecutter.directory_name}}/source/conf.py deleted file mode 100644 index 727d4ac..0000000 --- a/{{cookiecutter.directory_name}}/source/conf.py +++ /dev/null @@ -1,301 +0,0 @@ -# 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 {{cookiecutter.service}} 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/{{cookiecutter.codename}}/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": "{{cookiecutter.codename}}"} - -# 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/{{cookiecutter.directory_name}}/source/get_started.rst b/{{cookiecutter.directory_name}}/source/get_started.rst deleted file mode 100644 index 0b1a052..0000000 --- a/{{cookiecutter.directory_name}}/source/get_started.rst +++ /dev/null @@ -1,16 +0,0 @@ -{%- macro set_header_markup(header_text_length) -%} -{%- set servicelength = cookiecutter.service|length -%} -{%- for _ in range(0, servicelength + header_text_length) -%}={%- endfor -%} -{%- endmacro -%} -{%- macro set_header(header_text) -%} -{{ set_header_markup(header_text|length) }} -{{cookiecutter.service}}{{header_text}} -{{ set_header_markup(header_text|length) }} -{%- endmacro -%} -{{ set_header(" service overview") }} -The {{cookiecutter.service}} service provides... - -The {{cookiecutter.service}} service consists of the following components: - -``{{cookiecutter.codename}}-api`` service - Accepts and responds to end user compute API calls... diff --git a/{{cookiecutter.directory_name}}/source/index.rst b/{{cookiecutter.directory_name}}/source/index.rst deleted file mode 100644 index e0cdb92..0000000 --- a/{{cookiecutter.directory_name}}/source/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -{%- macro set_header_markup(header_text_length) -%} -{%- set servicelength = cookiecutter.service|length -%} -{%- for _ in range(0, servicelength + header_text_length) -%}={%- endfor -%} -{%- endmacro -%} -{%- macro set_header(header_text) -%} -{{ set_header_markup(header_text|length) }} -{{cookiecutter.service}}{{header_text}} -{{ set_header_markup(header_text|length) }} -{%- endmacro -%} -{{ set_header(" service") }} - -.. toctree:: - :maxdepth: 2 - - get_started.rst - install.rst - verify.rst - next-steps.rst - -The {{cookiecutter.service}} service ({{cookiecutter.codename}}) provides... - -This chapter assumes a working setup of OpenStack following the -`OpenStack Installation Tutorial -`_. diff --git a/{{cookiecutter.directory_name}}/source/install-obs.rst b/{{cookiecutter.directory_name}}/source/install-obs.rst deleted file mode 100644 index 16f113f..0000000 --- a/{{cookiecutter.directory_name}}/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 {{cookiecutter.service}} 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 {{cookiecutter.service}} services and configure them to start when -the system boots: - -.. code-block:: console - - # systemctl enable openstack-{{cookiecutter.codename}}-api.service - - # systemctl start openstack-{{cookiecutter.codename}}-api.service diff --git a/{{cookiecutter.directory_name}}/source/install-rdo.rst b/{{cookiecutter.directory_name}}/source/install-rdo.rst deleted file mode 100644 index 3890fdd..0000000 --- a/{{cookiecutter.directory_name}}/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 {{cookiecutter.service}} 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 {{cookiecutter.service}} services and configure them to start when -the system boots: - -.. code-block:: console - - # systemctl enable openstack-{{cookiecutter.codename}}-api.service - - # systemctl start openstack-{{cookiecutter.codename}}-api.service diff --git a/{{cookiecutter.directory_name}}/source/install-ubuntu.rst b/{{cookiecutter.directory_name}}/source/install-ubuntu.rst deleted file mode 100644 index 644f732..0000000 --- a/{{cookiecutter.directory_name}}/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 {{cookiecutter.service}} -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 {{cookiecutter.service}} services: - -.. code-block:: console - - # service openstack-{{cookiecutter.codename}}-api restart diff --git a/{{cookiecutter.directory_name}}/source/install.rst b/{{cookiecutter.directory_name}}/source/install.rst deleted file mode 100644 index 7622a47..0000000 --- a/{{cookiecutter.directory_name}}/source/install.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _install: - -Install and configure -~~~~~~~~~~~~~~~~~~~~~ - -This section describes how to install and configure the -{{cookiecutter.service}} service, code-named {{cookiecutter.codename}}, 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/{{cookiecutter.directory_name}}/source/next-steps.rst b/{{cookiecutter.directory_name}}/source/next-steps.rst deleted file mode 100644 index a690a4d..0000000 --- a/{{cookiecutter.directory_name}}/source/next-steps.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _next-steps: - -Next steps -~~~~~~~~~~ - -Your OpenStack environment now includes the {{cookiecutter.codename}} service. - -To add additional services, see -https://docs.openstack.org/project-install-guide/ocata/. diff --git a/{{cookiecutter.directory_name}}/source/verify.rst b/{{cookiecutter.directory_name}}/source/verify.rst deleted file mode 100644 index 378f7c0..0000000 --- a/{{cookiecutter.directory_name}}/source/verify.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _verify: - -Verify operation -~~~~~~~~~~~~~~~~ - -Verify operation of the {{cookiecutter.service}} 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 {{cookiecutter.service|lower}} service list