Skip to content

Commit a3acb4e

Browse files
markgoddardmarkgoddard
committed
Initialise Ansible collection
This change was created using the OpenStack cookiecutter. A few changes were made to the cookiecutter output, including removing the python module structure. Next, the Ansible collection directory structure was initiatilised via: ansible-galaxy collection init openstack.kolla galaxy.yml has been updated to add project metadata. Some of the basic repository content has been adapted from kolla-ansible. The documentation has been cleansed of boilerplate, and the contributor guide initialised. CI jobs for docs have been added. Change-Id: I09ab26b9383d3d415bba735fc0d72e7c88a288b4
1 parent 13b67ae commit a3acb4e

26 files changed

+1491
-1
lines changed

‎.coveragerc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[run]
2+
branch = True
3+
source = ansible-collection-kolla
4+
5+
[report]
6+
ignore_errors = True

‎.gitignore

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# vim and emacs temp files
2+
*~
3+
[._]*.s[a-w][a-z]
4+
5+
.tox/
6+
.buildconf
7+
8+
# Files generated by setup.py
9+
*.egg-info
10+
build
11+
.eggs
12+
13+
# Byte-compiled / optimized / DLL files
14+
__pycache__/
15+
*.py[cod]
16+
*$py.class
17+
18+
# the files generated from tox command.
19+
.stestr/
20+
AUTHORS
21+
ChangeLog
22+
doc/build
23+
.coverage
24+
cover/
25+
26+
# Files generated by JetBrains
27+
.idea/
28+
29+
# File generated by Eclipse
30+
.project
31+
.pydevproject
32+
33+
# Files generated by Visual Studio Code
34+
.vscode/
35+
36+
# Files created by reno build
37+
releasenotes/build
38+
39+
# Others
40+
.DS_Store
41+
.vimrc

‎.stestr.conf

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[DEFAULT]
2+
test_path=./ansible-collection-kolla/tests
3+
top_dir=./

‎.yamllint

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
extends: default
3+
ignore: |
4+
.tox/
5+
6+
rules:
7+
line-length: disable
8+
truthy: disable
9+
braces:
10+
max-spaces-inside: 1
11+
comments:
12+
require-starting-space: true

‎CONTRIBUTING.rst

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The source repository for this project can be found at:
2+
3+
https://opendev.org/openstack/ansible-collection-kolla
4+
5+
Pull requests submitted through GitHub are not monitored.
6+
7+
To start contributing to OpenStack, follow the steps in the contribution guide
8+
to set up and use Gerrit:
9+
10+
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
11+
12+
Bugs should be filed on Launchpad:
13+
14+
https://bugs.launchpad.net/ansible-collection-kolla
15+
16+
For more specific information about contributing to this repository, see the
17+
replace with the service it implements contributor guide:
18+
19+
https://docs.openstack.org/ansible-collection-kolla/latest/contributor/contributing.html

‎COPYING

+674
Large diffs are not rendered by default.

‎HACKING.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Ansible Collection Kolla Style Commandments
2+
===========================================
3+
4+
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/

‎README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Ansible Collection - openstack.kolla
2+
3+
The Ansible openstack.kolla collection provides Ansible plugins, modules and
4+
roles for OpenStack Kolla projects, including Kolla Ansible and Kayobe.
5+
6+
Kolla projects deploy OpenStack services and infrastructure components in
7+
Docker containers.
8+
9+
Kolla's mission statement is:
10+
11+
To provide production-ready containers and deployment tools for operating
12+
OpenStack clouds.
13+
14+
Kolla is highly opinionated out of the box, but allows for complete
15+
customization. This permits operators with little experience to deploy
16+
OpenStack quickly and as experience grows modify the OpenStack
17+
configuration to suit the operator's exact requirements.
18+
19+
## Getting Involved
20+
21+
Need a feature? Find a bug? Let us know! Contributions are much
22+
appreciated and should follow the standard [Gerrit
23+
workflow](https://docs.openstack.org/contributors/).
24+
25+
- We communicate using the #openstack-kolla irc channel.
26+
- File bugs, blueprints, track releases, etc on
27+
[Launchpad](https://launchpad.net/ansible-collection-kolla).
28+
- Attend weekly
29+
[meetings](https://docs.openstack.org/kolla/latest/contributor/meeting.html#meeting-agenda).
30+
- Contribute [code](https://opendev.org/openstack/ansible-collection-kolla).
31+
32+
## Notices
33+
34+
Docker and the Docker logo are trademarks or registered trademarks of
35+
Docker, Inc. in the United States and/or other countries. Docker, Inc.
36+
and other parties may also have trademark rights in other terms used herein.

‎doc/requirements.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
sphinx>=2.0.0,!=2.1.0 # BSD
2+
openstackdocstheme>=2.2.1 # Apache-2.0
3+
# releasenotes
4+
reno>=3.1.0 # Apache-2.0
5+
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

‎doc/source/conf.py

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Copyright StackHPC Ltd. All Rights Reserved.
2+
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
3+
4+
import os
5+
import sys
6+
7+
import openstackdocstheme
8+
9+
10+
sys.path.insert(0, os.path.abspath('../..'))
11+
# -- General configuration ----------------------------------------------------
12+
13+
# Add any Sphinx extension module names here, as strings. They can be
14+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
15+
extensions = [
16+
'openstackdocstheme',
17+
'sphinx.ext.autodoc',
18+
'sphinxcontrib.rsvgconverter',
19+
]
20+
21+
# autodoc generation is a bit aggressive and a nuisance when doing heavy
22+
# text edit cycles.
23+
# execute "export SPHINX_DEBUG=1" in your terminal to disable
24+
25+
# The suffix of source filenames.
26+
source_suffix = '.rst'
27+
28+
# The master toctree document.
29+
master_doc = 'index'
30+
31+
# General information about the project.
32+
project = u'ansible-collection-kolla'
33+
copyright = u'2017, OpenStack Developers'
34+
35+
# If true, '()' will be appended to :func: etc. cross-reference text.
36+
add_function_parentheses = True
37+
38+
# If true, the current module name will be prepended to all description
39+
# unit titles (such as .. function::).
40+
add_module_names = True
41+
42+
# The name of the Pygments (syntax highlighting) style to use.
43+
pygments_style = 'native'
44+
45+
# -- Options for HTML output --------------------------------------------------
46+
47+
# The theme to use for HTML and HTML Help pages. Major themes that come with
48+
# Sphinx are currently 'default' and 'sphinxdoc'.
49+
# html_theme_path = ["."]
50+
# html_theme = '_theme'
51+
# html_static_path = ['static']
52+
html_theme = 'openstackdocs'
53+
54+
# Output file base name for HTML help builder.
55+
htmlhelp_basename = '%sdoc' % project
56+
57+
# Grouping the document tree into LaTeX files. List of tuples
58+
# (source start file, target name, title, author, documentclass
59+
# [howto/manual]).
60+
latex_documents = [
61+
('index',
62+
'%s.tex' % project,
63+
'%s Documentation' % project,
64+
'OpenStack Foundation', 'manual'),
65+
]
66+
67+
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
68+
latex_use_xindy = False
69+
70+
# openstackdocstheme options
71+
openstackdocs_repo_name = 'openstack/ansible-collection-kolla'
72+
openstackdocs_pdf_link = True
73+
openstackdocs_bug_project = 'ansible-collection-kolla'
74+
openstackdocs_bug_tag = ''
75+
76+
openstackdocs_projects = [
77+
'kolla-ansible',
78+
]
79+

‎doc/source/contributor/contributing.rst

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
============================
2+
So You Want to Contribute...
3+
============================
4+
5+
For general information on contributing to OpenStack, please check out the
6+
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
7+
It covers all the basics that are common to all OpenStack projects: the
8+
accounts you need, the basics of interacting with our Gerrit review system,
9+
how we communicate as a community, etc.
10+
11+
Below will cover the more project specific information you need to get started
12+
with ansible-collection-kolla.
13+
14+
Much of the :kolla-ansible-doc:`Kolla Ansible contributor guide <contributor>`
15+
applies also to this project.
16+
17+
Basics
18+
~~~~~~
19+
20+
The source repository for this project can be found at:
21+
22+
https://opendev.org/openstack/ansible-collection-kolla
23+
24+
Communication
25+
~~~~~~~~~~~~~
26+
27+
ansible-collection-kolla shares communication channels with Kolla.
28+
29+
IRC Channel
30+
``#openstack-kolla`` (`channel logs`_) on `OFTC <http://oftc.net>`_
31+
32+
Weekly Meetings
33+
On Wednesdays at 15:00 UTC in the IRC channel (`meetings logs`_)
34+
35+
Mailing list (prefix subjects with ``[kolla]``)
36+
http://lists.openstack.org/pipermail/openstack-discuss/
37+
38+
Meeting Agenda
39+
https://wiki.openstack.org/wiki/Meetings/Kolla
40+
41+
Whiteboard (etherpad)
42+
Keeping track of CI gate status, release status, stable backports,
43+
planning and feature development status.
44+
https://etherpad.openstack.org/p/KollaWhiteBoard
45+
46+
.. _channel logs: http://eavesdrop.openstack.org/irclogs/%23openstack-kolla/
47+
.. _meetings logs: http://eavesdrop.openstack.org/meetings/kolla/
48+
49+
Contacting the Core Team
50+
~~~~~~~~~~~~~~~~~~~~~~~~
51+
52+
The Kolla Ansible core team is also the core team for ansible-collection-kolla.
53+
54+
New Feature Planning
55+
~~~~~~~~~~~~~~~~~~~~
56+
57+
New features are discussed via IRC or mailing list (with [kolla] prefix).
58+
ansible-collection-kolla keeps blueprints in `Launchpad <https://blueprints.launchpad.net/ansible-collection-kolla>`__.
59+
Specs are welcome but not strictly required.
60+
61+
Task Tracking
62+
~~~~~~~~~~~~~
63+
64+
Kolla project tracks tasks in `Launchpad <https://bugs.launchpad.net/ansible-collection-kolla>`__.
65+
Note this is the same place as for bugs.
66+
67+
If you're looking for some smaller, easier work item to pick up and get started
68+
on, search for the 'low-hanging-fruit' tag.
69+
70+
A more lightweight task tracking is done via etherpad - `Whiteboard <https://etherpad.openstack.org/p/KollaWhiteBoard>`__.
71+
72+
Reporting a Bug
73+
~~~~~~~~~~~~~~~
74+
75+
You found an issue and want to make sure we are aware of it? You can do so
76+
on `Launchpad <https://bugs.launchpad.net/ansible-collection-kolla>`__.
77+
Note this is the same place as for tasks.
78+
79+
Getting Your Patch Merged
80+
~~~~~~~~~~~~~~~~~~~~~~~~~
81+
82+
Most changes proposed to ansible-collection-kolla require two +2 votes from
83+
core reviewers before +W. A release note is required on most changes as well.
84+
Release notes policy is described in :kolla-ansible-doc:`Kolla Ansible
85+
contributor guide <contributor/release-notes>`.
86+
87+
Significant changes should have documentation and testing provided with them.
88+
89+
Project Team Lead Duties
90+
~~~~~~~~~~~~~~~~~~~~~~~~
91+
92+
All common PTL duties are enumerated in the `PTL guide
93+
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
94+
Kolla Ansible-specific PTL duties are listed in :kolla-ansible-doc:`Kolla
95+
Ansible PTL guide <contributor/ptl-guide>`.

‎doc/source/contributor/index.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
=================
2+
Contributor Guide
3+
=================
4+
5+
This guide is for contributors of the ansible-collection-kolla project. It
6+
includes information on proposing your first patch and how to participate in
7+
the community. It also covers responsibilities of core reviewers and the
8+
Project Team Lead (PTL), and information about development processes.
9+
10+
We welcome everyone to join our project!
11+
12+
.. toctree::
13+
:maxdepth: 1
14+
15+
contributing

‎doc/source/index.rst

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
========================================================
2+
Welcome to the documentation of ansible-collection-kolla
3+
========================================================
4+
5+
Contents:
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
contributor/index
11+
12+
Indices and tables
13+
==================
14+
15+
* :ref:`genindex`
16+
* :ref:`modindex`
17+
* :ref:`search`

‎galaxy.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
namespace: openstack
3+
name: kolla
4+
version: 1.0.0
5+
readme: README.md
6+
authors: OpenStack
7+
description: Ansible collection for the OpenStack Kolla project
8+
license:
9+
- GPL-3.0-or-later
10+
tags:
11+
- cloud
12+
- kolla
13+
- openstack
14+
dependencies: {}
15+
repository: https://opendev.org/openstack/ansible-collection-kolla
16+
documentation: https://opendev.org/openstack/ansible-collection-kolla/src/branch/master/README.md
17+
homepage: https://opendev.org/openstack/ansible-collection-kolla
18+
issues: https://launchpad.net/ansible-collection-kolla
19+
build_ignore:
20+
- "*.tar.gz"
21+
- requirements.txt
22+
- setup.cfg
23+
- setup.py
24+
- test-requirements.txt
25+
- tox.ini
26+
- zuul.d
27+
- .gitignore
28+
- .gitreview
29+
- .stestr.conf
30+
- .tox

‎releasenotes/notes/.placeholder

Whitespace-only changes.

‎releasenotes/source/_static/.placeholder

Whitespace-only changes.

‎releasenotes/source/_templates/.placeholder

Whitespace-only changes.

0 commit comments

Comments
 (0)