From 6779395a19e7e8495def3a86d5f9a1bf38d4a9b6 Mon Sep 17 00:00:00 2001 From: tischrei Date: Wed, 8 Mar 2023 11:47:21 +0000 Subject: [PATCH 01/17] pfs_folder_fix Reviewed-by: Gode, Sebastian Co-authored-by: tischrei Co-committed-by: tischrei --- otc_metadata/data/services.yaml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 824e0aa2..7f0bd385 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -670,20 +670,21 @@ documents: title: Tool Guide (OBS Browser) type: tool-guide - hc_location: pfs/obs - html_location: docs/obs/pfs + html_location: docs/obs/parallel-file-system link: /object-storage-service/parallel-file-system/ pdf_name: obs-pfs - rst_location: doc/pfs/source + rst_location: doc/parallel-file-system/source service_type: obs title: Parallel File System (PFS) - type: pfs - - html_location: docs/obs/perms-cfg + type: parallel-file-system + - environment: internal + html_location: docs/obs/permissions-configuration-guide link: /object-storage-service/permissions-configuration-guide/ pdf_name: obs-perms-cfg - rst_location: doc/perms-cfg/source + rst_location: doc/permissions-configuration-guide/source service_type: obs title: Permissions Configuration Guide - type: perms-cfg + type: permissions-configuration-guide - hc_location: api_swift/obs html_location: docs/obs/api-swift link: /object-storage-service/swiftapi/ From 28baf2213e17da80a0483270569a22648875b585 Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Fri, 10 Mar 2023 11:39:44 +0000 Subject: [PATCH 02/17] Update 'tools-requirements.txt' Reviewed-by: gtema Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- tools-requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/tools-requirements.txt b/tools-requirements.txt index 382a4a03..5fee53b0 100644 --- a/tools-requirements.txt +++ b/tools-requirements.txt @@ -3,3 +3,4 @@ ruamel.yaml requests jinja2 dirsync +cookiecutter From ccfbd0c23575c0c16f5e21eb2b9d9d3812a06b74 Mon Sep 17 00:00:00 2001 From: tischrei Date: Fri, 10 Mar 2023 12:43:56 +0000 Subject: [PATCH 03/17] dli_repo Reviewed-by: Gode, Sebastian Co-authored-by: tischrei Co-committed-by: tischrei --- otc_metadata/data/services.yaml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 7f0bd385..e573dad6 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -293,6 +293,24 @@ documents: service_type: dis title: User Guide type: umn + - environment: internal + hc_location: api/dli + html_location: docs/dli/api-ref + link: /data-lake-insight/api-ref/ + pdf_name: dli-api-ref + rst_location: api-ref/source + service_type: dli + title: API Reference + type: api-ref + - environment: internal + hc_location: usermanual/dli + html_location: docs/dli/umn + link: /data-lake-insight/umn/ + pdf_name: dli-umn + rst_location: umn/source + service_type: dli + title: User Guide + type: umn - hc_location: api/dms html_location: docs/dms/api-ref link: /distributed-message-service/api-ref/ @@ -1251,6 +1269,19 @@ services: teams: - name: docs-network-rw permission: write + - repositories: + - environment: internal + repo: docs/data-lake-insight + type: gitea + - environment: public + repo: docs/data-lake-insight + type: github + service_category: big_data + service_title: Data Lake Insight + service_type: dli + teams: + - name: docs-bigdata-ai-rw + permission: write - repositories: - environment: internal repo: docs/data-replication-service From b52b0bb5e0f844d525690cf1a0e79e9fdbcbaf07 Mon Sep 17 00:00:00 2001 From: tischrei Date: Mon, 13 Mar 2023 14:42:24 +0000 Subject: [PATCH 04/17] Change html_link for PFS and Perms Guide Reviewed-by: Hasko, Vladimir Co-authored-by: tischrei Co-committed-by: tischrei --- otc_metadata/data/services.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index e573dad6..1f6a52b8 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -688,7 +688,7 @@ documents: title: Tool Guide (OBS Browser) type: tool-guide - hc_location: pfs/obs - html_location: docs/obs/parallel-file-system + html_location: docs/obs/pfs link: /object-storage-service/parallel-file-system/ pdf_name: obs-pfs rst_location: doc/parallel-file-system/source @@ -696,7 +696,7 @@ documents: title: Parallel File System (PFS) type: parallel-file-system - environment: internal - html_location: docs/obs/permissions-configuration-guide + html_location: docs/obs/perms-cfg link: /object-storage-service/permissions-configuration-guide/ pdf_name: obs-perms-cfg rst_location: doc/permissions-configuration-guide/source From a7a4f676e09fe0fee306a3f7c2291548d84815cf Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Sun, 26 Mar 2023 17:31:00 +0000 Subject: [PATCH 05/17] adding new dbss service metadata Reviewed-by: tischrei Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 1f6a52b8..e194f954 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -198,6 +198,20 @@ documents: service_type: cts title: User Guide type: umn + - html_location: docs/dbss/api-ref + link: /database-security-service/api-ref/ + pdf_name: dbss-api-ref + rst_location: api-ref/source + service_type: dbss + title: API Reference + type: api-ref + - html_location: docs/dbss/umn + link: /database-security-service/umn/ + pdf_name: dbss-umn + rst_location: umn/source + service_type: dbss + title: User Guide + type: umn - hc_location: api/dc html_location: docs/dc/api-ref link: /direct-connect/api-ref/ @@ -1165,6 +1179,19 @@ services: teams: - name: docs-orchestration-rw permission: write + - repositories: + - environment: internal + repo: docs/database-security-service + type: gitea + - environment: public + repo: opentelekomcloud-docs/database-security-service + type: github + service_category: security-services + service_title: Database Security Service + service_type: dbss + teams: + - name: docs-security-services-rw + permission: write - repositories: - environment: internal repo: docs/direct-connect From 4989570371e476763a0ce8d65ae3cfe8a49f6448 Mon Sep 17 00:00:00 2001 From: gtema Date: Sun, 26 Mar 2023 17:51:23 +0000 Subject: [PATCH 06/17] Add some basic unittests for metadata sanity Reviewed-by: Hasko, Vladimir Co-authored-by: gtema Co-committed-by: gtema --- otc_metadata/data/services.yaml | 18 +++++++++++ otc_metadata/tests/test_otc_metadata.py | 41 +++++++++++++++++++++++-- tox.ini | 1 - zuul.yaml | 3 +- 4 files changed, 59 insertions(+), 4 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index e194f954..62f0584c 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -1,3 +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. + +# Please consult with otc_metadata.services.Services:_sort_data for expected +# sort order. When unsure perform tools/sort_metadata.py for getting it sorted. +--- documents: - hc_location: api/antiddos html_location: docs/antiddos/api-ref @@ -1035,6 +1051,8 @@ service_categories: title: Security Services - name: storage title: Storage + - name: other + title: Other services: - repositories: - environment: internal diff --git a/otc_metadata/tests/test_otc_metadata.py b/otc_metadata/tests/test_otc_metadata.py index eb22b699..609199f0 100644 --- a/otc_metadata/tests/test_otc_metadata.py +++ b/otc_metadata/tests/test_otc_metadata.py @@ -21,8 +21,45 @@ Tests for `otc-metadata` module. from unittest import TestCase +from otc_metadata import services + class TestOtcMetadata(TestCase): + def setUp(self): + self.data = services.Services() - def test_something(self): - pass + def test_data_is_sorted(self): + curr = self.data + new = services.Services() + new._sort_data() + self.assertEqual( + curr._service_data, new._service_data, "Data is sorted properly" + ) + + def test_service_categories(self): + category = dict() + for cat in self.data._service_data["service_categories"]: + category[cat["name"]] = cat["title"] + for srv in self.data.all_services: + self.assertTrue( + srv["service_category"] in category, + f"Category {srv['service_category']} is present", + ) + + def test_doc_contains_required_data(self): + srv_types = dict() + for srv in self.data.all_services: + srv_types[srv["service_type"]] = srv + for doc in self.data.all_docs: + for attr in [ + "rst_location", + "service_type", + "title", + "type", + ]: + self.assertIn(attr, doc, f"Document {doc} contains {attr}") + self.assertIn( + doc["service_type"], + srv_types, + f"Document {doc} contains valid service_type", + ) diff --git a/tox.ini b/tox.ini index 8a1f4d2d..3b5961d1 100644 --- a/tox.ini +++ b/tox.ini @@ -19,7 +19,6 @@ commands = {posargs} [flake8] # E123, E125 skipped as they are invalid PEP-8. - show-source = True ignore = E123,E125,W503 builtins = _ diff --git a/zuul.yaml b/zuul.yaml index 809de6cc..3a1ad475 100644 --- a/zuul.yaml +++ b/zuul.yaml @@ -1,3 +1,4 @@ +--- - project: merge-mode: squash-merge default-branch: main @@ -8,4 +9,4 @@ gate: jobs: - otc-tox-pep8 - - otc-tox-py39 \ No newline at end of file + - otc-tox-py39 From 30851dd5df20676a53e3679a2123f262448065cd Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Sun, 26 Mar 2023 18:01:24 +0000 Subject: [PATCH 07/17] Enterprise router addon Reviewed-by: vladimirhasko Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 62f0584c..9e47e78e 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -492,6 +492,20 @@ documents: service_type: elb title: User Guide type: umn + - html_location: docs/er/api-ref + link: /enterprise-router/api-ref/ + pdf_name: er-api-ref + rst_location: api-ref/source + service_type: er + title: API Reference + type: api-ref + - html_location: docs/er/umn + link: /enterprise-router/umn/ + pdf_name: er-umn + rst_location: umn/source + service_type: er + title: User Guide + type: umn - hc_location: api/evs html_location: docs/evs/api-ref link: /elastic-volume-service/api-ref/ @@ -1412,6 +1426,19 @@ services: teams: - name: docs-network-rw permission: write + - repositories: + - environment: internal + repo: docs/enterprise-router + type: gitea + - environment: public + repo: opentelekomcloud-docs/enterprise-router + type: github + service_category: network + service_title: Enterprise Router + service_type: er + teams: + - name: docs-network-rw + permission: write - repositories: - environment: internal repo: docs/elastic-volume-service From 82d841953ad39c337cf0120f4a0d3189b84d4231 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Tue, 28 Mar 2023 07:37:51 +0000 Subject: [PATCH 08/17] Setting the visibility on new services to be only visible on PREPROD Reviewed-by: tischrei Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 9e47e78e..1597afea 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -214,14 +214,16 @@ documents: service_type: cts title: User Guide type: umn - - html_location: docs/dbss/api-ref + - environment: internal + html_location: docs/dbss/api-ref link: /database-security-service/api-ref/ pdf_name: dbss-api-ref rst_location: api-ref/source service_type: dbss title: API Reference type: api-ref - - html_location: docs/dbss/umn + - environment: internal + html_location: docs/dbss/umn link: /database-security-service/umn/ pdf_name: dbss-umn rst_location: umn/source @@ -492,14 +494,16 @@ documents: service_type: elb title: User Guide type: umn - - html_location: docs/er/api-ref + - environment: internal + html_location: docs/er/api-ref link: /enterprise-router/api-ref/ pdf_name: er-api-ref rst_location: api-ref/source service_type: er title: API Reference type: api-ref - - html_location: docs/er/umn + - environment: internal + html_location: docs/er/umn link: /enterprise-router/umn/ pdf_name: er-umn rst_location: umn/source From 88fd397d6a65a4ee05219ebbb5ea94b168e30fea Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Wed, 12 Apr 2023 12:07:35 +0000 Subject: [PATCH 09/17] adding DataArts Studio and API Gateway document metadata Reviewed-by: tischrei Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 58 +++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 1597afea..b224fec5 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -47,6 +47,22 @@ documents: service_type: aom title: User Guide type: umn + - environment: internal + html_location: docs/apig/api-ref + link: /api-gateway/api-ref/ + pdf_name: apig-api-ref + rst_location: api-ref/source + service_type: apig + title: API Reference + type: api-ref + - environment: internal + html_location: docs/apig/umn + link: /api-gateway/umn/ + pdf_name: apig-umn + rst_location: umn/source + service_type: apig + title: User Guide + type: umn - hc_location: api/as html_location: docs/as/api-ref link: /auto-scaling/api-ref/ @@ -214,6 +230,22 @@ documents: service_type: cts title: User Guide type: umn + - environment: internal + html_location: docs/dataartsstudio/api-ref + link: /dataarts-studio/api-ref/ + pdf_name: dataarts_studio-api-ref + rst_location: api-ref/source + service_type: dataarts_studio + title: API Reference + type: api-ref + - environment: internal + html_location: docs/dataartsstudio/umn + link: /dataarts-studio/umn/ + pdf_name: dataarts_studio-umn + rst_location: umn/source + service_type: dataarts_studio + title: User Guide + type: umn - environment: internal html_location: docs/dbss/api-ref link: /database-security-service/api-ref/ @@ -1098,6 +1130,19 @@ services: teams: - name: docs-orchestration-rw permission: write + - repositories: + - environment: internal + repo: docs/api-gateway + type: gitea + - environment: public + repo: opentelekomcloud-docs/api-gateway + type: github + service_category: application + service_title: API Gateway (APIG) + service_type: apig + teams: + - name: docs-bigdata-ai-rw + permission: write - repositories: - environment: internal repo: docs/auto-scaling @@ -1215,6 +1260,19 @@ services: teams: - name: docs-orchestration-rw permission: write + - repositories: + - environment: internal + repo: docs/dataarts-studio + type: gitea + - environment: public + repo: opentelekomcloud-docs/dataarts-studio + type: github + service_category: security-services + service_title: DataArts Studio + service_type: dataarts_studio + teams: + - name: docs-bigdata-ai-rw + permission: write - repositories: - environment: internal repo: docs/database-security-service From e7c64b24ee6f63be7b61a9d7facf6163fc2ba783 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Wed, 12 Apr 2023 13:49:48 +0000 Subject: [PATCH 10/17] fixing the dataarts repo name Reviewed-by: Gode, Sebastian Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index b224fec5..237e2b1e 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -1262,10 +1262,10 @@ services: permission: write - repositories: - environment: internal - repo: docs/dataarts-studio + repo: docs/data-arts-studio type: gitea - environment: public - repo: opentelekomcloud-docs/dataarts-studio + repo: opentelekomcloud-docs/data-arts-studio type: github service_category: security-services service_title: DataArts Studio From 800add1b2d5cfb89c0932bad5fd9b683fedb68e9 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Thu, 13 Apr 2023 07:36:08 +0000 Subject: [PATCH 11/17] fixing wrong category for new services Reviewed-by: gtema Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 237e2b1e..b863d890 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -1137,7 +1137,7 @@ services: - environment: public repo: opentelekomcloud-docs/api-gateway type: github - service_category: application + service_category: big_data service_title: API Gateway (APIG) service_type: apig teams: @@ -1267,7 +1267,7 @@ services: - environment: public repo: opentelekomcloud-docs/data-arts-studio type: github - service_category: security-services + service_category: big_data service_title: DataArts Studio service_type: dataarts_studio teams: From 6c27e42e4b806622d186a9a9a9d87f056fab8800 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Wed, 19 Apr 2023 15:30:22 +0000 Subject: [PATCH 12/17] enablign OBS permission guide on prod Reviewed-by: vladimirhasko Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index b863d890..06dc4795 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -775,8 +775,7 @@ documents: service_type: obs title: Parallel File System (PFS) type: parallel-file-system - - environment: internal - html_location: docs/obs/perms-cfg + - html_location: docs/obs/perms-cfg link: /object-storage-service/permissions-configuration-guide/ pdf_name: obs-perms-cfg rst_location: doc/permissions-configuration-guide/source From b711305a4c06395e4ed5c1045be4c1f71ba5e9e0 Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Thu, 20 Apr 2023 13:10:18 +0000 Subject: [PATCH 13/17] New template and options for Service-Based-View Reviewed-by: Hasko, Vladimir Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- otc_metadata/templates/conf.py.j2 | 5 +- .../templates/doc_requirements.txt.j2 | 3 + otc_metadata/templates/index_sbv.rst.j2 | 7 ++ otc_metadata/templates/tox.ini.j2 | 8 ++ tools/generate_doc_confpy.py | 73 +++++++++++++++++++ 5 files changed, 95 insertions(+), 1 deletion(-) create mode 100644 otc_metadata/templates/index_sbv.rst.j2 diff --git a/otc_metadata/templates/conf.py.j2 b/otc_metadata/templates/conf.py.j2 index 859d3b87..3228eec8 100644 --- a/otc_metadata/templates/conf.py.j2 +++ b/otc_metadata/templates/conf.py.j2 @@ -18,7 +18,10 @@ import os import sys extensions = [ - 'otcdocstheme' + 'otcdocstheme', +{%- if otc_sbv %} + 'otc_sphinx_directives' +{%- endif %} ] otcdocs_auto_name = False diff --git a/otc_metadata/templates/doc_requirements.txt.j2 b/otc_metadata/templates/doc_requirements.txt.j2 index a61c7060..ea0c4dee 100644 --- a/otc_metadata/templates/doc_requirements.txt.j2 +++ b/otc_metadata/templates/doc_requirements.txt.j2 @@ -2,3 +2,6 @@ sphinx>=2.0.0,!=2.1.0 # BSD otcdocstheme # Apache-2.0 # releasenotes reno>=3.1.0 # Apache-2.0 + +otc-sphinx-directives>=0.1.0 +git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata \ No newline at end of file diff --git a/otc_metadata/templates/index_sbv.rst.j2 b/otc_metadata/templates/index_sbv.rst.j2 new file mode 100644 index 00000000..1ef5b688 --- /dev/null +++ b/otc_metadata/templates/index_sbv.rst.j2 @@ -0,0 +1,7 @@ +{{ sbv_title }} + +.. directive_wrapper:: + :class: container-sbv + + .. service_card:: + :service_type: {{ service_type }} diff --git a/otc_metadata/templates/tox.ini.j2 b/otc_metadata/templates/tox.ini.j2 index f8316308..e6ecf9d4 100644 --- a/otc_metadata/templates/tox.ini.j2 +++ b/otc_metadata/templates/tox.ini.j2 @@ -29,7 +29,11 @@ allowlist_externals = mkdir cp sh + rm + sphinx-build commands = + rm -rf doc/build/html doc/build/doctrees + sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html {%- for doc in docs %} {[testenv:{{ doc.type }}]commands} {[testenv:json-{{ doc.type }}]commands} @@ -115,3 +119,7 @@ commands = cp {{ loc }}/build/pdf/{{ doc.pdf_name }}.pdf doc/build/pdf/ {% endif %} {% endfor %} + +[doc8] +ignore = D001 +extensions = .rst, .yaml \ No newline at end of file diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index 58f657a1..31870e3b 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -50,6 +50,7 @@ def process_repositories(args, service): ) conf_py_template = env.get_template("conf.py.j2") tox_ini_template = env.get_template("tox.ini.j2") + index_sbv_template = env.get_template("index_sbv.rst.j2") doc_requirements_template = env.get_template("doc_requirements.txt.j2") for repo in service["repositories"]: @@ -155,7 +156,62 @@ def process_repositories(args, service): out.write(conf_py_content) repo_to.index.add([doc["rst_location"]]) + + if args.update_sbv: + """Add or update service-based-view""" + copy_path = pathlib.Path(copy_to, 'doc', 'source') + context = dict( + repo_name=target_repo["repo"], + project=service["service_title"], + # pdf_name=doc["pdf_name"], + title=f"{service['service_title']} - Service Based View", + service_type=service["service_type"] + ) + if not copy_path.exists(): + logging.info("Path for sbv does not exist") + copy_path.mkdir(parents=True, exist_ok=True) + context["otc_sbv"] = True + if git_fqdn: + context["git_fqdn"] = git_fqdn + if target_repo.get("type") != "github": + context["git_type"] = target_repo["type"] + if args.target_environment == "internal": + context["html_options"] = dict( + disable_search=True, + site_name="Internal Documentation Portal", + logo_url="https://docs-int.otc-service.com", + ) + sbv_title = (service["service_title"] + "\n" + + ('=' * len(service["service_title"]))) + context["sbv_title"] = sbv_title + conf_py_content = conf_py_template.render(**context) + index_sbv_content = index_sbv_template.render(**context) + with open( + pathlib.Path(copy_path, "conf.py"), + "w", + encoding="utf-8") as out: + out.write(conf_py_content) + repo_to.index.add(pathlib.Path(copy_path, "conf.py")) + + if (not args.overwrite_index_sbv + and pathlib.Path(copy_path, "index.rst").exists()): + logging.info("File index.rst for sbv exists. Skipping") + else: + with open( + pathlib.Path(copy_path, "index.rst"), + "w", + encoding="utf-8") as out: + out.write(index_sbv_content) + repo_to.index.add(pathlib.Path(copy_path, "index.rst")) + + placeholder_path = pathlib.Path(copy_path, "_static") + if not pathlib.Path(placeholder_path, "placeholder").exists(): + placeholder_path.mkdir(parents=True, exist_ok=True) + open(pathlib.Path(placeholder_path, "placeholder"), 'a').close() + repo_to.index.add(pathlib.Path(placeholder_path, "placeholder")) + if args.update_tox: + """Update tox.ini""" context = dict(docs=[]) for doc in service_docs: if doc["type"] == "dev": @@ -265,10 +321,27 @@ def main(): ) parser.add_argument("--token", metavar="token", help="API token") parser.add_argument("--api-url", help="API base url of the Git hoster") + parser.add_argument( + "--update-sbv", + action="store_true", + help="Whether to update service-based-view" + ) + parser.add_argument( + "--overwrite-index-sbv", + action="store_true", + help=("Whether to overwrite index.rst for service-based-view." + + "\nCan only be used if --update-sbv is also specified") + ) args = parser.parse_args() logging.basicConfig(level=logging.DEBUG) services = [] + if args.overwrite_index_sbv and not args.update_sbv: + logging.error( + "Cannot overwrite index.rst for service-based-view" + + " without updating service-based-view" + ) + exit(1) if args.service_type: services = [data.service_dict.get(args.service_type)] else: From 58f1b9f492e78bbc0ebfc1b1b5563859edc8b684 Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Wed, 3 May 2023 06:52:24 +0000 Subject: [PATCH 14/17] Added option to specify a custom commit-description Reviewed-by: tischrei Reviewed-by: Hasko, Vladimir Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- tools/generate_doc_confpy.py | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index 31870e3b..728e8686 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -245,11 +245,7 @@ def process_repositories(args, service): ) return repo_to.index.commit( - ( - "Update tox.ini && conf.py file\n\n" - "Performed-by: gitea/infra/otc-metadata/" - "tools/generate_doc_confpy.py" - ) + args.commit_description ) push_args = ["--set-upstream", "origin", branch_name] if args.branch_force: @@ -332,6 +328,15 @@ def main(): help=("Whether to overwrite index.rst for service-based-view." + "\nCan only be used if --update-sbv is also specified") ) + parser.add_argument( + "--commit-description", + default=( + "Update tox.ini && conf.py file\n\n" + "Performed-by: gitea/infra/otc-metadata/" + "tools/generate_doc_confpy.py" + ), + help="Commit description for the commit", + ) args = parser.parse_args() logging.basicConfig(level=logging.DEBUG) From 0ea50e19f3f5c0387a8ed2390c8f02399e71ab63 Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Wed, 3 May 2023 06:52:27 +0000 Subject: [PATCH 15/17] Added service_uri for service-based-view Reviewed-by: Hasko, Vladimir Reviewed-by: tischrei Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- otc_metadata/data/services.yaml | 59 +++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 06dc4795..41af20fa 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -1113,6 +1113,7 @@ services: service_category: security-services service_title: Anti DDoS service_type: antiddos + service_uri: anti-ddos teams: - name: docs-security-services-rw permission: write @@ -1126,6 +1127,7 @@ services: service_category: application service_title: Application Operations Management service_type: aom + service_uri: application-operations-management teams: - name: docs-orchestration-rw permission: write @@ -1139,6 +1141,7 @@ services: service_category: big_data service_title: API Gateway (APIG) service_type: apig + service_uri: api-gateway teams: - name: docs-bigdata-ai-rw permission: write @@ -1152,6 +1155,7 @@ services: service_category: compute service_title: Auto Scaling service_type: as + service_uri: auto-scaling teams: - name: docs-compute-rw permission: write @@ -1165,6 +1169,7 @@ services: service_category: compute service_title: Bare Metal Server service_type: bms + service_uri: bare-metal-server teams: - name: docs-compute-rw permission: write @@ -1178,6 +1183,7 @@ services: service_category: storage service_title: Cloud Backup and Recovery service_type: cbr + service_uri: cloud-backup-recovery teams: - name: docs-storage-rw permission: write @@ -1191,6 +1197,7 @@ services: service_category: container service_title: Cloud Container Engine service_type: cce + service_uri: cloud-container-engine teams: - name: docs-container-rw permission: write @@ -1204,6 +1211,7 @@ services: service_category: container service_title: Cloud Container Instance service_type: cci + service_uri: cloud-container-instance teams: - name: docs-container-rw permission: write @@ -1217,6 +1225,7 @@ services: service_category: md service_title: Cloud Eye service_type: ces + service_uri: cloud-eye teams: - name: docs-orchestration-rw permission: write @@ -1230,6 +1239,7 @@ services: service_category: storage service_title: Cloud Server Backup Service service_type: csbs + service_uri: cloud-server-backup-service teams: - name: docs-storage-rw permission: write @@ -1243,6 +1253,7 @@ services: service_category: big_data service_title: Cloud Search Service service_type: css + service_uri: cloud-search-service teams: - name: docs-bigdata-ai-rw permission: write @@ -1256,6 +1267,7 @@ services: service_category: md service_title: Cloud Trace Service service_type: cts + service_uri: cloud-trace-service teams: - name: docs-orchestration-rw permission: write @@ -1269,6 +1281,7 @@ services: service_category: big_data service_title: DataArts Studio service_type: dataarts_studio + service_uri: dataarts-studio teams: - name: docs-bigdata-ai-rw permission: write @@ -1282,6 +1295,7 @@ services: service_category: security-services service_title: Database Security Service service_type: dbss + service_uri: database-security-service teams: - name: docs-security-services-rw permission: write @@ -1295,6 +1309,7 @@ services: service_category: network service_title: Direct Connect service_type: dc + service_uri: direct-connect teams: - name: docs-network-rw permission: write @@ -1308,6 +1323,7 @@ services: service_category: database service_title: Distributed Cache Service service_type: dcs + service_uri: distributed-cache-service teams: - name: docs-database-rw permission: write @@ -1321,6 +1337,7 @@ services: service_category: database service_title: Distributed Database Middleware service_type: ddm + service_uri: distributed-database-middleware teams: - name: docs-database-rw permission: write @@ -1334,6 +1351,7 @@ services: service_category: database service_title: Document Database Service service_type: dds + service_uri: document-database-service teams: - name: docs-database-rw permission: write @@ -1347,6 +1365,7 @@ services: service_category: compute service_title: Dedicated Host service_type: deh + service_uri: dedicated-host teams: - name: docs-compute-rw permission: write @@ -1360,6 +1379,7 @@ services: service_category: big_data service_title: Data Ingestion Service service_type: dis + service_uri: data-ingestion-service teams: - name: docs-bigdata-ai-rw permission: write @@ -1373,6 +1393,7 @@ services: service_category: application service_title: Distributed Message Service service_type: dms + service_uri: distributed-message-service teams: - name: docs-orchestration-rw permission: write @@ -1386,6 +1407,7 @@ services: service_category: network service_title: Domain Name Service service_type: dns + service_uri: domain-name-service teams: - name: docs-network-rw permission: write @@ -1399,6 +1421,7 @@ services: service_category: big_data service_title: Data Lake Insight service_type: dli + service_uri: data-lake-insight teams: - name: docs-bigdata-ai-rw permission: write @@ -1412,6 +1435,7 @@ services: service_category: database service_title: Data Replication Service service_type: drs + service_uri: data-replication-service teams: - name: docs-database-rw permission: write @@ -1425,6 +1449,7 @@ services: service_category: big_data service_title: Data Warehouse Service service_type: dws + service_uri: data-warehouse-service teams: - name: docs-bigdata-ai-rw permission: write @@ -1445,6 +1470,7 @@ services: service_category: compute service_title: Elastic Cloud Server service_type: ecs + service_uri: elastic-cloud-server teams: - name: docs-compute-rw permission: write @@ -1458,6 +1484,7 @@ services: service_category: other service_title: Enterprise Dashboard service_type: ed + service_uri: enterprise-dashboard teams: - name: docs-dashboard-rw permission: write @@ -1471,6 +1498,7 @@ services: service_category: network service_title: Elastic IP service_type: eip + service_uri: elastic-ip teams: - name: docs-network-rw permission: write @@ -1484,6 +1512,7 @@ services: service_category: network service_title: Elastic Load Balancing service_type: elb + service_uri: elastic-load-balancing teams: - name: docs-network-rw permission: write @@ -1497,6 +1526,7 @@ services: service_category: network service_title: Enterprise Router service_type: er + service_uri: enterprise-router teams: - name: docs-network-rw permission: write @@ -1510,6 +1540,7 @@ services: service_category: storage service_title: Elastic Volume Service service_type: evs + service_uri: elastic-volume-service teams: - name: docs-storage-rw permission: write @@ -1523,6 +1554,7 @@ services: service_category: database service_title: GaussDB (for MySQL) service_type: gaussdb_mysql + service_uri: gaussdb-mysql teams: - name: docs-database-rw permission: write @@ -1536,6 +1568,7 @@ services: service_category: database service_title: GaussDB NoSQL service_type: gaussdb_nosql + service_uri: gaussdb-nosql teams: - name: docs-database-rw permission: write @@ -1549,6 +1582,7 @@ services: service_category: security-services service_title: Identity and Access Management service_type: iam + service_uri: identity-access-management teams: - name: docs-security-services-rw permission: write @@ -1562,6 +1596,7 @@ services: service_category: compute service_title: Image Management Service service_type: ims + service_uri: image-management-service teams: - name: docs-compute-rw permission: write @@ -1575,6 +1610,7 @@ services: service_category: security-services service_title: Key Management Service service_type: kms + service_uri: key-management-service teams: - name: docs-security-services-rw permission: write @@ -1588,6 +1624,7 @@ services: service_category: md service_title: Log Tank Service service_type: lts + service_uri: log-tank-service teams: - name: docs-orchestration-rw permission: write @@ -1601,6 +1638,7 @@ services: service_category: big_data service_title: ModelArts service_type: ma + service_uri: modelarts teams: - name: docs-bigdata-ai-rw permission: write @@ -1614,6 +1652,7 @@ services: service_category: big_data service_title: MapReduce Service service_type: mrs + service_uri: mapreduce-service teams: - name: docs-bigdata-ai-rw permission: write @@ -1627,6 +1666,7 @@ services: service_category: network service_title: NAT Gateway service_type: natgw + service_uri: nat-gateway teams: - name: docs-network-rw permission: write @@ -1640,6 +1680,7 @@ services: service_category: storage service_title: Object Storage Service service_type: obs + service_uri: object-storage-service teams: - name: docs-storage-rw permission: write @@ -1653,6 +1694,7 @@ services: service_category: database service_title: GaussDB (openGauss) service_type: opengauss + service_uri: gaussdb-opengauss teams: - name: docs-database-rw permission: write @@ -1666,6 +1708,7 @@ services: service_category: network service_title: Private Link Access Service service_type: plas + service_uri: private-link-access-service teams: - name: docs-network-rw permission: write @@ -1679,6 +1722,7 @@ services: service_category: database service_title: Relational Database Service service_type: rds + service_uri: relational-database-service teams: - name: docs-database-rw permission: write @@ -1692,6 +1736,7 @@ services: service_category: md service_title: Resource Management Service service_type: rms + service_uri: resource-management-service teams: - name: docs-orchestration-rw permission: write @@ -1705,6 +1750,7 @@ services: service_category: md service_title: Resource Template Service service_type: rts + service_uri: resource-template-service teams: - name: docs-orchestration-rw permission: write @@ -1718,6 +1764,7 @@ services: service_category: other service_title: Status Dashboard service_type: sd + service_uri: status-dashboard teams: - name: docs-eco-rw permission: write @@ -1731,6 +1778,7 @@ services: service_category: storage service_title: Storage Disaster Recovery Service service_type: sdrs + service_uri: storage-disaster-recovery-service teams: - name: docs-storage-rw permission: write @@ -1744,6 +1792,7 @@ services: service_category: storage service_title: Scalable File System service_type: sfs + service_uri: scalable-file-service teams: - name: docs-storage-rw permission: write @@ -1757,6 +1806,7 @@ services: service_category: application service_title: Simple Message Notification service_type: smn + service_uri: simple-message-notification teams: - name: docs-orchestration-rw permission: write @@ -1770,6 +1820,7 @@ services: service_category: network service_title: Secure Mail Gateway service_type: smg + service_uri: secure-mail-gateway teams: - name: docs-network-rw permission: write @@ -1783,6 +1834,7 @@ services: service_category: container service_title: Software Repository for Containers service_type: swr + service_uri: software-repository-container teams: - name: docs-container-rw permission: write @@ -1796,6 +1848,7 @@ services: service_category: md service_title: Tag Management Service service_type: tms + service_uri: tag-management-service teams: - name: docs-orchestration-rw permission: write @@ -1809,6 +1862,7 @@ services: service_category: storage service_title: Volume Backup Service service_type: vbs + service_uri: volume-backup-service teams: - name: docs-storage-rw permission: write @@ -1822,6 +1876,7 @@ services: service_category: network service_title: Virtual Private Cloud service_type: vpc + service_uri: virtual-private-cloud teams: - name: docs-network-rw permission: write @@ -1835,6 +1890,7 @@ services: service_category: network service_title: VPC Endpoint service_type: vpcep + service_uri: vpc-endpoint teams: - name: docs-network-rw permission: write @@ -1848,6 +1904,7 @@ services: service_category: network service_title: Virtual Private Network service_type: vpn + service_uri: virtual-private-network teams: - name: docs-network-rw permission: write @@ -1861,6 +1918,7 @@ services: service_category: security-services service_title: Web Application Firewall service_type: waf + service_uri: web-application-firewall teams: - name: docs-security-services-rw permission: write @@ -1874,6 +1932,7 @@ services: service_category: security-services service_title: Dedicated Web Application Firewall service_type: wafd + service_uri: web-application-firewall-dedicated teams: - name: docs-security-services-rw permission: write From b4d5457009f760a103691922d08b507e96991b3b Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Fri, 5 May 2023 09:08:02 +0000 Subject: [PATCH 16/17] Updated links to reflect current sbv status Reviewed-by: Hasko, Vladimir Reviewed-by: tischrei Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- otc_metadata/data/services.yaml | 116 ++++++++++++++++---------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 41af20fa..8b93dacc 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -1113,7 +1113,7 @@ services: service_category: security-services service_title: Anti DDoS service_type: antiddos - service_uri: anti-ddos + service_uri: anti-ddos/umn teams: - name: docs-security-services-rw permission: write @@ -1127,7 +1127,7 @@ services: service_category: application service_title: Application Operations Management service_type: aom - service_uri: application-operations-management + service_uri: application-operations-management/umn teams: - name: docs-orchestration-rw permission: write @@ -1141,7 +1141,7 @@ services: service_category: big_data service_title: API Gateway (APIG) service_type: apig - service_uri: api-gateway + service_uri: api-gateway/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1155,7 +1155,7 @@ services: service_category: compute service_title: Auto Scaling service_type: as - service_uri: auto-scaling + service_uri: auto-scaling/umn teams: - name: docs-compute-rw permission: write @@ -1169,7 +1169,7 @@ services: service_category: compute service_title: Bare Metal Server service_type: bms - service_uri: bare-metal-server + service_uri: bare-metal-server/umn teams: - name: docs-compute-rw permission: write @@ -1183,7 +1183,7 @@ services: service_category: storage service_title: Cloud Backup and Recovery service_type: cbr - service_uri: cloud-backup-recovery + service_uri: cloud-backup-recovery/umn teams: - name: docs-storage-rw permission: write @@ -1197,7 +1197,7 @@ services: service_category: container service_title: Cloud Container Engine service_type: cce - service_uri: cloud-container-engine + service_uri: cloud-container-engine/umn teams: - name: docs-container-rw permission: write @@ -1211,7 +1211,7 @@ services: service_category: container service_title: Cloud Container Instance service_type: cci - service_uri: cloud-container-instance + service_uri: cloud-container-instance/umn teams: - name: docs-container-rw permission: write @@ -1225,7 +1225,7 @@ services: service_category: md service_title: Cloud Eye service_type: ces - service_uri: cloud-eye + service_uri: cloud-eye/umn teams: - name: docs-orchestration-rw permission: write @@ -1239,7 +1239,7 @@ services: service_category: storage service_title: Cloud Server Backup Service service_type: csbs - service_uri: cloud-server-backup-service + service_uri: cloud-server-backup-service/umn teams: - name: docs-storage-rw permission: write @@ -1253,7 +1253,7 @@ services: service_category: big_data service_title: Cloud Search Service service_type: css - service_uri: cloud-search-service + service_uri: cloud-search-service/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1267,7 +1267,7 @@ services: service_category: md service_title: Cloud Trace Service service_type: cts - service_uri: cloud-trace-service + service_uri: cloud-trace-service/umn teams: - name: docs-orchestration-rw permission: write @@ -1281,7 +1281,7 @@ services: service_category: big_data service_title: DataArts Studio service_type: dataarts_studio - service_uri: dataarts-studio + service_uri: dataarts-studio/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1295,7 +1295,7 @@ services: service_category: security-services service_title: Database Security Service service_type: dbss - service_uri: database-security-service + service_uri: database-security-service/umn teams: - name: docs-security-services-rw permission: write @@ -1309,7 +1309,7 @@ services: service_category: network service_title: Direct Connect service_type: dc - service_uri: direct-connect + service_uri: direct-connect/umn teams: - name: docs-network-rw permission: write @@ -1323,7 +1323,7 @@ services: service_category: database service_title: Distributed Cache Service service_type: dcs - service_uri: distributed-cache-service + service_uri: distributed-cache-service/umn teams: - name: docs-database-rw permission: write @@ -1337,7 +1337,7 @@ services: service_category: database service_title: Distributed Database Middleware service_type: ddm - service_uri: distributed-database-middleware + service_uri: distributed-database-middleware/umn teams: - name: docs-database-rw permission: write @@ -1351,7 +1351,7 @@ services: service_category: database service_title: Document Database Service service_type: dds - service_uri: document-database-service + service_uri: document-database-service/umn teams: - name: docs-database-rw permission: write @@ -1365,7 +1365,7 @@ services: service_category: compute service_title: Dedicated Host service_type: deh - service_uri: dedicated-host + service_uri: dedicated-host/umn teams: - name: docs-compute-rw permission: write @@ -1379,7 +1379,7 @@ services: service_category: big_data service_title: Data Ingestion Service service_type: dis - service_uri: data-ingestion-service + service_uri: data-ingestion-service/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1393,7 +1393,7 @@ services: service_category: application service_title: Distributed Message Service service_type: dms - service_uri: distributed-message-service + service_uri: distributed-message-service/umn teams: - name: docs-orchestration-rw permission: write @@ -1407,7 +1407,7 @@ services: service_category: network service_title: Domain Name Service service_type: dns - service_uri: domain-name-service + service_uri: domain-name-service/umn teams: - name: docs-network-rw permission: write @@ -1421,7 +1421,7 @@ services: service_category: big_data service_title: Data Lake Insight service_type: dli - service_uri: data-lake-insight + service_uri: data-lake-insight/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1435,7 +1435,7 @@ services: service_category: database service_title: Data Replication Service service_type: drs - service_uri: data-replication-service + service_uri: data-replication-service/umn teams: - name: docs-database-rw permission: write @@ -1449,7 +1449,7 @@ services: service_category: big_data service_title: Data Warehouse Service service_type: dws - service_uri: data-warehouse-service + service_uri: data-warehouse-service/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1484,7 +1484,7 @@ services: service_category: other service_title: Enterprise Dashboard service_type: ed - service_uri: enterprise-dashboard + service_uri: enterprise-dashboard/umn teams: - name: docs-dashboard-rw permission: write @@ -1498,7 +1498,7 @@ services: service_category: network service_title: Elastic IP service_type: eip - service_uri: elastic-ip + service_uri: elastic-ip/umn teams: - name: docs-network-rw permission: write @@ -1512,7 +1512,7 @@ services: service_category: network service_title: Elastic Load Balancing service_type: elb - service_uri: elastic-load-balancing + service_uri: elastic-load-balancing/umn teams: - name: docs-network-rw permission: write @@ -1526,7 +1526,7 @@ services: service_category: network service_title: Enterprise Router service_type: er - service_uri: enterprise-router + service_uri: enterprise-router/umn teams: - name: docs-network-rw permission: write @@ -1540,7 +1540,7 @@ services: service_category: storage service_title: Elastic Volume Service service_type: evs - service_uri: elastic-volume-service + service_uri: elastic-volume-service/umn teams: - name: docs-storage-rw permission: write @@ -1554,7 +1554,7 @@ services: service_category: database service_title: GaussDB (for MySQL) service_type: gaussdb_mysql - service_uri: gaussdb-mysql + service_uri: gaussdb-mysql/umn teams: - name: docs-database-rw permission: write @@ -1568,7 +1568,7 @@ services: service_category: database service_title: GaussDB NoSQL service_type: gaussdb_nosql - service_uri: gaussdb-nosql + service_uri: gaussdb-nosql/umn teams: - name: docs-database-rw permission: write @@ -1582,7 +1582,7 @@ services: service_category: security-services service_title: Identity and Access Management service_type: iam - service_uri: identity-access-management + service_uri: identity-access-management/umn teams: - name: docs-security-services-rw permission: write @@ -1596,7 +1596,7 @@ services: service_category: compute service_title: Image Management Service service_type: ims - service_uri: image-management-service + service_uri: image-management-service/umn teams: - name: docs-compute-rw permission: write @@ -1610,7 +1610,7 @@ services: service_category: security-services service_title: Key Management Service service_type: kms - service_uri: key-management-service + service_uri: key-management-service/umn teams: - name: docs-security-services-rw permission: write @@ -1624,7 +1624,7 @@ services: service_category: md service_title: Log Tank Service service_type: lts - service_uri: log-tank-service + service_uri: log-tank-service/umn teams: - name: docs-orchestration-rw permission: write @@ -1638,7 +1638,7 @@ services: service_category: big_data service_title: ModelArts service_type: ma - service_uri: modelarts + service_uri: modelarts/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1652,7 +1652,7 @@ services: service_category: big_data service_title: MapReduce Service service_type: mrs - service_uri: mapreduce-service + service_uri: mapreduce-service/umn teams: - name: docs-bigdata-ai-rw permission: write @@ -1666,7 +1666,7 @@ services: service_category: network service_title: NAT Gateway service_type: natgw - service_uri: nat-gateway + service_uri: nat-gateway/umn teams: - name: docs-network-rw permission: write @@ -1680,7 +1680,7 @@ services: service_category: storage service_title: Object Storage Service service_type: obs - service_uri: object-storage-service + service_uri: object-storage-service/umn teams: - name: docs-storage-rw permission: write @@ -1694,7 +1694,7 @@ services: service_category: database service_title: GaussDB (openGauss) service_type: opengauss - service_uri: gaussdb-opengauss + service_uri: gaussdb-opengauss/umn teams: - name: docs-database-rw permission: write @@ -1708,7 +1708,7 @@ services: service_category: network service_title: Private Link Access Service service_type: plas - service_uri: private-link-access-service + service_uri: private-link-access-service/umn teams: - name: docs-network-rw permission: write @@ -1722,7 +1722,7 @@ services: service_category: database service_title: Relational Database Service service_type: rds - service_uri: relational-database-service + service_uri: relational-database-service/umn teams: - name: docs-database-rw permission: write @@ -1736,7 +1736,7 @@ services: service_category: md service_title: Resource Management Service service_type: rms - service_uri: resource-management-service + service_uri: resource-management-service/umn teams: - name: docs-orchestration-rw permission: write @@ -1750,7 +1750,7 @@ services: service_category: md service_title: Resource Template Service service_type: rts - service_uri: resource-template-service + service_uri: resource-template-service/umn teams: - name: docs-orchestration-rw permission: write @@ -1764,7 +1764,7 @@ services: service_category: other service_title: Status Dashboard service_type: sd - service_uri: status-dashboard + service_uri: status-dashboard/umn teams: - name: docs-eco-rw permission: write @@ -1778,7 +1778,7 @@ services: service_category: storage service_title: Storage Disaster Recovery Service service_type: sdrs - service_uri: storage-disaster-recovery-service + service_uri: storage-disaster-recovery-service/umn teams: - name: docs-storage-rw permission: write @@ -1792,7 +1792,7 @@ services: service_category: storage service_title: Scalable File System service_type: sfs - service_uri: scalable-file-service + service_uri: scalable-file-service/umn teams: - name: docs-storage-rw permission: write @@ -1806,7 +1806,7 @@ services: service_category: application service_title: Simple Message Notification service_type: smn - service_uri: simple-message-notification + service_uri: simple-message-notification/umn teams: - name: docs-orchestration-rw permission: write @@ -1820,7 +1820,7 @@ services: service_category: network service_title: Secure Mail Gateway service_type: smg - service_uri: secure-mail-gateway + service_uri: secure-mail-gateway/umn teams: - name: docs-network-rw permission: write @@ -1834,7 +1834,7 @@ services: service_category: container service_title: Software Repository for Containers service_type: swr - service_uri: software-repository-container + service_uri: software-repository-container/umn teams: - name: docs-container-rw permission: write @@ -1848,7 +1848,7 @@ services: service_category: md service_title: Tag Management Service service_type: tms - service_uri: tag-management-service + service_uri: tag-management-service/umn teams: - name: docs-orchestration-rw permission: write @@ -1862,7 +1862,7 @@ services: service_category: storage service_title: Volume Backup Service service_type: vbs - service_uri: volume-backup-service + service_uri: volume-backup-service/umn teams: - name: docs-storage-rw permission: write @@ -1876,7 +1876,7 @@ services: service_category: network service_title: Virtual Private Cloud service_type: vpc - service_uri: virtual-private-cloud + service_uri: virtual-private-cloud/umn teams: - name: docs-network-rw permission: write @@ -1890,7 +1890,7 @@ services: service_category: network service_title: VPC Endpoint service_type: vpcep - service_uri: vpc-endpoint + service_uri: vpc-endpoint/umn teams: - name: docs-network-rw permission: write @@ -1904,7 +1904,7 @@ services: service_category: network service_title: Virtual Private Network service_type: vpn - service_uri: virtual-private-network + service_uri: virtual-private-network/umn teams: - name: docs-network-rw permission: write @@ -1918,7 +1918,7 @@ services: service_category: security-services service_title: Web Application Firewall service_type: waf - service_uri: web-application-firewall + service_uri: web-application-firewall/umn teams: - name: docs-security-services-rw permission: write @@ -1932,7 +1932,7 @@ services: service_category: security-services service_title: Dedicated Web Application Firewall service_type: wafd - service_uri: web-application-firewall-dedicated + service_uri: web-application-firewall-dedicated/umn teams: - name: docs-security-services-rw permission: write From 648c7b72ed7808daaa163758635dfa1c12a792f3 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Thu, 11 May 2023 17:15:54 +0000 Subject: [PATCH 17/17] added new service CSE Reviewed-by: vladimirhasko Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- otc_metadata/data/services.yaml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index 8b93dacc..7ee895e3 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -198,6 +198,22 @@ documents: service_type: csbs title: User Guide type: umn + - environment: internal + html_location: docs/cse/api-ref + link: /cloud-service-engine/api-ref/ + pdf_name: cse-api-ref + rst_location: api-ref/source + service_type: cse + title: API Reference + type: api-ref + - environment: internal + html_location: docs/cse/umn + link: /cloud-service-engine/umn/ + pdf_name: cse-umn + rst_location: umn/source + service_type: cse + title: User Guide + type: umn - hc_location: api/css html_location: docs/css/api-ref link: /cloud-search-service/api-ref/ @@ -1243,6 +1259,21 @@ services: teams: - name: docs-storage-rw permission: write + - repositories: + - environment: internal + repo: docs/cloud-service-engine + type: gitea + - environment: public + repo: opentelekomcloud-docs/cloud-service-engine + type: github + service_category: application + service_title: Cloud Service Engine + service_type: cse + service_uri: cloud-service-engine/umn + environment: internal + teams: + - name: docs-orchestration-rw + permission: write - repositories: - environment: internal repo: docs/cloud-search-service