openstack/openstack-ansible-galera_server
Code Issues Proposed changes

Doc and configuration for independent repository

Browse Source 
Change-Id: Ibf90f1a32fb919bc75e178047f4e1ade20dd303e
This commit is contained in:
Travis Truman 2016-03-02 11:26:18 -05:00
parent 5aa20365cd
commit 75395c9706
6 changed files with 59 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
CONTRIBUTING.rst
View File

@ -1,51 +1,62 @@
TEMPLATE OpenStack-Ansible Galera Server
######## ###############################
:tags: openstack, cloud, ansible :tags: openstack, cloud, ansible
:category: \*nix :category: \*nix
contributor guidelines Contributor Guidelines
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
Filing Bugs Filing Bugs
----------- -----------
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible" Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net
/openstack-ansible"
When submitting a bug, or working on a bug, please ensure the following criteria are met: When submitting a bug, or working on a bug, please ensure the following
* The description clearly states or describes the original problem or root cause of the problem. criteria are met:
* The description clearly states or describes the original problem or root
cause of the problem.
* Include historical information on how the problem was identified. * Include historical information on how the problem was identified.
* Any relevant logs are included. * Any relevant logs are included.
* The provided information should be totally self-contained. External access to web services/sites should not be needed. * The provided information should be totally self-contained. External
access to web services/sites should not be needed.
* Steps to reproduce the problem if possible. * Steps to reproduce the problem if possible.
Submitting Code Submitting Code
--------------- ---------------
Changes to the project should be submitted for review via the Gerrit tool, following Changes to the project should be submitted for review via the Gerrit tool,
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow" following the workflow documented at:
"http://docs.openstack.org/infra/manual/developers.html#development-workflow"
Pull requests submitted through GitHub will be ignored and closed without regard. Pull requests submitted through GitHub will be ignored and closed without
regard.
Extra Extra
----- -----
Tags: Tags:
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete. If it's a bug that needs fixing in a branch in addition to Master, add a
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
There are predefined tags that will autocomplete.
Status: Status:
Please leave this alone, it should be New till someone triages the issue. Please leave this alone, it should be New till someone triages the issue.
Importance: Importance:
Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures. Should only be touched if it is a Blocker/Gating issue. If it is, please
set to High, and only use Critical if you have found a bug that can take
down whole infrastructures.
Style guide Style guide
----------- -----------
When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format. When creating tasks and other roles for use in Ansible please create then
using the YAML dictionary format.
Example YAML dictionary format: Example YAML dictionary format:
.. code-block:: yaml .. code-block:: yaml
@ -69,17 +80,22 @@ Example **NOT** in YAML dictionary format:
- some-other-tag - some-other-tag
Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module. Usage of the ">" and "|" operators should be limited to Ansible conditionals
and command modules such as the ansible ``shell`` module.
Issues Issues
------ ------
When submitting an issue, or working on an issue please ensure the following criteria are met: When submitting an issue, or working on an issue please ensure the following
* The description clearly states or describes the original problem or root cause of the problem. criteria are met:
* The description clearly states or describes the original problem or root
cause of the problem.
* Include historical information on how the problem was identified. * Include historical information on how the problem was identified.
* Any relevant logs are included. * Any relevant logs are included.
* If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR). * If the issue is a bug that needs fixing in a branch other than Master,
* The provided information should be totally self-contained. External access to web services/sites should not be needed. add the ‘backport potential’ tag TO THE ISSUE (not the PR).
* The provided information should be totally self-contained. External
access to web services/sites should not be needed.
* If the issue is needed for a hotfix release, add the 'expedite' label. * If the issue is needed for a hotfix release, add the 'expedite' label.
* Steps to reproduce the problem if possible. * Steps to reproduce the problem if possible.

6
README.rst
View File

@ -1,9 +1,9 @@
OpenStack Galera Server OpenStack-Ansible Galera Server
####################### ###############################
:tags: openstack, galera, server, cloud, ansible :tags: openstack, galera, server, cloud, ansible
:category: \*nix :category: \*nix
Role for the installation and installation of a Galera Cluster powered by MariaDB Ansible role to install and configure a Galera cluster powered by MariaDB
.. code-block:: yaml .. code-block:: yaml

8
doc/Makefile
View File

@ -87,9 +87,9 @@ qthelp:
@echo @echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:" ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/openstack-ansible-TEMPLATE.qhcp" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/openstack-ansible-galera_server.qhcp"
@echo "To view the help file:" @echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/openstack-ansible-TEMPLATE.qhc" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/openstack-ansible-galera_server.qhc"
applehelp: applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@ -104,8 +104,8 @@ devhelp:
@echo @echo
@echo "Build finished." @echo "Build finished."
@echo "To view the help file:" @echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/openstack-ansible-TEMPLATE" @echo "# mkdir -p $$HOME/.local/share/devhelp/openstack-ansible-galera_server"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/openstack-ansible-TEMPLATE" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/openstack-ansible-galera_server"
@echo "# devhelp" @echo "# devhelp"
epub: epub:

28
doc/source/conf.py
View File

@ -1,7 +1,7 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
# openstack-ansible-TEMPLATE documentation build configuration file, created by # openstack-ansible-galera_server documentation build configuration file, created by
# sphinx-quickstart on Mon Apr 13 20:42:26 2015. # sphinx-quickstart on Mon Apr 13 20:42:26 2015.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
@ -32,7 +32,7 @@ extensions = [
] ]
# The link to the browsable source code (for the left hand menu) # The link to the browsable source code (for the left hand menu)
oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/openstack-ansible-TEMPLATE' oslosphinx_cgit_link = 'http://git.openstack.org/cgit/openstack/openstack-ansible-galera_server'
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -49,9 +49,9 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = 'openstack-ansible-TEMPLATE' project = 'openstack-ansible-galera_server'
copyright = '2015, openstack-ansible-TEMPLATE contributors' copyright = '2015, openstack-ansible-galera_server contributors'
author = 'openstack-ansible-TEMPLATE contributors' author = 'openstack-ansible-galera_server contributors'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@ -203,7 +203,7 @@ html_static_path = ['_static']
# html_search_scorer = 'scorer.js' # html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'openstack-ansible-TEMPLATEdoc' htmlhelp_basename = 'openstack-ansible-galera_serverdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
@ -225,9 +225,9 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'openstack-ansible-TEMPLATE.tex', (master_doc, 'openstack-ansible-galera_server.tex',
'openstack-ansible-TEMPLATE Documentation', 'openstack-ansible-galera_server Documentation',
'openstack-ansible-TEMPLATE contributors', 'manual'), 'openstack-ansible-galera_server contributors', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -256,8 +256,8 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'openstack-ansible-TEMPLATE', (master_doc, 'openstack-ansible-galera_server',
'openstack-ansible-TEMPLATE Documentation', 'openstack-ansible-galera_server Documentation',
[author], 1) [author], 1)
] ]
@ -271,9 +271,9 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'openstack-ansible-TEMPLATE', (master_doc, 'openstack-ansible-galera_server',
'openstack-ansible-TEMPLATE Documentation', 'openstack-ansible-galera_server Documentation',
author, 'openstack-ansible-TEMPLATE', 'One line description of project.', author, 'openstack-ansible-galera_server', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

15
doc/source/index.rst
View File

@ -1,14 +1 @@
TEMPLATE Docs .. include:: ../../README.rst
=============
Tell us what the role is supposed to do?
Basic Role Example
^^^^^^^^^^^^^^^^^^
Tell us how to use the role.
.. code-block:: yaml
- role: "$ROLENAME"
ROLE_VARS...

4
setup.cfg
View File

@ -1,6 +1,6 @@
[metadata] [metadata]
name = openstack-ansible-TEMPLATE name = openstack-ansible-galera_server
summary = TEMPLATE for OpenStack Ansible summary = Galera Server role for OpenStack-Ansible
description-file = description-file =
README.rst README.rst
author = OpenStack author = OpenStack