initial commit

Change-Id: I5e228c1099f4ba2a9f63e6a2d038867fab53d929

.gitignore

@@ -0,0 +1,61 @@
+# Add patterns in here to exclude files created by tools integrated with this
+# repository, such as test frameworks from the project's recommended workflow,
+# rendered documentation and package builds.
+#
+# Don't add patterns to exclude files created by preferred personal tools
+# (editors, IDEs, your operating system itself even). These should instead be
+# maintained outside the repository, for example in a ~/.gitignore file added
+# with:
+#
+# git config --global core.excludesfile '~/.gitignore'
+
+# Bytecompiled Python
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg*
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+cover/
+.coverage*
+!.coveragerc
+.tox
+nosetests.xml
+.testrepository
+.stestr
+.venv
+
+# Translations
+*.mo
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+doc/build
+
+# pbr generates these
+AUTHORS
+ChangeLog
+
+# Files created by releasenotes build
+releasenotes/build

CONTRIBUTING.rst

@@ -0,0 +1,3 @@
+The source repository for this project can be found at:
+
+   https://gitea.eco.tsi-dev.otc-service.com/docs/resource-formation-service/github.com//resource-formation-service

README.rst

@@ -0,0 +1,11 @@
+===============================
+resource-formation-service
+===============================
+
+Open Telekom Cloud Resource Formation Service docs
+
+Please fill here a long description which must be at least 3 lines wrapped on
+80 cols, so that distribution package maintainers can use it in their packages.
+Note that this is a hard requirement.
+
+* Free software: Apache license

api-ref/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+otcdocstheme>=1.0.0 # Apache-2.0
+# releasenotes
+reno>=3.1.0 # Apache-2.0

api-ref/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# 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.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'otcdocstheme',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'resource-formation-service'
+copyright = '2022, Open Telekom Cloud Developers'
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'native'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+html_theme = 'otcdocs'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     '%s Documentation' % project,
+     'Open Telekom Cloud Developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

api-ref/source/index.rst

@@ -0,0 +1,3 @@
+==========================================================
+Welcome to the documentation of resource-formation-service
+==========================================================

dev_guide/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+otcdocstheme>=1.0.0 # Apache-2.0
+# releasenotes
+reno>=3.1.0 # Apache-2.0

dev_guide/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# 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.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'otcdocstheme',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'resource-formation-service'
+copyright = '2022, Open Telekom Cloud Developers'
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'native'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+html_theme = 'otcdocs'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     '%s Documentation' % project,
+     'Open Telekom Cloud Developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

dev_guide/source/index.rst

@@ -0,0 +1,3 @@
+==========================================================
+Welcome to the documentation of resource-formation-service
+==========================================================

doc/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+otcdocstheme # Apache-2.0
+# releasenotes
+reno>=3.1.0 # Apache-2.0

doc/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# 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.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'otcdocstheme',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'resource-formation-service'
+copyright = '2022, Open Telekom Cloud Developers'
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'native'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+html_theme = 'otcdocs'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     '%s Documentation' % project,
+     'Open Telekom Cloud Developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/index.rst

@@ -0,0 +1,3 @@
+==========================================================
+Welcome to the documentation of resource-formation-service
+==========================================================

releasenotes/source/index.rst

@@ -0,0 +1,8 @@
+============================================
+resource-formation-service Release Notes
+============================================
+
+.. toctree::
+   :maxdepth: 1
+
+   unreleased

releasenotes/source/unreleased.rst

@@ -0,0 +1,5 @@
+==============================
+ Current Series Release Notes
+==============================
+
+.. release-notes::

requirements.txt

@@ -0,0 +1,5 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+pbr>=2.0 # Apache-2.0

setup.cfg

@@ -0,0 +1,23 @@
+[metadata]
+name = resource-formation-service
+summary = Open Telekom Cloud Resource Formation Service docs
+description-file =
+    README.rst
+author = Open Telekom Cloud
+home-page = https://open.telekom.cloud/
+python-requires = >=3.6
+classifier =
+    Environment :: OpenStack
+    Intended Audience :: Information Technology
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: Apache Software License
+    Operating System :: POSIX :: Linux
+    Programming Language :: Python
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: Implementation :: CPython
+
+[files]

setup.py

@@ -0,0 +1,22 @@
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
+#
+# 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.
+
+import setuptools
+
+setuptools.setup(
+    setup_requires=['pbr'],
+    pbr=True,
+    py_modules=[]
+)

test-requirements.txt

@@ -0,0 +1,10 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+hacking>=3.0,<3.1 # Apache-2.0
+
+coverage>=4.0,!=4.4 # Apache-2.0
+python-subunit>=0.0.18 # Apache-2.0/BSD
+stestr>=1.0.0 # Apache-2.0
+testtools>=1.4.0 # MIT

tox.ini

@@ -0,0 +1,95 @@
+[tox]
+minversion = 3.1
+envlist = py310,pep8
+skipsdist = True
+ignore_basepython_conflict = True
+
+[testenv]
+usedevelop = True
+install_command = pip install {opts} {packages}
+deps =
+    -r{toxinidir}/requirements.txt
+commands = stestr run {posargs}
+           stestr slowest
+
+[testenv:pep8]
+commands =
+    doc8 doc/source README.rst
+
+[testenv:venv]
+deps =
+    -r{toxinidir}/requirements.txt
+commands = {posargs}
+
+[testenv:docs]
+deps =
+    -r{toxinidir}/doc/requirements.txt
+commands =
+    sphinx-build -W --keep-going -b html doc/source/ doc/build/html
+
+[testenv:api-ref]
+# This environment is called from CI scripts to test and publish
+# the API Ref to docs.otc-service.com
+deps =
+    -r{toxinidir}/requirements.txt
+whitelist_externals = rm
+commands =
+  rm -rf api-ref/build
+  sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
+
+[testenv:api-ref-pdf-docs]
+deps = {[testenv:api-ref]deps}
+envdir = {toxworkdir}/api-ref
+whitelist_externals =
+  rm
+  make
+commands =
+  rm -rf api-ref/build/pdf
+  sphinx-build -a -E -W -b latex api-ref/source api-ref/build/pdf
+  make -C api-ref/build/pdf
+
+[testenv:umn]
+# This environment is called from CI scripts to test and publish
+# the UMN to docs.otc-service.com
+deps =
+    -r{toxinidir}/requirements.txt
+whitelist_externals = rm
+commands =
+  rm -rf umn/build
+  sphinx-build -W -b html -d umn/build/doctrees umn/source umn/build/html
+
+[testenv:umn-pdf-docs]
+deps = {[testenv:umn]deps}
+envdir = {toxworkdir}/umn
+whitelist_externals =
+  rm
+  make
+  bash
+commands =
+  rm -rf umn/build/pdf
+  sphinx-build -a -E -W -b latex umn/source umn/build/pdf
+  bash -c "for f in umn/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
+  bash -c "for f in umn/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
+  make -C umn/build/pdf
+
+[testenv:dev-guide]
+# This environment is called from CI scripts to test and publish
+# the Developer Guide to docs.otc-service.com
+deps =
+    -r{toxinidir}/requirements.txt
+whitelist_externals = rm
+commands =
+  rm -rf dev_guide/build
+  sphinx-build -W -b html -d dev_guide/build/doctrees dev_guide/source dev_guide/build/html
+
+[testenv:dev-guide-pdf-docs]
+deps = {[testenv:dev-guide]deps}
+envdir = {toxworkdir}/dev_guide
+whitelist_externals =
+  rm
+  make
+  sh
+commands =
+  rm -rf dev_guide/build/pdf
+  sphinx-build -a -E -W -b latex dev_guide/source dev_guide/build/pdf
+  make -C dev_guide/build/pdf

umn/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+otcdocstheme>=1.0.0 # Apache-2.0
+# releasenotes
+reno>=3.1.0 # Apache-2.0

umn/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# 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.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'otcdocstheme',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'resource-formation-service'
+copyright = '2022, Open Telekom Cloud Developers'
+
+# 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
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'native'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+html_theme = 'otcdocs'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     '%s Documentation' % project,
+     'Open Telekom Cloud Developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

umn/source/index.rst

@@ -0,0 +1,3 @@
+==========================================================
+Welcome to the documentation of resource-formation-service
+==========================================================

zuul.yaml

@@ -0,0 +1,11 @@
+- project:
+    merge-mode: squash-merge
+    default-branch: main
+    templates:
+      - helpcenter-base-jobs
+    check:
+      jobs:
+        - noop
+    gate:
+      jobs:
+        - noop