Merge "Update to openstackdocstheme"
This commit is contained in:
Zuul
Gerrit Code Review
commit
558e84857c
@ -1,13 +0,0 @@
|
||||
{% extends "openstack/layout.html" %}
|
||||
|
||||
{% block header_navigation %}
|
||||
<li><a href="{{ pathto('index') }}" title="Go to the Home page" class="link">Home</a></li>
|
||||
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
|
||||
<li><a href="http://review.openstack.org/" title="Go to the OpenStack Gerrit server">Gerrit</a></li>
|
||||
<li><a href="http://jenkins.openstack.org/" title="Go to the OpenStack Jenkins server">Jenkins</a></li>
|
||||
<li><a href="http://logstash.openstack.org/" title="Go to the OpenStack Logstash server">Logstash</a></li>
|
||||
<li><a href="http://etherpad.openstack.org/" title="Go to the OpenStack Etherpad server">Etherpad</a></li>
|
||||
<li><a href="http://paste.openstack.org/" title="Go to the OpenStack Paste server">Paste</a></li>
|
||||
<li><a href="http://planet.openstack.org/" title="Go to the OpenStack Planet server">Planet</a></li>
|
||||
<li><a href="http://lists.openstack.org/" title="Go to the OpenStack Mailman server">Mailman</a></li>
|
||||
{% endblock %}
|
||||
@ -28,8 +28,8 @@ At a Glance
|
||||
* afs01.ord.openstack.org (a fileserver in ORD)
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-openafs/tree/
|
||||
* :file:`modules/openstack_project/manifests/afsdb.pp`
|
||||
* :file:`modules/openstack_project/manifests/afsfs.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/afsdb.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/afsfs.pp`
|
||||
:Projects:
|
||||
* http://openafs.org/
|
||||
:Bugs:
|
||||
|
||||
@ -16,8 +16,8 @@ At a Glance
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-askbot/tree/
|
||||
* https://github.com/vamsee/puppet-solr
|
||||
* :file:`modules/openstack_project/manifests/ask.pp`
|
||||
* :file:`modules/openstack_project/manifests/ask-staging.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/ask.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/ask-staging.pp`
|
||||
:Projects:
|
||||
* https://askbot.com
|
||||
* http://lucene.apache.org/solr
|
||||
@ -80,8 +80,8 @@ Application management tool can be found under /srv/askbot-sites/slot0/config:
|
||||
|
||||
Configuration files:
|
||||
|
||||
* :file:`modules/askbot/templates/askbot.vhost.erb`
|
||||
* :file:`modules/askbot/templates/settings.py.erb`
|
||||
* :cgit_file:`modules/askbot/templates/askbot.vhost.erb`
|
||||
* :cgit_file:`modules/askbot/templates/settings.py.erb`
|
||||
|
||||
In addition to the file-based configuration, Askbot provides a web interface
|
||||
to tweak its own settings. Toggles and fields for reputation thresholds,
|
||||
@ -122,8 +122,8 @@ the English (en) and Chinese (zh) languages are supported.
|
||||
|
||||
Solr schema templates can be found at:
|
||||
|
||||
* :file:`modules/askbot/templates/solr/schema.en.xml.erb`
|
||||
* :file:`modules/askbot/templates/solr/schema.cn.xml.erb`
|
||||
* :cgit_file:`modules/askbot/templates/solr/schema.en.xml.erb`
|
||||
* :cgit_file:`modules/askbot/templates/solr/schema.cn.xml.erb`
|
||||
|
||||
Operational notes
|
||||
=================
|
||||
|
||||
@ -14,7 +14,7 @@ At a Glance
|
||||
* http://pbx.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-asterisk/tree/
|
||||
* :file:`modules/openstack_project/manifests/pbx.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/pbx.pp`
|
||||
:Projects:
|
||||
* http://www.asterisk.org
|
||||
:Documentation:
|
||||
|
||||
@ -18,7 +18,7 @@ At a Glance
|
||||
* http://mirror.iad.rax.openstack.org/pypi
|
||||
* http://mirror.ord.rax.openstack.org/pypi
|
||||
:Puppet:
|
||||
* :file:`modules/openstack_project/manifests/static.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/static.pp`
|
||||
:Projects:
|
||||
* https://pypi.python.org/pypi/bandersnatch
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-bandersnatch
|
||||
|
||||
@ -14,7 +14,7 @@ At a Glance
|
||||
:Hosts:
|
||||
* http://cacti.openstack.org
|
||||
:Puppet:
|
||||
* :file:`modules/openstack_project/manifests/cacti.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/cacti.pp`
|
||||
:Projects:
|
||||
* http://www.cacti.net
|
||||
:Bugs:
|
||||
@ -31,4 +31,4 @@ Cacti is accessible via the web here:
|
||||
http://cacti.openstack.org/cacti/graph_view.php
|
||||
|
||||
New servers are added to our cacti instance by adding the host to the
|
||||
:file:`modules/openstack_project/manifests/cacti.pp` file.
|
||||
:cgit_file:`modules/openstack_project/manifests/cacti.pp` file.
|
||||
|
||||
@ -15,7 +15,7 @@ At a Glance
|
||||
* http://codesearch.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-hound/tree/
|
||||
* :file:`modules/openstack_project/manifests/codesearch.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/codesearch.pp`
|
||||
:Projects:
|
||||
* https://github.com/etsy/Hound
|
||||
:Bugs:
|
||||
|
||||
@ -1,235 +1,73 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# OpenStack Project Infrastructure documentation build configuration file,
|
||||
# created by sphinx-quickstart on Mon Jul 18 13:42:23 2011.
|
||||
#
|
||||
# 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.
|
||||
# system-config documentation build configuration file
|
||||
|
||||
import datetime
|
||||
import os
|
||||
import sys
|
||||
|
||||
from jinja2.utils import Markup
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# 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 = [
|
||||
'custom_roles',
|
||||
'oslosphinx',
|
||||
]
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = ['custom_roles', 'openstackdocstheme']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack-infra/system-config'
|
||||
bug_project = '748'
|
||||
bug_tag = ''
|
||||
|
||||
# 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'OpenStack Project Infrastructure'
|
||||
copyright = Markup(u'2012-2014, OpenStack Infastructure Team'
|
||||
u' - see the <a href="https://git.openstack.org/cgit/'
|
||||
u'openstack-infra/system-config/">system-config git repo'
|
||||
u'</a> for details')
|
||||
|
||||
# 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 = "%d.%02d" % (datetime.datetime.now().year,
|
||||
datetime.datetime.now().month)
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = "%d.%02d.%02d" % (datetime.datetime.now().year,
|
||||
datetime.datetime.now().month,
|
||||
datetime.datetime.now().day)
|
||||
|
||||
# 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'
|
||||
copyright = u'2012-2018, OpenStack Infrastructure Team'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# 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
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# 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 = []
|
||||
|
||||
|
||||
# -- Options for HTML output --------------------------------------------------
|
||||
# -- 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 = 'openstack'
|
||||
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 = {
|
||||
'nosidebar': False,
|
||||
}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = ['_themes']
|
||||
|
||||
# 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
|
||||
# To use the API Reference sidebar dropdown menu,
|
||||
# uncomment the html_theme_options parameter. The theme
|
||||
# variable, sidebar_dropdown, should be set to `api_ref`.
|
||||
# Otherwise, the list of links for the User and Ops docs
|
||||
# appear in the sidebar dropdown menu.
|
||||
#html_theme_options = {'show_other_versions': True}
|
||||
|
||||
# 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 = ['_static']
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
|
||||
html_last_updated_fmt = os.popen(git_cmd).read()
|
||||
|
||||
# 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 = True
|
||||
|
||||
# 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 = True
|
||||
|
||||
# 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 = 'OpenStackInfradoc'
|
||||
#html_static_path = ['_static/css']
|
||||
|
||||
|
||||
# -- Options for LaTeX output -------------------------------------------------
|
||||
|
||||
# The paper size ('letter' or 'a4').
|
||||
#latex_paper_size = 'letter'
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#latex_font_size = '10pt'
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass
|
||||
# [howto/manual]).
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'OpenStackInfra.tex', u'OpenStack Infrastructure Documentation',
|
||||
u'OpenStack Infrastructure Team', '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
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#latex_preamble = ''
|
||||
|
||||
# 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', 'openstackinfra', u'OpenStack Infrastructure Documentation',
|
||||
# [u'OpenStack Infrastructure Team'], 1)
|
||||
('index', 'system-config.tex', u'system-config Documentation',
|
||||
u'OpenStack Infrastructure Team', 'manual'),
|
||||
]
|
||||
|
||||
@ -22,7 +22,7 @@
|
||||
from docutils import nodes
|
||||
|
||||
|
||||
def file_role(name, rawtext, text, lineno, inliner,
|
||||
def cgit_file_role(name, rawtext, text, lineno, inliner,
|
||||
options={}, content=[]):
|
||||
"""Link a local path to a cgit file view.
|
||||
|
||||
@ -75,6 +75,6 @@ def setup(app):
|
||||
|
||||
:param app: Sphinx application context.
|
||||
"""
|
||||
app.add_role('file', file_role)
|
||||
app.add_role('cgit_file', cgit_file_role)
|
||||
app.add_role('config', config_role)
|
||||
return
|
||||
|
||||
@ -15,7 +15,7 @@ At a Glance
|
||||
* ns1.openstack.org
|
||||
* ns2.openstack.org
|
||||
:Puppet:
|
||||
* :file:`manifests/site.pp`
|
||||
* :cgit_file:`manifests/site.pp`
|
||||
:Projects:
|
||||
* https://github.com/icann-dns/puppet-nsd
|
||||
* https://www.nlnetlabs.nl/projects/nsd/
|
||||
@ -23,8 +23,8 @@ At a Glance
|
||||
Adding a Zone
|
||||
=============
|
||||
|
||||
To add a new zone, add an entry to :file:`manifests/site.pp`,
|
||||
:file:`modules/openstack_project/manifests/master_nameserver.pp` and
|
||||
To add a new zone, add an entry to :cgit_file:`manifests/site.pp`,
|
||||
:cgit_file:`modules/openstack_project/manifests/master_nameserver.pp` and
|
||||
create a new git repository to hold the contents of the zone.
|
||||
|
||||
Run::
|
||||
|
||||
@ -14,7 +14,7 @@ At a Glance
|
||||
* http://status.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-elastic_recheck/tree/
|
||||
* :file:`modules/openstack_project/manifests/status.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/status.pp`
|
||||
:Projects:
|
||||
* https://git.openstack.org/cgit/openstack-infra/elastic-recheck
|
||||
:Bugs:
|
||||
|
||||
@ -17,8 +17,8 @@ At a Glance
|
||||
* http://etherpad.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-etherpad_lite/tree/
|
||||
* :file:`modules/openstack_project/manifests/etherpad.pp`
|
||||
* :file:`modules/openstack_project/manifests/etherpad_dev.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/etherpad.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/etherpad_dev.pp`
|
||||
:Projects:
|
||||
* http://etherpad.org/
|
||||
* https://github.com/ether/etherpad-lite
|
||||
|
||||
@ -16,7 +16,7 @@ At a Glance
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-mosquitto
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-germqtt
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-lpmqtt
|
||||
* :file:`modules/openstack_project/manifests/firehose.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/firehose.pp`
|
||||
:Projects:
|
||||
* https://mosquitto.org/
|
||||
* http://git.openstack.org/cgit/openstack-infra/germqtt/
|
||||
|
||||
@ -21,10 +21,10 @@ At a Glance
|
||||
* http://review-dev.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-gerrit/tree/
|
||||
* :file:`modules/openstack_project/manifests/review.pp`
|
||||
* :file:`modules/openstack_project/manifests/review_dev.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/review.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/review_dev.pp`
|
||||
:Configuration:
|
||||
* :file:`modules/openstack_project/templates/review.projects.ini.erb`
|
||||
* :cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`
|
||||
* :config:`gerrit/projects.yaml`
|
||||
:Projects:
|
||||
* http://code.google.com/p/gerrit/
|
||||
@ -103,7 +103,7 @@ account name and add ssh keys - you'll need those.
|
||||
Once you've created your groups you should create the
|
||||
``openstack-project-creator`` account by hand (the account name is
|
||||
referenced from
|
||||
:file:`modules/openstack_project/templates/review.projects.ini.erb`)
|
||||
:cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`)
|
||||
using::
|
||||
|
||||
cat $pubkey | ssh -p 29418 $USER@$HOST gerrit create-account \
|
||||
|
||||
@ -15,9 +15,9 @@ At a Glance
|
||||
* git*.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-cgit/tree/
|
||||
* :file:`modules/openstack_project/manifests/git.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/git.pp`
|
||||
:Configuration:
|
||||
* :file:`modules/openstack_project/files/git/cgitrc`
|
||||
* :cgit_file:`modules/openstack_project/files/git/cgitrc`
|
||||
:Projects:
|
||||
* http://git.zx2c4.com/cgit/
|
||||
:Bugs:
|
||||
|
||||
@ -16,8 +16,8 @@ At a Glance
|
||||
* review.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/system-config/tree/
|
||||
* :file:`modules/openstack_project/manifests/gerrit.pp`
|
||||
* :file:`hiera/group/zuul-scheduler.yaml`
|
||||
* :cgit_file:`modules/openstack_project/manifests/gerrit.pp`
|
||||
* :cgit_file:`hiera/group/zuul-scheduler.yaml`
|
||||
:Projects:
|
||||
* https://git.openstack.org/cgit/openstack-infra/zuul
|
||||
* https://git.openstack.org/cgit/openstack-infra/jeepyb
|
||||
|
||||
@ -16,7 +16,7 @@ At a Glance
|
||||
* http://grafana.openstack.org
|
||||
:Puppet:
|
||||
* https://github.com/bfraser/puppet-grafana
|
||||
* :file:`modules/openstack_project/manifests/grafana.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/grafana.pp`
|
||||
:Projects:
|
||||
* http://grafana.org
|
||||
:Bugs:
|
||||
|
||||
@ -21,8 +21,8 @@ At a Glance
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-statusbot/tree/
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-gerritbot/tree/
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-ptgbot/tree/
|
||||
* :file:`modules/openstack_project/manifests/eavesdrop.pp`
|
||||
* :file:`modules/openstack_project/manifests/review.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/eavesdrop.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/review.pp`
|
||||
:Configuration:
|
||||
* :config:`gerritbot/channels.yaml`
|
||||
* :config:`accessbot/channels.yaml`
|
||||
@ -172,7 +172,7 @@ of logging channel activity, not just meetings. Standard channel logs
|
||||
are sent to http://eavesdrop.openstack.org/irclogs/
|
||||
|
||||
The configuration for specific channel logging can be found in the
|
||||
public Hiera data file, :file:`hiera/common.yaml`.
|
||||
public Hiera data file, :cgit_file:`hiera/common.yaml`.
|
||||
|
||||
.. _statusbot:
|
||||
|
||||
@ -214,7 +214,7 @@ the channels the bot is listening to:
|
||||
in OpenStack development.
|
||||
|
||||
A channel can be added to statusbot by editing the public Hiera data
|
||||
file, :file:`hiera/common.yaml`.
|
||||
file, :cgit_file:`hiera/common.yaml`.
|
||||
|
||||
The wiki password for the StatusBot account can be (re)set using the
|
||||
`ChangePassword.php <https://www.mediawiki.org/wiki/Manual:ChangePassword.php>`_
|
||||
|
||||
@ -17,12 +17,12 @@ At a Glance
|
||||
* http://review-dev.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-jeepyb/tree/
|
||||
* :file:`modules/openstack_project/manifests/review.pp`
|
||||
* :file:`modules/openstack_project/manifests/review_dev.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/review.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/review_dev.pp`
|
||||
:Configuration:
|
||||
* :file:`modules/openstack_project/templates/review.projects.ini.erb`
|
||||
* :cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`
|
||||
* :config:`gerrit/projects.yaml`
|
||||
* :file:`modules/openstack_project/files/pypi-mirror.yaml`
|
||||
* :cgit_file:`modules/openstack_project/files/pypi-mirror.yaml`
|
||||
:Projects:
|
||||
* https://git.openstack.org/cgit/openstack-infra/jeepyb
|
||||
:Bugs:
|
||||
@ -39,7 +39,7 @@ and create new groups in Gerrit.
|
||||
|
||||
The global configuration data needed for ``manage-projects`` to know how to
|
||||
connect to things or how to operate is in
|
||||
:file:`modules/openstack_project/templates/review.projects.ini.erb`.
|
||||
:cgit_file:`modules/openstack_project/templates/review.projects.ini.erb`.
|
||||
|
||||
#. Config values::
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ At a Glance
|
||||
* kdc*.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-kerberos/tree/
|
||||
* :file:`modules/openstack_project/manifests/kdc.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/kdc.pp`
|
||||
:Projects:
|
||||
* http://web.mit.edu/kerberos
|
||||
:Bugs:
|
||||
|
||||
@ -16,7 +16,7 @@ At a Glance
|
||||
* http://lists.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-mailman/tree/
|
||||
* :file:`modules/openstack_project/manifests/lists.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/lists.pp`
|
||||
:Projects:
|
||||
* http://www.gnu.org/software/mailman/
|
||||
:Bugs:
|
||||
|
||||
@ -16,12 +16,12 @@ At a Glance
|
||||
* elasticsearch\*.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-logstash/tree/
|
||||
* :file:`modules/openstack_project/manifests/logstash.pp`
|
||||
* :file:`modules/openstack_project/manifests/logstash_worker.pp`
|
||||
* :file:`modules/openstack_project/manifests/elasticsearch.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/logstash.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/logstash_worker.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/elasticsearch.pp`
|
||||
:Configuration:
|
||||
* :file:`modules/openstack_project/files/logstash`
|
||||
* :file:`modules/openstack_project/templates/logstash`
|
||||
* :cgit_file:`modules/openstack_project/files/logstash`
|
||||
* :cgit_file:`modules/openstack_project/templates/logstash`
|
||||
:Projects:
|
||||
* http://logstash.net/
|
||||
* http://kibana.org/
|
||||
@ -178,23 +178,23 @@ schema.
|
||||
|
||||
The config file that tells Logstash how to do this flattening can be
|
||||
found at
|
||||
:file:`modules/openstack_project/templates/logstash/indexer.conf.erb`
|
||||
:cgit_file:`modules/openstack_project/templates/logstash/indexer.conf.erb`
|
||||
|
||||
This works via the tags that are associated with a given message.
|
||||
|
||||
The tags in
|
||||
:file:`modules/openstack_project/templates/logstash/indexer.conf.erb`
|
||||
:cgit_file:`modules/openstack_project/templates/logstash/indexer.conf.erb`
|
||||
are used to tell logstash how to parse a given file's messages, based
|
||||
on the file's message format.
|
||||
|
||||
When adding a new file to be indexed to
|
||||
:file:`modules/openstack_project/files/logstash/jenkins-log-client.yaml`
|
||||
:cgit_file:`modules/openstack_project/files/logstash/jenkins-log-client.yaml`
|
||||
at least one tag from the indexer.conf.erb file should be associated
|
||||
with the new file. One can expect to see '{%logmessage%}' instead of
|
||||
actual message data if indexing is not working properly.
|
||||
|
||||
In the event a new file's format is not covered, a patch for
|
||||
:file:`modules/openstack_project/templates/logstash/indexer.conf.erb`
|
||||
:cgit_file:`modules/openstack_project/templates/logstash/indexer.conf.erb`
|
||||
should be submitted with an appropriate parsing pattern.
|
||||
|
||||
ElasticSearch
|
||||
|
||||
@ -13,10 +13,10 @@ At a Glance
|
||||
* Frontend: http://status.openstack.org/openstack-health
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-openstack_health/tree/
|
||||
* :file:`modules/openstack_project/manifests/openstack_health_api.pp`
|
||||
* :file:`modules/openstack_project/manifests/status.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/openstack_health_api.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/status.pp`
|
||||
:Configuration:
|
||||
* :file:`modules/openstack_project/files/git/cgitrc`
|
||||
* :cgit_file:`modules/openstack_project/files/git/cgitrc`
|
||||
:Projects:
|
||||
* https://git.openstack.org/cgit/openstack/openstack-health/tree
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ At a Glance
|
||||
* https://openstackid.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-openstackid/tree/
|
||||
* :file:`modules/openstack_project/manifests/openstackid_dev.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/openstackid_dev.pp`
|
||||
:Projects:
|
||||
* http://git.openstack.org/cgit/openstack-infra/openstackid/
|
||||
:Bugs:
|
||||
|
||||
@ -17,7 +17,7 @@ At a Glance
|
||||
* http://paste.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-lodgeit/tree/
|
||||
* :file:`modules/openstack_project/manifests/paste.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/paste.pp`
|
||||
:Projects:
|
||||
* https://git.openstack.org/cgit/openstack-infra/lodgeit
|
||||
* https://bitbucket.org/dcolish/lodgeit-main
|
||||
|
||||
@ -17,7 +17,7 @@ At a Glance
|
||||
* http://planet.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-planet/tree/
|
||||
* :file:`modules/openstack_project/manifests/planet.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/planet.pp`
|
||||
:Configuration:
|
||||
* https://git.openstack.org/cgit/openstack/openstack-planet/tree/planet.ini
|
||||
:Projects:
|
||||
|
||||
@ -17,7 +17,7 @@ At a Glance
|
||||
:Hosts:
|
||||
* puppetmaster.openstack.org
|
||||
:Puppet:
|
||||
* :file:`modules/openstack_project/manifests/puppetmaster.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/puppetmaster.pp`
|
||||
:Projects:
|
||||
* https://puppetlabs.com/
|
||||
:Bugs:
|
||||
@ -37,7 +37,7 @@ The cron jobs, current configuration files and more can be done with ``puppet
|
||||
apply`` but first some bootstrapping needs to be done.
|
||||
|
||||
You want to install these from puppetlabs' apt repo. There is a script,
|
||||
:file:`install_puppet.sh` in the root of the system-config repository that
|
||||
:cgit_file:`install_puppet.sh` in the root of the system-config repository that
|
||||
will setup and install the puppet client. After that you must install the
|
||||
ansible playbooks and hiera config (used to maintain secrets).
|
||||
|
||||
@ -83,7 +83,7 @@ Adding a node
|
||||
|
||||
For adding a new node to your puppet master, you can either use the
|
||||
``/opt/system-config/production/launch/launch-node.py`` script
|
||||
(see :file:`launch/README` for full details) or bootstrap puppet manually.
|
||||
(see :cgit_file:`launch/README` for full details) or bootstrap puppet manually.
|
||||
|
||||
For manual bootstrap, you need to run on the new server connecting
|
||||
(for example, review.openstack.org) to the puppet master:
|
||||
|
||||
@ -13,7 +13,7 @@ At a Glance
|
||||
:Hosts:
|
||||
* http://mirror-update.openstack.org
|
||||
:Puppet:
|
||||
* :file:`modules/openstack_project/manifests/mirror_update.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/mirror_update.pp`
|
||||
:Projects:
|
||||
* https://mirrorer.alioth.debian.org
|
||||
:Documentation:
|
||||
|
||||
@ -21,7 +21,7 @@ At a Glance
|
||||
* http://stackalytics.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-stackalytics/tree/
|
||||
* :file:`modules/openstack_project/manifests/stackalytics.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/stackalytics.pp`
|
||||
:Projects:
|
||||
* https://git.openstack.org/cgit/openstack/stackalytics
|
||||
:Documentation:
|
||||
|
||||
@ -17,7 +17,7 @@ At a Glance
|
||||
* http://mirror.openstack.org
|
||||
* http://specs.openstack.org
|
||||
:Puppet:
|
||||
* :file:`modules/openstack_project/manifests/static.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/static.pp`
|
||||
:Configuration:
|
||||
* :config:`specs/index.html`
|
||||
:Projects:
|
||||
|
||||
@ -19,14 +19,14 @@ At a Glance
|
||||
* https://storyboard.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-storyboard/tree/
|
||||
* :file:`modules/openstack_project/manifests/storyboard.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/storyboard.pp`
|
||||
:Projects:
|
||||
* https://git.openstack.org/cgit/openstack-infra/storyboard
|
||||
* https://git.openstack.org/cgit/openstack-infra/storyboard-webclient
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-storyboard
|
||||
:Configuration:
|
||||
* :config:`gerrit/projects.yaml`
|
||||
* :file:`modules/openstack_project/files/storyboard/superusers.yaml`
|
||||
* :cgit_file:`modules/openstack_project/files/storyboard/superusers.yaml`
|
||||
:Bugs:
|
||||
* https://storyboard.openstack.org/#!/project/456
|
||||
:Resources:
|
||||
|
||||
@ -117,10 +117,10 @@ Adding a New Server
|
||||
|
||||
To create a new server, do the following:
|
||||
|
||||
* Add a file in :file:`modules/openstack_project/manifests/` that defines a
|
||||
* Add a file in :cgit_file:`modules/openstack_project/manifests/` that defines a
|
||||
class which specifies the configuration of the server.
|
||||
|
||||
* Add a node pattern entry in :file:`manifests/site.pp` for the server
|
||||
* Add a node pattern entry in :cgit_file:`manifests/site.pp` for the server
|
||||
that uses that class. Make sure it supports an ordinal naming pattern
|
||||
(e.g., fooserver01.openstack.org not just fooserver.openstack.org, even
|
||||
if you're replacing an existing server) and that another server with the
|
||||
@ -132,14 +132,14 @@ To create a new server, do the following:
|
||||
|
||||
* You should be able to install and configure most software only with
|
||||
puppet. Nonetheless, if you need SSH access to the host, add your
|
||||
public key to :file:`modules/openstack_project/manifests/users.pp` and
|
||||
public key to :cgit_file:`modules/openstack_project/manifests/users.pp` and
|
||||
include a stanza like this in your server class::
|
||||
|
||||
realize (
|
||||
User::Virtual::Localuser['USERNAME'],
|
||||
)
|
||||
|
||||
* Add an RST file with documentation about the server in :file:`doc/source`
|
||||
* Add an RST file with documentation about the server in :cgit_file:`doc/source`
|
||||
and add it to the index in that directory.
|
||||
|
||||
SSH Access
|
||||
@ -327,7 +327,7 @@ Launching New Servers
|
||||
|
||||
New servers are launched using the ``launch/launch-node.py`` tool from the git
|
||||
repository ``https://git.openstack.org/openstack-infra/system-config``. This
|
||||
tool is run from a checkout on the puppetmaster - please see :file:`launch/README`
|
||||
tool is run from a checkout on the puppetmaster - please see :cgit_file:`launch/README`
|
||||
for detailed instructions.
|
||||
|
||||
.. _disable-enable-puppet:
|
||||
@ -353,7 +353,7 @@ to take.
|
||||
|
||||
In the case of needing to disable the running of puppet on a node, it's a
|
||||
simple matter of adding an entry to the ansible inventory "disabled" group
|
||||
in :file:`modules/openstack_project/files/puppetmaster/groups.txt`. The
|
||||
in :cgit_file:`modules/openstack_project/files/puppetmaster/groups.txt`. The
|
||||
disabled entry is an input to `ansible --list-hosts` so you can check your
|
||||
entry simply by running it with `ansible $hostlist --list-hosts` as root
|
||||
on the puppetmaster host and ensuring that the list of hosts returned is as
|
||||
|
||||
@ -16,8 +16,8 @@ At a Glance
|
||||
* https://translate-dev.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-zanata/tree/
|
||||
* :file:`modules/openstack_project/manifests/translate.pp`
|
||||
* :file:`modules/openstack_project/manifests/translate-dev.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/translate.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/translate-dev.pp`
|
||||
:Projects:
|
||||
* http://zanata.org/
|
||||
* https://github.com/zanata/
|
||||
|
||||
@ -15,7 +15,7 @@ At a Glance
|
||||
* https://wiki.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-mediawiki/tree/
|
||||
* :file:`modules/openstack_project/manifests/wiki.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/wiki.pp`
|
||||
:Projects:
|
||||
* http://www.mediawiki.org/wiki/MediaWiki
|
||||
:Bugs:
|
||||
|
||||
@ -16,8 +16,8 @@ At a Glance
|
||||
* zm*.openstack.org
|
||||
:Puppet:
|
||||
* https://git.openstack.org/cgit/openstack-infra/puppet-zuul/tree/
|
||||
* :file:`modules/openstack_project/manifests/zuul_prod.pp`
|
||||
* :file:`modules/openstack_project/manifests/zuul_dev.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/zuul_prod.pp`
|
||||
* :cgit_file:`modules/openstack_project/manifests/zuul_dev.pp`
|
||||
:Configuration:
|
||||
* :config:`zuul/layout.yaml`
|
||||
:Projects:
|
||||
|
||||
@ -18,6 +18,4 @@ classifier =
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
|
||||
[pbr]
|
||||
warnerrors = true
|
||||
warning-is-error = 1
|
||||
|
||||
2
setup.py
2
setup.py
@ -25,5 +25,5 @@ except ImportError:
|
||||
pass
|
||||
|
||||
setuptools.setup(
|
||||
setup_requires=['pbr>=1.8'],
|
||||
setup_requires=['pbr>=2.0.0'],
|
||||
pbr=True)
|
||||
|
||||
@ -2,8 +2,8 @@
|
||||
# of appearance. Changing the order has an impact on the overall integration
|
||||
# process, which may cause wedges in the gate later.
|
||||
hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
|
||||
sphinx>=1.5.1,<1.6.0 # BSD
|
||||
oslosphinx>=4.7.0 # Apache-2.0
|
||||
sphinx!=1.6.6,!=1.6.7 # BSD
|
||||
openstackdocstheme>=1.11.0 # Apache-2.0
|
||||
bashate>=0.2 # Apache-2.0
|
||||
PyYAML>=3.10.0 # MIT
|
||||
ansible-lint
|
||||
|
||||
Loading…
Reference in New Issue
Block a user