PAAS - added jira_component tags. (#96)

Reviewed-on: #96
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Natalia Bobkova <natalia.bobkova@t-systems.com>
Co-committed-by: Natalia Bobkova <natalia.bobkova@t-systems.com>

.gitea/workflows/create-weekly-analytics-stats.yaml

@@ -53,10 +53,10 @@ jobs:
           git config --global user.name "gitea-actions[bot]"
           git config --global user.email "actions@users.noreply.local"
           git checkout -B analytics-update
-          git add analytics/
+          git add otc_metadata/analytics/
           if git diff --cached --quiet; then
             echo "No changes to commit"
           else
-            git commit -m "chore: update analytics data [skip ci]"
+            git commit -m "chore: update analytics data"
             git push origin analytics-update --force
           fi

otc_metadata/analytics/data.py

@@ -0,0 +1,48 @@
+# 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 pathlib import Path
+import json
+
+BASE_DIR = Path(__file__).resolve().parent
+analytics_path = BASE_DIR / "public"
+
+cloud_environments = [
+    'eu_de',
+    'swiss'
+]
+analytics_data = {k: [] for k in cloud_environments}
+
+# Open and read the json data files
+for env in cloud_environments:
+    file_path = analytics_path / f"{env}.json"
+    with file_path.open(encoding="utf-8") as file:
+        analytics_data[env] = json.load(file)
+
+
+class AnalyticsData(object):
+    """Encapsulate OTC Analystics data"""
+
+    def __init__(self):
+        self._analytics_data = analytics_data
+
+    def all_analytics_data(self):
+        """returns all analytics data"""
+        return self._analytics_data
+
+    def analytics_data_by_cloud_environment(self, cloud_environment):
+        """returns all analytics data"""
+        if cloud_environment and cloud_environment in self._analytics_data:
+            return self._analytics_data[cloud_environment]
+        else:
+            raise ValueError(f"cloud_environment '{cloud_environment}' does not exist.")

otc_metadata/analytics/public/eu_de.json

@@ -2,11 +2,11 @@
   "evs",
   "ims",
   "ecs",
-  "cce",
   "obs",
+  "cce",
+  "elb",
   "rds",
   "sfs",
   "iam",
-  "config",
+  "vpc"
-  "elb"
 ]

otc_metadata/analytics/public/swiss.json

@@ -2,11 +2,11 @@
   "evs",
   "ims",
   "ecs",
-  "cce",
   "obs",
+  "cce",
+  "elb",
   "rds",
   "iam",
-  "elb",
+  "vpc",
-  "cbr",
   "vpn"
 ]

otc_metadata/data/cloud_environments/eu_de.yaml

@@ -0,0 +1,11 @@
+---
+name: eu_de
+table_suffix: ""
+internal_org: docs
+public_org: opentelekomcloud-docs
+regions:
+  - eu-de
+affected_locations:
+  - "EU-DE-01 AZ1 (Germany/Biere)"
+  - "EU-DE-02 AZ2 (Germany/Magdeburg)"
+  - "EU-DE-03 AZ3 (Germany/Biere)"

otc_metadata/data/cloud_environments/swiss.yaml

@@ -0,0 +1,11 @@
+---
+name: swiss
+table_suffix: _swiss
+internal_org: docs-swiss
+public_org: opentelekomcloud-docs-swiss
+regions:
+  - eu-ch2
+affected_locations:
+  - "EU-CH2-01 SwissCloud AZ1 (Switzerland/Zollikofen)"
+  - "EU-CH2-02 SwissCloud AZ2 (Switzerland/Bern)"
+  - "EU-CH2-03 SwissCloud AZ3 (Switzerland/Zollikofen)"

otc_metadata/data/documents/apig-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/apig
 html_location: docs/apig/dev
 link: /api-gateway/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: apig
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: hidden

otc_metadata/data/documents/as-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/as
 html_location: docs/as/dev
 link: /auto-scaling/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: as
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/bms-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/bms
 html_location: docs/bms/dev
 link: /bare-metal-server/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: bms
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/ccn-api-ref.yaml

@@ -8,6 +8,6 @@ title: API Reference
 type: api-ref
 cloud_environments:
   - name: eu_de
-    visibility: internal
+    visibility: public
     pdf_visibility: public
     pdf_enabled: true

otc_metadata/data/documents/ccn-umn.yaml

@@ -8,6 +8,6 @@ title: User Guide
 type: umn
 cloud_environments:
   - name: eu_de
-    visibility: internal
+    visibility: public
     pdf_visibility: public
     pdf_enabled: true

otc_metadata/data/documents/dli-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/dli
 html_location: docs/dli/dev
 link: /data-lake-insight/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: dli
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/dms-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/dms
 html_location: docs/dms/dev
 link: /distributed-message-service/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: dms
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/dms_rabbitmq-api-ref.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: api/rabbitmq
+html_location: docs/dms_rabbitmq/api-ref
+link: /distributed-message-service-rabbitmq/api-ref/
+rst_location: api-ref/source
+service_type: dms_rabbitmq
+title: API Reference
+type: api-ref
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/dms_rabbitmq-umn.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: usermanual/rabbitmq
+html_location: docs/dms_rabbitmq/umn
+link: /distributed-message-service-rabbitmq/umn/
+rst_location: umn/source
+service_type: dms_rabbitmq
+title: User Guide
+type: umn
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/dms_rocketmq-api-ref.yaml

@@ -8,6 +8,6 @@ title: API Reference
 type: api-ref
 cloud_environments:
   - name: eu_de
-    visibility: internal
+    visibility: public
     pdf_visibility: public
     pdf_enabled: true

otc_metadata/data/documents/dms_rocketmq-umn.yaml

@@ -8,6 +8,6 @@ title: User Guide
 type: umn
 cloud_environments:
   - name: eu_de
-    visibility: internal
+    visibility: public
     pdf_visibility: public
     pdf_enabled: true

otc_metadata/data/documents/dws-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/dws
 html_location: docs/dws/dev
 link: /data-warehouse-service/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: dws
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/ecs-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/ecs
 html_location: docs/ecs/dev
 link: /elastic-cloud-server/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: ecs
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/ed-alerting.yaml

@@ -0,0 +1,11 @@
+---
+link: /enterprise-dashboard/alerting/
+rst_location: doc/alerting/source
+service_type: ed
+title: Alerting
+type: alerting
+cloud_environments:
+  - name: eu_de
+    visibility: public
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/ed-sustainability.yaml

@@ -0,0 +1,11 @@
+---
+link: /enterprise-dashboard/sustainability/
+rst_location: doc/sustainability/source
+service_type: ed
+title: Sustainability
+type: sustainability
+cloud_environments:
+  - name: eu_de
+    visibility: public
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/eps-api-ref.yaml

@@ -8,6 +8,6 @@ title: API Reference
 type: api-ref
 cloud_environments:
   - name: eu_de
-    visibility: internal
+    visibility: public
     pdf_visibility: public
     pdf_enabled: true

otc_metadata/data/documents/eps-umn.yaml

@@ -8,6 +8,6 @@ title: User Guide
 type: umn
 cloud_environments:
   - name: eu_de
-    visibility: internal
+    visibility: public
     pdf_visibility: public
     pdf_enabled: true

otc_metadata/data/documents/esw-umn.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: usermanual/esw
+html_location: docs/esw/umn
+link: /enterprise-switch/umn/
+rst_location: umn/source
+service_type: esw
+title: User Guide
+type: umn
+cloud_environments:
+  - name: eu_de
+    visibility: public
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/evs-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/evs
 html_location: docs/evs/dev
 link: /elastic-volume-service/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: evs
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/fg-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/functiongraph
 html_location: docs/fg/dev
 link: /function-graph/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: fg
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: internal

otc_metadata/data/documents/ims-dev.yaml

@@ -2,10 +2,10 @@
 hc_location: devg/ims
 html_location: docs/ims/dev
 link: /image-management-service/dev-guide/
-rst_location: dev_guide/source
+rst_location: doc/dev-guide/source
 service_type: ims
 title: Developer Guide
-type: dev
+type: dev-guide
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/documents/obs-tool-guide-obsutil.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: utiltg/obs
+html_location: docs/obs/tool-obsutil
+link: /object-storage-service/tool-guide-obsutil/
+rst_location: doc/tool-obsutil/source
+service_type: obs
+title: Tool Guide (obsutil)
+type: tool-guide-obsutil
+cloud_environments:
+  - name: eu_de
+    visibility: public
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/obs_3rd_party-dotnet-sdk.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: sdk/dotnet-devg-obs
+html_location: docs/obs_3rd_party/dotnet_sdk
+link: /object-storage-service-3rd-party/dotnet-sdk/
+rst_location: doc/dotnet-sdk/source
+service_type: obs_3rd_party
+title: .NET SDK
+type: dotnet-sdk
+cloud_environments:
+  - name: eu_de
+    visibility: public
+    pdf_visibility: public
+    pdf_enabled: false

otc_metadata/data/documents/obs_3rd_party-nodejs-sdk-sdk.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: sdk/nodejs-devg-obs
+html_location: docs/obs_3rd_party/nodejs_sdk
+link: /object-storage-service-3rd-party/nodejs-sdk/
+rst_location: doc/nodejs-sdk/source
+service_type: obs_3rd_party
+title: Node.js SDK
+type: nodejs-sdk
+cloud_environments:
+  - name: eu_de
+    visibility: public
+    pdf_visibility: public
+    pdf_enabled: false

otc_metadata/data/repositories/dms_rabbitmq.yaml

@@ -0,0 +1,13 @@
+---
+service_type: dms_rabbitmq
+repositories:
+  - environment: public
+    repo: opentelekomcloud-docs/distributed-message-service-rabbitmq
+    type: github
+    cloud_environments:
+      - eu_de
+  - environment: internal
+    repo: docs/distributed-message-service-rabbitmq
+    type: gitea
+    cloud_environments:
+      - eu_de

otc_metadata/data/repositories/esw.yaml

@@ -0,0 +1,13 @@
+---
+service_type: esw
+repositories:
+  - environment: public
+    repo: opentelekomcloud-docs/enterprise-switch
+    type: github
+    cloud_environments:
+      - eu_de
+  - environment: internal
+    repo: docs/enterprise-switch
+    type: gitea
+    cloud_environments:
+      - eu_de

otc_metadata/data/services.yaml

@@ -17,6 +17,7 @@
 # documents/services/service_categories is being merged with
 # the content here.
 ---
+cloud_environments: []
 documents: []
 service_categories: []
 services: []

otc_metadata/data/services/README.md

@@ -10,6 +10,7 @@ service_category: compute
 service_title: Elastic Cloud Server
 service_type: ecs
 service_uri: elastic-cloud-server
+jira_component: ECS
 teams:
   - name: docs-compute-rw
     permission: write
@@ -30,6 +31,7 @@ is_global: false
 | `service_title`      | string  | Display name of the service.                                          |
 | `service_type`       | string  | Unique identifier used across all metadata.                           |
 | `service_uri`        | string  | URI component used in documentation links.                            |
+| `jira_component`     | string  | Component name registered in JIRA (Capital letters).                  |
 | `cloud_environments` | list    | List of cloud regions and their visibility settings.                  |
 | `teams`              | list    | Contributor teams with write or read access.                          |
 

otc_metadata/data/services/antiddos.yaml

@@ -4,6 +4,7 @@ service_category: security-services
 service_title: Anti-DDoS
 service_type: antiddos
 service_uri: anti-ddos
+jira_component: ANTIDDOS
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/services/aom.yaml

@@ -4,6 +4,7 @@ service_category: application
 service_title: Application Operations Management
 service_type: aom
 service_uri: application-operations-management
+jira_component: AOM
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/services/aom2.yaml

@@ -4,6 +4,7 @@ service_category: application
 service_title: Application Operations Management 2.0
 service_type: aom2
 service_uri: application-operations-management-2
+jira_component: AOM
 cloud_environments:
   - name: eu_de
     visibility: internal

otc_metadata/data/services/apig.yaml

@@ -4,9 +4,11 @@ service_category: application
 service_title: API Gateway (APIG)
 service_type: apig
 service_uri: api-gateway
+jira_component: APIGT
 cloud_environments:
   - name: eu_de
     visibility: public
 teams:
   - name: docs-paas-rw
     permission: write
+description: API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps you build, manage, and deploy APIs at any scale. With just a few clicks, you can integrate internal systems, and selectively expose capabilities with minimal costs and risks.

otc_metadata/data/services/apm.yaml

@@ -4,6 +4,7 @@ service_category: application
 service_title: Application Performance Management
 service_type: apm
 service_uri: application-performance-management
+jira_component: APM
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/services/asm.yaml

@@ -4,6 +4,7 @@ service_category: container
 service_title: Application Service Mesh
 service_type: asm
 service_uri: application-service-mesh
+jira_component: ASM
 cloud_environments:
   - name: eu_de
     visibility: public

otc_metadata/data/services/cbr.yaml

@@ -3,6 +3,7 @@ service_category: storage
 service_title: Cloud Backup and Recovery
 service_type: cbr
 service_uri: cloud-backup-recovery
+jira_component: CBR
 is_global: false
 teams:
   - name: docs-storage-rw
@@ -12,3 +13,4 @@ cloud_environments:
     visibility: public
   - name: swiss
     visibility: public
+description: Cloud Backup and Recovery (CBR) allows you to back up cloud disks, elastic cloud servers, and bare metal servers, protecting the security and accuracy of your data to the greatest extent for service security.

otc_metadata/data/services/cce.yaml

@@ -3,6 +3,7 @@ service_category: container
 service_title: Cloud Container Engine
 service_type: cce
 service_uri: cloud-container-engine
+jira_component: CCE 
 teams:
   - name: docs-container-rw
     permission: write
@@ -12,3 +13,4 @@ cloud_environments:
   - name: swiss
     visibility: public
 is_global: false
+description: CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.

otc_metadata/data/services/cci.yaml

@@ -3,6 +3,7 @@ service_category: container
 service_title: Cloud Container Instance
 service_type: cci
 service_uri: cloud-container-instance
+jira_component: CCI
 teams:
   - name: docs-container-rw
     permission: write

otc_metadata/data/services/ccn.yaml

@@ -8,5 +8,5 @@ teams:
     permission: write
 cloud_environments:
   - name: eu_de
-    visibility: internal
+    visibility: public
 is_global: false

otc_metadata/data/services/ces.yaml

@@ -3,6 +3,7 @@ service_category: md
 service_title: Cloud Eye
 service_type: ces
 service_uri: cloud-eye
+jira_component: CES
 teams:
   - name: docs-cms-rw
     permission: write

otc_metadata/data/services/cfw.yaml

@@ -3,6 +3,7 @@ service_category: security-services
 service_title: Cloud Firewall
 service_type: cfw
 service_uri: cloud-firewall
+jira_component: CFW
 teams:
   - name: docs-security-services-rw
     permission: write

otc_metadata/data/services/config.yaml

@@ -3,6 +3,7 @@ service_category: md
 service_title: Config
 service_type: config
 service_uri: config
+jira_component: CONFIG
 teams:
   - name: docs-cms-rw
     permission: write

otc_metadata/data/services/csbs.yaml

@@ -3,6 +3,7 @@ service_category: storage
 service_title: Cloud Server Backup Service
 service_type: csbs
 service_uri: cloud-server-backup-service
+jira_component: CSBS
 teams:
   - name: docs-storage-rw
     permission: write

otc_metadata/data/services/cts.yaml

@@ -3,6 +3,7 @@ service_category: md
 service_title: Cloud Trace Service
 service_type: cts
 service_uri: cloud-trace-service
+jira_component: CTS
 teams:
   - name: docs-paas-rw
     permission: write