add business dashboard (#108)

Reviewed-on: #108
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>

.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",
+  "ims",
+  "ecs",
+  "obs",
+  "cce",
+  "elb",
+  "rds",
+  "sfs",
+  "iam",
+  "vpc"
+]

otc_metadata/analytics/public/swiss.json

@@ -0,0 +1,12 @@
+[
+  "evs",
+  "ims",
+  "ecs",
+  "obs",
+  "cce",
+  "elb",
+  "rds",
+  "iam",
+  "vpc",
+  "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/aom2-umn.yaml

@@ -1,5 +1,5 @@
 ---
-hc_location: usermanual/aom2
+hc_location: usermanual2/aom
 html_location: docs/aom2/umn
 link: /application-operations-management-2/umn/
 rst_location: umn/source

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/asm-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/asm
-html_location: docs/asm/best-practice
-link: /application-service-mesh/best-practice/
-rst_location: doc/best-practice/source
-service_type: asm
-title: Best Practice
-type: best-practice
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true
-    disable_import: true

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,5 +1,4 @@
 ---
-hc_location: usermanual/bd
 html_location: docs/bd/umn
 link: /business-dashboard/umn/
 rst_location: umn/source

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

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

otc_metadata/data/documents/bms-dev.yaml

@@ -2,12 +2,12 @@
 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
-    pdf_visibility: public
+    visibility: internal
+    pdf_visibility: internal
     pdf_enabled: true

otc_metadata/data/documents/bms-image-creation-guide.yaml

@@ -8,6 +8,6 @@ title: Private Image Creation Guide
 type: image-creation-guide
 cloud_environments:
   - name: eu_de
-    visibility: public
-    pdf_visibility: public
+    visibility: internal
+    pdf_visibility: internal
     pdf_enabled: true

otc_metadata/data/documents/bms-umn.yaml

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

otc_metadata/data/documents/cbr-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/cbr
-html_location: docs/cbr/best-practice
-link: /cloud-backup-recovery/best-practice/
-rst_location: doc/best-practice/source
-service_type: cbr
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true

otc_metadata/data/documents/cce-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/cce
-html_location: docs/cce/best-practice
-link: /cloud-container-engine/best-practice/
-rst_location: doc/best-practice/source
-service_type: cce
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: false

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/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/dc-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/dc
-html_location: docs/dc/best-practice
-link: /direct-connect/best-practice/
-rst_location: doc/best-practice/source
-service_type: dc
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true

otc_metadata/data/documents/dcs-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/dcs
-html_location: docs/dcs/best-practice
-link: /distributed-cache-service/best-practice/
-rst_location: doc/best-practice/source
-service_type: dcs
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true

otc_metadata/data/documents/dds-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/dds
-html_location: docs/dds/best-practice
-link: /document-database-service/best-practice/
-rst_location: doc/best-practice/source
-service_type: dds
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    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-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/dms
-html_location: docs/dms/best-practice
-link: /distributed-message-service/best-practice/
-rst_location: doc/best-practice/source
-service_type: dms
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true

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

@@ -1,9 +1,9 @@
 ---
-hc_location: api/dis
-html_location: docs/dis/api-ref
-link: /data-ingestion-service/api-ref/
+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: dis
+service_type: dms_rocketmq
 title: API Reference
 type: api-ref
 cloud_environments:

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: public
+    pdf_visibility: public
+    pdf_enabled: true

otc_metadata/data/documents/dns-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/dns
-html_location: docs/dns/best-practice
-link: /domain-name-service/best-practice/
-rst_location: doc/best-practice/source
-service_type: dns
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true

otc_metadata/data/documents/drs-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/drs
-html_location: docs/drs/best-practice
-link: /data-replication-service/best-practice/
-rst_location: doc/best-practice/source
-service_type: drs
-title: Best Practice
-type: best-practice
-disable_import: true
-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-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/ecs
-html_location: docs/ecs/best-practice
-link: /elastic-cloud-server/best-practice/
-rst_location: doc/best-practice/source
-service_type: ecs
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true

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/elb-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/elb
-html_location: docs/elb/best-practice
-link: /elastic-load-balancing/best-practice/
-rst_location: doc/best-practice/source
-service_type: elb
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    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

@@ -1,9 +1,9 @@
 ---
-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:

otc_metadata/data/documents/evs-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/evs
-html_location: docs/evs/best-practice
-link: /elastic-volume-service/best-practice/
-rst_location: doc/best-practice/source
-service_type: evs
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    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-best-practice.yaml

@@ -1,14 +0,0 @@
----
-hc_location: bestpractice/functiongraph
-html_location: docs/fg/best-practice
-link: /function-graph/best-practice/
-rst_location: doc/best-practice/source
-service_type: fg
-title: Best Practice
-type: best-practice
-disable_import: true
-cloud_environments:
-  - name: eu_de
-    visibility: internal
-    pdf_visibility: public
-    pdf_enabled: true