chore: update analytics data

Reviewed-on: #65
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: Tino Schreiber <tino.schreiber@t-systems.com>
Co-committed-by: Tino Schreiber <tino.schreiber@t-systems.com>

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

@@ -0,0 +1,62 @@
+name: Create Weekly Analytics Stats
+
+on:
+  schedule:
+    # 03:00 UTC = 04:00 CET
+    - cron: "0 3 * * 1"
+  workflow_dispatch:
+
+jobs:
+  run-analytics:
+    runs-on: ubuntu
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PUSH_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests otc-metadata
+
+      - name: Run analytics for eu_de
+        env:
+          UMAMI_USERNAME: ${{ secrets.UMAMI_USERNAME }}
+          UMAMI_PASSWORD: ${{ secrets.UMAMI_PASSWORD }}
+        run: |
+          python ./tools/collect_statistics.py \
+            --website-id "${{ secrets.UMAMI_WEBSITE_ID }}" \
+            --cloud-environment "eu_de" \
+            --environment "public" \
+            --limit "10"
+
+      - name: Run analytics for swiss
+        env:
+          UMAMI_USERNAME: ${{ secrets.UMAMI_USERNAME }}
+          UMAMI_PASSWORD: ${{ secrets.UMAMI_PASSWORD }}
+        run: |
+          python ./tools/collect_statistics.py \
+            --website-id "${{ secrets.UMAMI_WEBSITE_ID }}" \
+            --cloud-environment "swiss" \
+            --environment "public" \
+            --limit "10"
+
+      - name: Commit and push results
+        run: |
+          git config --global user.name "gitea-actions[bot]"
+          git config --global user.email "actions@users.noreply.local"
+          git checkout -B analytics-update
+          git add otc_metadata/analytics/
+          if git diff --cached --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "chore: update analytics data"
+            git push origin analytics-update --force
+          fi

.gitea/workflows/python-tox.yaml

@@ -0,0 +1,18 @@
+name: Run Tox Check
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, edited]
+
+jobs:
+  tox-py312:
+    runs-on: ubuntu
+    steps:
+      - uses: https://github.com/opentelekomcloud-infra/github-actions/.github/actions/tox-py-test@v1
+
+  tox-pep8:
+    runs-on: ubuntu
+    steps:
+      - uses: https://github.com/opentelekomcloud-infra/github-actions/.github/actions/tox-py-test@v1
+        with:
+          tox-env: pep8

.gitea/workflows/update_opensearch_filters.yaml

@@ -0,0 +1,32 @@
+name: Updates Opensearch filters
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - main
+
+jobs:
+    update-opensearch-filters:
+        if: github.event.pull_request.merged == true
+        runs-on: ubuntu
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Set up Python
+              uses: actions/setup-python@v5
+              with:
+                  python-version: '3.12'
+
+            - name: Install dependencies and local package otc-metadata package
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install . -r tools-requirements.txt
+
+            - name: Update swiss and eu_de Opensearch indizies             
+              run: |
+                  python tools/index_metadata.py --hosts ${{ secrets.OPENSEARCH_HOST1 }} --target-environment public --index search_index_de --cloud-environment eu_de --username ${{ secrets.OPENSEARCH_USER }} --password ${{ secrets.OPENSEARCH_PW }} --delete-index
+                  python tools/index_metadata.py --hosts ${{ secrets.OPENSEARCH_HOST1 }} --target-environment public --index search_index_swiss --cloud-environment swiss --username ${{ secrets.OPENSEARCH_USER }} --password ${{ secrets.OPENSEARCH_PW }} --delete-index

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

@@ -0,0 +1,12 @@
+[
+  "evs",
+  "ecs",
+  "obs",
+  "cce",
+  "iam",
+  "ims",
+  "rds",
+  "vpc",
+  "ces",
+  "vpn"
+]

otc_metadata/analytics/public/swiss.json

@@ -0,0 +1,12 @@
+[
+  "evs",
+  "ecs",
+  "obs",
+  "cce",
+  "iam",
+  "ims",
+  "rds",
+  "vpc",
+  "ces",
+  "vpn"
+]

otc_metadata/data/cloud_environments/eu_de.yaml

@@ -0,0 +1,4 @@
+---
+name: eu_de
+internal_org: docs
+public_org: opentelekomcloud-docs

otc_metadata/data/cloud_environments/swiss.yaml

@@ -0,0 +1,4 @@
+---
+name: swiss
+internal_org: docs-swiss
+public_org: opentelekomcloud-docs-swiss

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/bcc-api-ref.yaml

@@ -0,0 +1,14 @@
+---
+hc_location: api/bcc
+html_location: docs/bcc/api-ref
+link: /business-continuity-center/api-ref/
+rst_location: api-ref/source
+service_type: bcc
+title: API Reference
+type: api-ref
+disable_import: true
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+    pdf_visibility: internal
+    pdf_enabled: false

otc_metadata/data/documents/bcc-umn.yaml

@@ -0,0 +1,14 @@
+---
+hc_location: usermanual/bcc
+html_location: docs/bcc/umn
+link: /business-continuity-center/umn/
+rst_location: umn/source
+service_type: bcc
+title: User Guide
+type: umn
+disable_import: true
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+    pdf_visibility: internal
+    pdf_enabled: false

otc_metadata/data/documents/bd-umn.yaml

@@ -1,13 +0,0 @@
----
-hc_location: usermanual/bd
-html_location: docs/bd/umn
-link: /business-dashboard/umn/
-rst_location: umn/source
-service_type: bd
-title: User Guide
-type: umn
-cloud_environments:
-  - name: eu_de
-    visibility: public
-    pdf_visibility: hidden
-    pdf_enabled: false

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/css-koosearch-api-ref.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: koosearch-api/css
+html_location: docs/css/koosearch-api-ref
+link: /cloud-search-service/koosearch-api-ref/
+rst_location: doc/koosearch-api-ref/source
+service_type: css
+title: Koosearch API Reference
+type: koosearch-api-ref
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/css-koosearch-umn.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: koosearch-usermanual/css
+html_location: docs/css/koosearch-umn
+link: /cloud-search-service/koosearch-umn/
+rst_location: doc/koosearch-umn/source
+service_type: css
+title: Koosearch User Guide
+type: koosearch-umn
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+    pdf_visibility: public
+    pdf_enabled: true

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

@@ -1,13 +0,0 @@
----
-hc_location: api/dis
-html_location: docs/dis/api-ref
-link: /data-ingestion-service/api-ref/
-rst_location: api-ref/source
-service_type: dis
-title: API Reference
-type: api-ref
-cloud_environments:
-  - name: eu_de
-    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_rocketmq-api-ref.yaml

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

otc_metadata/data/documents/dms_rocketmq-umn.yaml

@@ -0,0 +1,13 @@
+---
+hc_location: usermanual/hrm
+html_location: docs/dms_rocketmq/umn
+link: /distributed-message-service-rocketmq/umn/
+rst_location: umn/source
+service_type: dms_rocketmq
+title: User Guide
+type: umn
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+    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/esw-umn.yaml

@@ -1,13 +1,13 @@
 ---
-hc_location: usermanual/dis
-html_location: docs/dis/umn
-link: /data-ingestion-service/umn/
+hc_location: usermanual/esw
+html_location: docs/esw/umn
+link: /enterprise-switch/umn/
 rst_location: umn/source
-service_type: dis
+service_type: esw
 title: User Guide
 type: umn
 cloud_environments:
   - name: eu_de
-    visibility: public
+    visibility: internal
     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/mrs-api-ref.yaml

@@ -10,4 +10,4 @@ cloud_environments:
   - name: eu_de
     visibility: public
     pdf_visibility: public
-    pdf_enabled: false
+    pdf_enabled: true

otc_metadata/data/documents/mrs-operation-guide.yaml

@@ -10,4 +10,4 @@ cloud_environments:
   - name: eu_de
     visibility: public
     pdf_visibility: public
-    pdf_enabled: false
+    pdf_enabled: true

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

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

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

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

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

@@ -0,0 +1,13 @@
+---
+hc_location: sdk/java-devg-obs
+html_location: docs/obs_3rd_party/java_sdk
+link: /object-storage-service-3rd-party/java-sdk/
+rst_location: doc/java-sdk/source
+service_type: obs_3rd_party
+title: Java SDK
+type: java-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/documents/sd-umn.yaml

@@ -6,6 +6,7 @@ rst_location: umn/source
 service_type: sd
 title: User Guide
 type: umn
+disable_import: true
 cloud_environments:
   - name: swiss
     visibility: public

otc_metadata/data/documents/taurusdb-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/taurusdb-umn.yaml

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

otc_metadata/data/repositories/bcc.yaml

@@ -0,0 +1,13 @@
+---
+service_type: bcc
+repositories:
+  - environment: public
+    repo: opentelekomcloud-docs/business-continuity-center
+    type: github
+    cloud_environments:
+      - eu_de
+  - environment: internal
+    repo: docs/business-continuity-center
+    type: gitea
+    cloud_environments:
+      - eu_de

otc_metadata/data/repositories/bd.yaml

@@ -1,8 +0,0 @@
----
-service_type: bd
-repositories:
-  - environment: internal
-    repo: docs/business-dashboard
-    type: gitea
-    cloud_environments:
-      - eu_de

otc_metadata/data/repositories/dms_rocketmq.yaml

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

otc_metadata/data/repositories/esw.yaml

@@ -1,13 +1,13 @@
 ---
-service_type: dis
+service_type: esw
 repositories:
   - environment: public
-    repo: opentelekomcloud-docs/data-ingestion-service
+    repo: opentelekomcloud-docs/enterprise-switch
     type: github
     cloud_environments:
       - eu_de
   - environment: internal
-    repo: docs/data-ingestion-service
+    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/apig.yaml

@@ -10,3 +10,4 @@ cloud_environments:
 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/bcc.yaml

@@ -0,0 +1,12 @@
+---
+service_category: storage
+service_title: Business Continuity Center
+service_type: bcc
+service_uri: business-continuity-center
+teams:
+  - name: docs-storage-rw
+    permission: write
+cloud_environments:
+  - name: eu_de
+    visibility: internal
+is_global: false

otc_metadata/data/services/bd.yaml

@@ -1,12 +0,0 @@
----
-service_category: other
-service_title: Business Dashboard
-service_type: bd
-service_uri: business-dashboard
-is_global: false
-teams:
-  - name: docs-dashboard-rw
-    permission: write
-cloud_environments:
-  - name: eu_de
-    visibility: internal

otc_metadata/data/services/cbr.yaml

@@ -12,3 +12,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

@@ -12,3 +12,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/dis.yaml

@@ -1,12 +0,0 @@
----
-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
-cloud_environments:
-  - name: eu_de
-    visibility: public
-is_global: false

otc_metadata/data/services/dms.yaml

@@ -1,6 +1,6 @@
 ---
 service_category: application
-service_title: Distributed Message Service
+service_title: Distributed Message Service (for Kafka)
 service_type: dms
 service_uri: distributed-message-service
 teams: