commit f1321faef0fb349e68261a769a24f740ef76e248 Author: Artem Goncharov Date: Thu Aug 18 18:51:19 2022 +0200 Initial import diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..f69ff5d --- /dev/null +++ b/.coveragerc @@ -0,0 +1,6 @@ +[run] +branch = True +source = otc-metadata + +[report] +ignore_errors = True diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4cbb844 --- /dev/null +++ b/.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 diff --git a/.gitreview b/.gitreview new file mode 100644 index 0000000..f94068c --- /dev/null +++ b/.gitreview @@ -0,0 +1,4 @@ +[gerrit] +host=review.opendev.org +port=29418 +project=infra/ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git.git diff --git a/.mailmap b/.mailmap new file mode 100644 index 0000000..516ae6f --- /dev/null +++ b/.mailmap @@ -0,0 +1,3 @@ +# Format is: +# +# diff --git a/.stestr.conf b/.stestr.conf new file mode 100644 index 0000000..c025c8e --- /dev/null +++ b/.stestr.conf @@ -0,0 +1,3 @@ +[DEFAULT] +test_path=./otc-metadata/tests +top_dir=./ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..0dfa8c4 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,3 @@ +The source repository for this project can be found at: + + https://github.com/infra/ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..ed23457 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,4 @@ +ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git Style Commandments +=============================================== + +Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6020cf3 --- /dev/null +++ b/README.rst @@ -0,0 +1,18 @@ +=============================== +ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git +=============================== + +Metadata about OTC for Ecosystem + +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 +* Documentation: https://docs.otc.t-systems.com/ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git +* Source: https://github.com/infra/ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git + +Features +-------- + +* TODO diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..23b871f --- /dev/null +++ b/doc/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 diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 0000000..baa1cdb --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,5 @@ +==================== +Administrators guide +==================== + +Administrators guide of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 0000000..fc0360f --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,5 @@ +================================ +Command line interface reference +================================ + +CLI reference of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git. diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100755 index 0000000..3c78326 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,76 @@ +# -*- 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', + #'sphinx.ext.intersphinx', +] + +# 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 = 'ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git' +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} diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 0000000..230a71c --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,5 @@ +============= +Configuration +============= + +Configuration of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git. diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..2e91325 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,5 @@ +============================ +So You Want to Contribute... +============================ + +TODO diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..036e449 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,9 @@ +=========================== + Contributor Documentation +=========================== + +.. toctree:: + :maxdepth: 2 + + contributing + diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..deb017d --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,30 @@ +.. ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git documentation master file, created by + sphinx-quickstart on Tue Jul 9 22:26:36 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +============================================ +Welcome to the documentation of otc-metadata +============================================ + +Contents: + +.. toctree:: + :maxdepth: 2 + + readme + install/index + library/index + contributor/index + configuration/index + cli/index + user/index + admin/index + reference/index + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 0000000..6d7dc44 --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,14 @@ +================================================ + {{cookiecutter.module_name}} installation guide +================================================ + +.. toctree:: + :maxdepth: 2 + + install.rst + +The otc-metadata provides... + +This chapter assumes a working setup of OpenStack following the +`OpenStack Installation Tutorial +`_. diff --git a/doc/source/install/install.rst b/doc/source/install/install.rst new file mode 100644 index 0000000..3d5c5a7 --- /dev/null +++ b/doc/source/install/install.rst @@ -0,0 +1,13 @@ +.. _install: + +Install and configure +~~~~~~~~~~~~~~~~~~~~~ + +This section describes how to install and configure the +otc-metadata. + +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. diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst new file mode 100644 index 0000000..bd783d1 --- /dev/null +++ b/doc/source/library/index.rst @@ -0,0 +1,7 @@ +======== +Usage +======== + +To use ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git in a project:: + + import otc-metadata diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 0000000..a6210d3 --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..84c158a --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,5 @@ +========== +References +========== + +References of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git. diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..410ec21 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,5 @@ +=========== +Users guide +=========== + +Users guide of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git. diff --git a/otc_metadata/__init__.py b/otc_metadata/__init__.py new file mode 100644 index 0000000..56b98c7 --- /dev/null +++ b/otc_metadata/__init__.py @@ -0,0 +1,35 @@ +# 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. +__all__ = ['__version__', 'Docs'] + +import pbr.version + +from otc_metadata.services import Services # flake8: noqa + +__version__ = pbr.version.VersionInfo('otc-metadata').version_string() +_service_manager = None + + +def get_service_data(*args, **kwargs): + """Return singleton instance of the Services object. + Parameters are all passed through to the + :class:`~otc_metadata.services.Services` constructor. + .. note:: + Only one singleton is kept, so if instances with different parameter + values are desired, directly calling the constructor is necessary. + :returns: Singleton instance of + :class:`~otc_metadata.services.Services` + """ + global _service_manager + if not _service_manager: + _service_manager = Services(*args, **kwargs) + return _service_manager diff --git a/otc_metadata/data/__init__.py b/otc_metadata/data/__init__.py new file mode 100644 index 0000000..4f8c13c --- /dev/null +++ b/otc_metadata/data/__init__.py @@ -0,0 +1,29 @@ +# 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 yaml + +__all__ = ['read_data'] + +DATA_DIR = os.path.dirname(__file__) + + +def read_data(filename): + """Return data that is shipped inside the Python package. + + """ + + filepath = os.path.join(DATA_DIR, filename) + with open(filepath, 'r') as fd: + return yaml.safe_load(fd) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml new file mode 100644 index 0000000..5c2d461 --- /dev/null +++ b/otc_metadata/data/services.yaml @@ -0,0 +1,876 @@ +--- +service_categories: + - name: application + - name: big_data + - name: compute + - name: container + - name: database +services: + # Application + # AOM + - service_title: Application Operations Management + service_category: application + repository: docs/application-operations-management + service_type: aom + docs: + - type: umn + html_location: docs/aom/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/aom/api-ref + rst_location: api-ref/source + title: API Reference + # DMS + - service_title: Distributed Message Service + service_category: application + repository: docs/distributed-message-service + service_type: dms + docs: + - type: umn + html_location: docs/dms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dms/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/dms/dev + rst_location: dev_guide/source + title: Developer Guide + # SMN + - service_title: Simple Message Notification + service_category: application + repository: docs/simple-message-notification + service_type: smn + docs: + - type: umn + html_location: docs/smn/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/smn/api-ref + rst_location: api-ref/source + title: API Reference + # Big Data + # CSS + - service_title: Cloud Search Service + service_category: big_data + repository: docs/cloud-search-service + service_type: css + docs: + - type: umn + html_location: docs/css/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/css/api-ref + rst_location: api-ref/source + title: API Reference + # DIS + - service_title: Data Ingestion Service + service_category: big_data + repository: docs/data-ingestion-service + service_type: dis + docs: + - type: umn + html_location: docs/dis/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dis/api-ref + rst_location: api-ref/source + title: API Reference + # DWS + - service_title: Data Warehouse Service + service_category: big_data + repository: docs/data-ingestion-service + service_type: dws + docs: + - type: umn + html_location: docs/dws/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dws/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/dws/dev + rst_location: dev_guide/source + title: Developer Guide + - type: tool-guide + html_location: docs/dws/tool + rst_location: tool_guide/source + title: Tool Guide + # ModelArts + - service_title: ModelArts + service_category: big_data + repository: docs/modelarts + service_type: ma + docs: + - type: umn + html_location: docs/modelarts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/modelarts/api-ref + rst_location: api-ref/source + title: API Reference + # MRS + - service_title: Map Reduce Service + service_category: big_data + repository: docs/mapreduce-service + service_type: mrs + docs: + - type: umn + html_location: docs/mrs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/mrs/api-ref + rst_location: api-ref/source + title: API Reference + - type: component-operation-guide + html_location: docs/mrs/component-operation-guide + rst_location: component-operation-guide/source + title: Component Operation Guide + # Compute + # AS + - service_title: Auto Scaling + service_category: compute + repository: docs/auto-scaling + service_type: as + docs: + - type: umn + html_location: docs/as/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/as/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/as/dev + rst_location: dev_guide/source + title: Developer Guide + # BMS + - service_title: Bare Metal Server + service_category: compute + repository: docs/bare-metal-server + service_type: bms + docs: + - type: umn + html_location: docs/bms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/bms/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/bms/dev + rst_location: dev_guide/source + title: Developer Guide + - type: image-creation-guide + html_location: docs/bms/image-creation-guide + rst_location: image-creation-guide/source + title: Private Image Creation Guide + # DeH + - service_title: Dedicated Host + service_category: compute + repository: docs/dedicated-host + service_type: deh + docs: + - type: umn + html_location: docs/deh/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/deh/api-ref + rst_location: api-ref/source + title: API Reference + # ECS + - service_title: Elastic Cloud Server + service_category: compute + repository: docs/elastic-cloud-server + service_type: ecs + docs: + - type: umn + html_location: docs/ecs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/ecs/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/ecs/dev + rst_location: dev_guide/source + title: Developer Guide + # IMS + - service_title: Image Management Service + service_category: compute + repository: docs/image-management-service + service_type: ims + docs: + - type: umn + html_location: docs/ims/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/ims/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/ims/dev + rst_location: dev_guide/source + title: Developer Guide + - type: public-images + html_location: docs/ims/public-images + rst_location: public-images/source + title: Public Image Introduction + # Container: + # CCE + - service_title: Cloud Container Service + service_category: container + repository: docs/cloud-container-service + service_type: cce + docs: + - type: umn + html_location: docs/cce/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/cce/api-ref + rst_location: api-ref/source + title: API Reference + # SWR + - service_title: Software Repository for Containers + service_category: container + repository: docs/software-repository-container + service_type: swr + docs: + - type: umn + html_location: docs/swr/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/swr/api-ref + rst_location: api-ref/source + title: API Reference + # Database: + # DAS + - service_title: Data Admin Service + service_category: database + repository: docs/data-admin-service + service_type: das + docs: + - type: umn + html_location: docs/das/umn + rst_location: umn/source + title: User Guide + # DRS + - service_title: Data Replication Service + service_category: database + repository: docs/data-replication-service + service_type: drs + docs: + - type: umn + html_location: docs/drs/umn + rst_location: umn/source + title: User Guide + # DCS + - service_title: Distributed Cache Service + service_category: database + repository: docs/distributed-cache-service + service_type: dcs + docs: + - type: umn + html_location: docs/dcs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dcs/api-ref + rst_location: api-ref/source + title: API Reference + # DDS + - service_title: Document Database Service + service_category: database + repository: docs/document-database-service + service_type: dds + docs: + - type: umn + html_location: docs/dds/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dds/api-ref + rst_location: api-ref/source + title: API Reference + # GAUSSDB_MYSQL + - service_title: GaussDB Enterprise-class Distributed Database compatible with MySQL + service_category: database + repository: docs/gaussdb-mysql + service_type: gaussdb_mysql + docs: + - type: umn + html_location: docs/gaussdb_mysql/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/gaussdb_mysql/api-ref + rst_location: api-ref/source + title: API Reference + # GAUSSDB_NOSQL + - service_title: GaussDB Distributed Multi-model NoSQL Database + service_category: database + repository: docs/gaussdb-nosql + service_type: gaussdb_nosql + docs: + - type: umn + html_location: docs/gaussdb_nosql/umn + rst_location: umn/source + title: User Guide + # OPENGAUSSDB + - service_title: GaussDB Enterprise-grade Relational Database on the openGauss ecosystem + service_category: database + repository: docs/gaussdb-opengauss + service_type: opengauss + docs: + - type: umn + html_location: docs/opengauss/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/opengauss/api-ref + rst_location: api-ref/source + title: API Reference + # RDS + - service_title: Relational Database Service + service_category: database + repository: docs/relational-database-service + service_type: rds + docs: + - type: umn + html_location: docs/rds/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/rds/api-ref + rst_location: api-ref/source + title: API Reference + # Management&Deployment: + # Cloud Eye + - service_title: Cloud Eye + service_category: md + repository: docs/cloud-eye + service_type: ces + docs: + - type: umn + html_location: docs/ces/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/ces/api-ref + rst_location: api-ref/source + title: API Reference + # CTS + - service_title: Cloud Trace Service + service_category: md + repository: docs/cloud-trace-service + service_type: ces + docs: + - type: umn + html_location: docs/cts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/cts/api-ref + rst_location: api-ref/source + title: API Reference + # IAM + - service_title: Identity and Access Management + service_category: md + repository: docs/identity-access-management + service_type: iam + docs: + - type: umn + html_location: docs/iam/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/iam/api-ref + rst_location: api-ref/source + title: API Reference + # LTS + - service_title: Log Tank Service + service_category: md + repository: docs/log-tank-service + service_type: lts + docs: + - type: umn + html_location: docs/lts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/lts/api-ref + rst_location: api-ref/source + title: API Reference + # RTS + - service_title: Resource Template Service + service_category: md + repository: docs/resource-template-service + service_type: rts + docs: + - type: umn + html_location: docs/rts/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/rts/api-ref + rst_location: api-ref/source + title: API Reference + # TMS + - service_title: Tag Management Service + service_category: md + repository: docs/tag-management-service + service_type: tms + docs: + - type: umn + html_location: docs/tms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/tms/api-ref + rst_location: api-ref/source + title: API Reference + # Network: + # CDN + - service_title: Content Delivery Network (Akamai) + service_category: network + repository: docs/content-delivery-network + service_type: cdn + docs: + - type: umn + html_location: docs/cdn/umn + rst_location: umn/source + title: User Guide + # DC + - service_title: Direct Connect + service_category: network + repository: docs/direct-connect + service_type: dc + docs: + - type: umn + html_location: docs/dc/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dc/api-ref + rst_location: api-ref/source + title: API Reference + # DNS + - service_title: Domain Name Service + service_category: network + repository: docs/domain-name-service + service_type: dns + docs: + - type: umn + html_location: docs/dns/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/dns/api-ref + rst_location: api-ref/source + title: API Reference + # EIP + - service_title: Elastic IP + service_category: network + repository: docs/elastic-ip + service_type: eip + docs: + - type: umn + html_location: docs/eip/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/eip/api-ref + rst_location: api-ref/source + title: API Reference + # ELB + - service_title: Elastic Load Balancing + service_category: network + repository: docs/elastic-load-balancing + service_type: elb + docs: + - type: umn + html_location: docs/elb/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/elb/api-ref + rst_location: api-ref/source + title: API Reference + # NATGW + - service_title: NAT Gateway + service_category: network + repository: docs/nat-gateway + service_type: nat + docs: + - type: umn + html_location: docs/natgw/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/natgw/api-ref + rst_location: api-ref/source + title: API Reference + # PLAS + - service_title: Private Link Access + service_category: network + repository: docs/private-link-access-service + service_type: plas + docs: + - type: umn + html_location: docs/plas/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/plas/api-ref + rst_location: api-ref/source + title: API Reference + # VPC + - service_title: Virtual Private Cloud + service_category: network + repository: docs/virtual-private-cloud + service_type: vpc + docs: + - type: umn + html_location: docs/vpc/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vpc/api-ref + rst_location: api-ref/source + title: API Reference + # VPN + - service_title: Virtual Private Network + service_category: network + repository: docs/virtual-private-network + service_type: vpn + docs: + - type: umn + html_location: docs/vpn/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vpn/api-ref + rst_location: api-ref/source + title: API Reference + # VPCE + - service_title: VPC Endpoint + service_category: network + repository: docs/vpc-endpoint + service_type: vpce + docs: + - type: umn + html_location: docs/vpce/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vpce/api-ref + rst_location: api-ref/source + title: API Reference + # others: + # API Usage Guidelines + - service_title: API Usage Guidelines + service_category: other + repository: docs/api-usage-guidelines + service_type: apiug + docs: + - type: umn + html_location: docs/apiug/umn + rst_location: umn/source + title: User Guide + # API White Paper + - service_title: API White Paper + service_category: other + repository: docs/api-white-paper + service_type: apiwp + docs: + - type: umn + html_location: docs/apiwp/umn + rst_location: umn/source + title: User Guide + # Enterprise Dashboard + - service_title: Enterprise Dashboard + service_category: other + repository: docs/enterprise-dashboard + service_type: ed + docs: + - type: umn + html_location: docs/ed/umn + rst_location: umn/source + title: User Guide + # FAQs + - service_title: FAQs + service_category: other + repository: docs/faqs + service_type: faqs + docs: + - type: umn + html_location: docs/faqs/umn + rst_location: umn/source + title: User Guide + # Glossary + - service_title: Glossary + service_category: other + repository: docs/glossary + service_type: glossary + docs: + - type: umn + html_location: docs/glossary/umn + rst_location: umn/source + title: User Guide + # My Credential + - service_title: My Credential + service_category: other + repository: docs/my-credential + service_type: my-credential + docs: + - type: umn + html_location: docs/my-credential/umn + rst_location: umn/source + title: User Guide + # Permissions + - service_title: Permissions + service_category: other + repository: docs/permissions + service_type: permissions + docs: + - type: umn + html_location: docs/permissions/umn + rst_location: umn/source + title: User Guide + # Regions and Endpoints + - service_title: Regions and Endpoints + service_category: other + repository: docs/regions-endpoints + service_type: regions-endpoints + docs: + - type: umn + html_location: docs/regions-endpoints/umn + rst_location: umn/source + title: User Guide + # Secure Mail Gateway + - service_title: Secure Mail Gateway + service_category: other + repository: docs/secure-mail-gateway + service_type: smg + docs: + - type: umn + html_location: docs/smg/umn + rst_location: umn/source + title: User Guide + - type: umn-de + html_location: docs/smg/umn-de + rst_location: umn-de/source + title: User Guide + # Status Dashboard + - service_title: Status Dashboard + service_category: other + repository: docs/status-dashboard + service_type: sd + docs: + - type: umn + html_location: docs/sd/umn + rst_location: umn/source + title: User Guide + # Security: + # Anti-DDoS + - service_title: Anti DDoS + service_category: security + repository: docs/anti-ddos + service_type: antiddos + docs: + - type: umn + html_location: docs/antiddos/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/antiddos/api-ref + rst_location: api-ref/source + title: API Reference + # KMS + - service_title: Key Management Service + service_category: security + repository: docs/key-management-service + service_type: kms + docs: + - type: umn + html_location: docs/kms/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/kms/api-ref + rst_location: api-ref/source + title: API Reference + # WAF + - service_title: Web Application Firewall + service_category: security + repository: docs/web-application-firewall + service_type: waf + docs: + - type: umn + html_location: docs/waf/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/waf/api-ref + rst_location: api-ref/source + title: API Reference + # WAFD + - service_title: Dedicated Web Application Firewall + service_category: security + repository: docs/web-application-firewall-dedicated + service_type: waf + docs: + - type: umn + html_location: docs/wafd/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/wafd/api-ref + rst_location: api-ref/source + title: API Reference + # Storage: + # CBR + - service_title: Cloud Backup and Recovery + service_category: storage + repository: docs/cloud-backup-recovery + service_type: cbr + docs: + - type: umn + html_location: docs/cbr/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/cbr/api-ref + rst_location: api-ref/source + title: API Reference + # CSBS + - service_title: Cloud Server Backup Service + service_category: storage + repository: docs/cloud-server-backup-service + service_type: csbs + docs: + - type: umn + html_location: docs/csbs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/csbs/api-ref + rst_location: api-ref/source + title: API Reference + # EVS + - service_title: Elastic Volume Service + service_category: storage + repository: docs/elastic-volume-service + service_type: evs + docs: + - type: umn + html_location: docs/evs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/evs/api-ref + rst_location: api-ref/source + title: API Reference + - type: dev-guide + html_location: docs/evs/dev + rst_location: dev_guide/source + title: Developer Guide + # OBS + - service_title: Object Storage Service + service_category: storage + repository: docs/object-storage-service + service_type: obs + docs: + - type: umn + html_location: docs/obs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/obs/api-ref + rst_location: api-ref/source + title: API Reference + - type: s3api + html_location: docs/obs/s3api + rst_location: doc/s3api/source + title: S3 API Reference + - type: s3cmd + html_location: docs/obs/s3cmd + rst_location: doc/s3cmd/source + title: Third-Party Client (s3cmd) + - type: tool-guide + html_location: docs/obs/dev + rst_location: dev_guide/source + title: Developer Guide + # OBS SWIFT + - service_title: Swift Object Storage Service + service_category: storage + repository: docs/swift-object-storage-service + service_type: obs-swift + docs: + - type: api-ref + html_location: docs/obs-swift/api-ref + rst_location: api-ref/source + title: API Reference + # SDRS + - service_title: Storage Disaster Recovery Service + service_category: storage + repository: docs/storage-disaster-recovery-service + service_type: sdrs + docs: + - type: umn + html_location: docs/sdrs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/sdrs/api-ref + rst_location: api-ref/source + title: API Reference + # SFS + - service_title: Scalable File System + service_category: storage + repository: docs/scalable-file-system + service_type: sfs + docs: + - type: umn + html_location: docs/sfs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/sfs/api-ref + rst_location: api-ref/source + title: API Reference + - type: cli + html_location: docs/sfs/cli + rst_location: doc/cli/source + title: Manila Client Reference + # VBS + - service_title: Volume Backup Service + service_category: storage + repository: docs/volume-backup-service + service_type: vbs + docs: + - type: umn + html_location: docs/vbs/umn + rst_location: umn/source + title: User Guide + - type: api-ref + html_location: docs/vbs/api-ref + rst_location: api-ref/source + title: API Reference diff --git a/otc_metadata/docs.py b/otc_metadata/docs.py new file mode 100644 index 0000000..781cc9f --- /dev/null +++ b/otc_metadata/docs.py @@ -0,0 +1,38 @@ +# 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 copy + +import otc_metadata.data + +__all__ = ['Docs'] + +BUILTIN_DATA = otc_metadata.data.read_data('docs.yaml') + + +def _normalize_type(service_type): + if service_type: + return service_type.replace('_', '-') + + +class Service(object): + """Encapsulation of the OTC Docs data + """ + + def __init__(self): + self._service_data = BUILTIN_DATA + + @property + def all_services(self): + "Service Categories data listing." + return copy.deepcopy(self._service_data['services']) diff --git a/otc_metadata/services.py b/otc_metadata/services.py new file mode 100644 index 0000000..a65067c --- /dev/null +++ b/otc_metadata/services.py @@ -0,0 +1,47 @@ +# 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 copy + +import otc_metadata.data + +__all__ = ['Services'] + +BUILTIN_DATA = otc_metadata.data.read_data('services.yaml') + + +def _normalize_type(service_type): + if service_type: + return service_type.replace('_', '-') + + +class Services(object): + """Encapsulation of the OTC Services data + """ + + def __init__(self): + self._service_data = BUILTIN_DATA + + @property + def all_services(self): + "Service Categories data listing." + return copy.deepcopy(self._service_data['services']) + + def services_by_category(self, category): + """List services matching category + """ + res = [] + for srv in self.all_services: + if srv['service_category'] == category: + res.append(copy.deepcopy(srv)) + return res diff --git a/otc_metadata/tests/__init__.py b/otc_metadata/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/otc_metadata/tests/base.py b/otc_metadata/tests/base.py new file mode 100644 index 0000000..8a06ce9 --- /dev/null +++ b/otc_metadata/tests/base.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- + +# Copyright 2010-2011 OpenStack Foundation +# 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. + +from unittest import TestCase + + +class TestCase(TestCase): + + """Test case base class for all unit tests.""" diff --git a/otc_metadata/tests/test_otc-metadata.py b/otc_metadata/tests/test_otc-metadata.py new file mode 100644 index 0000000..24401b2 --- /dev/null +++ b/otc_metadata/tests/test_otc-metadata.py @@ -0,0 +1,28 @@ +# -*- 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. + +""" +test_otc-metadata +---------------------------------- + +Tests for `otc-metadata` module. +""" + +from otc-metadata.tests import base + + +class TestOtc-metadata(base.TestCase): + + def test_something(self): + pass diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..ecd0d77 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,271 @@ +# -*- 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. + +# 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. + +# 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 = [ + 'otcdocstheme', + 'reno.sphinxext', +] + +# 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 = 'otc-metadata Release Notes' +copyright = '2022, Open Telekom Cloud Developers' + +# 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. +# The full version, including alpha/beta/rc tags. +release = '' +# The short X.Y version. +version = '' + +# 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 = [] + +# 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 = 'native' + +# 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 = 'otcdocs' + +# 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 = [] + +# 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 = ['_static'] + +# 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 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 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 = 'otc-metadataReleaseNotesdoc' + + +# -- 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', 'otc-metadataReleaseNotes.tex', + 'otc-metadata Release Notes Documentation', + 'Open Telekom Cloud', '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', 'otc-metadatarereleasenotes', + 'otc-metadata Release Notes Documentation', + ['Open Telekom Cloud'], 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', 'otc-metadata ReleaseNotes', + 'otc-metadata Release Notes Documentation', + 'Open Telekom Cloud Foundation', 'otc-metadataReleaseNotes', + 'One line description of project.', + '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/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000..a040fa0 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,8 @@ +============================================ + otc-metadata Release Notes +============================================ + +.. toctree:: + :maxdepth: 1 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..cd22aab --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================== + Current Series Release Notes +============================== + +.. release-notes:: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1d18dd3 --- /dev/null +++ b/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 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..aa41ce1 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,25 @@ +[metadata] +name = ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git +summary = Metadata about OTC for Ecosystem +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] +packages = + otc_metadata diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..6016f37 --- /dev/null +++ b/setup.py @@ -0,0 +1,19 @@ +# 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 MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..7f21c17 --- /dev/null +++ b/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 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..05782c8 --- /dev/null +++ b/tox.ini @@ -0,0 +1,56 @@ +[tox] +minversion = 3.2.0 +envlist = py39,pep8 +skipsdist = True +ignore_basepython_conflict = true + + +[testenv] +basepython = python3 +usedevelop = True +setenv = + PYTHONWARNINGS=default::DeprecationWarning + OS_STDOUT_CAPTURE=1 + OS_STDERR_CAPTURE=1 + OS_TEST_TIMEOUT=60 +deps = -r{toxinidir}/test-requirements.txt +commands = stestr run {posargs} + +[testenv:lower-constraints] +deps = -r{toxinidir}/test-requirements.txt + +[testenv:pep8] +commands = flake8 {posargs} + +[testenv:venv] +commands = {posargs} + +[testenv:cover] +setenv = + VIRTUAL_ENV={envdir} + PYTHON=coverage run --source otc_metadata --parallel-mode +commands = + stestr run {posargs} + coverage combine + coverage html -d cover + coverage xml -o cover/coverage.xml + +[testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -b html doc/source doc/build/html + +[testenv:releasenotes] +deps = {[testenv:docs]deps} +commands = + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + +[testenv:debug] +commands = oslo_debug_helper {posargs} + +[flake8] +# E123, E125 skipped as they are invalid PEP-8. + +show-source = True +ignore = E123,E125 +builtins = _ +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build diff --git a/zuul.yaml b/zuul.yaml new file mode 100644 index 0000000..901268e --- /dev/null +++ b/zuul.yaml @@ -0,0 +1,19 @@ +- project: + merge-mode: squash-merge + default-branch: master + templates: + - publish-to-pypi + - publish-otc-docs-hc-pti + - release-notes-jobs + check: + jobs: + - otc-tox-pep8 + - otc-tox-py38 + - otc-tox-py39 + - tox-functional + gate: + jobs: + - otc-tox-pep8 + - otc-tox-py38 + - otc-tox-py39 + - tox-functional