Compare commits
1 Commits
main
...
otcdocsthe
Author | SHA1 | Date | |
---|---|---|---|
962f1bda3f |
@ -1,8 +0,0 @@
|
|||||||
=============================
|
|
||||||
APImon Internal Documentation
|
|
||||||
=============================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
apimon_training/index
|
|
@ -3,7 +3,7 @@ Circle Partner Navigator
|
|||||||
========================
|
========================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
backend/index
|
backend/index
|
||||||
frontend/index
|
frontend/index
|
||||||
|
@ -1,79 +0,0 @@
|
|||||||
===================================
|
|
||||||
Add a new Repository with Backstage
|
|
||||||
===================================
|
|
||||||
|
|
||||||
This document describes the steps to be done to register a new Helpcenter Repository.
|
|
||||||
|
|
||||||
1. Register the Service in infra/metadata
|
|
||||||
-----------------------------------------
|
|
||||||
|
|
||||||
Modify the following sample files for your need and open a Pull Request in the respective Gitea Repository.
|
|
||||||
|
|
||||||
Service registration under: `otc_metadata/data/services <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/services>`_
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
---
|
|
||||||
environment: public
|
|
||||||
repositories:
|
|
||||||
- environment: internal
|
|
||||||
repo: docs/cloud-container-engine
|
|
||||||
type: gitea
|
|
||||||
- environment: public
|
|
||||||
repo: opentelekomcloud-docs/cloud-container-engine
|
|
||||||
type: github
|
|
||||||
service_category: container
|
|
||||||
service_title: Cloud Container Engine
|
|
||||||
service_type: cce
|
|
||||||
service_uri: cloud-container-engine
|
|
||||||
teams:
|
|
||||||
- name: docs-container-rw
|
|
||||||
permission: write
|
|
||||||
|
|
||||||
Documents registration under: `otc_metadata/data/documents <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/documents>`_
|
|
||||||
|
|
||||||
.. code::
|
|
||||||
|
|
||||||
---
|
|
||||||
hc_location: usermanual2/cce
|
|
||||||
html_location: docs/cce/umn
|
|
||||||
link: /cloud-container-engine/umn/
|
|
||||||
rst_location: umn/source
|
|
||||||
service_type: cce
|
|
||||||
title: User Guide
|
|
||||||
type: umn
|
|
||||||
|
|
||||||
2. Use Backstage to create a Git internal / public Repository
|
|
||||||
-------------------------------------------------------------
|
|
||||||
|
|
||||||
- Open Backstage under: https://backstage.eco.tsi-dev.otc-service.com/
|
|
||||||
- Navigate to :code:`Create...` in the left sidebar
|
|
||||||
- Choose :code:`Helpcenter Service` from the list in the main section
|
|
||||||
- Fill in the necessary information to create a Helpcenter repository in Gitea (internal)
|
|
||||||
|
|
||||||
.. figure:: images/hc_service.png
|
|
||||||
|
|
||||||
- Fill in the necessary information to create a Helpcenter repository in GitHub (public)
|
|
||||||
|
|
||||||
.. image:: images/hc_service2.png
|
|
||||||
|
|
||||||
3. Use Backstage to register the repositories to Zuul and set proper gitstyring permissions
|
|
||||||
-------------------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
- Open Backstage under: https://backstage.eco.tsi-dev.otc-service.com/
|
|
||||||
- Navigate to :code:`Create...` in the left sidebar
|
|
||||||
- Choose :code:`Action: Register repository in Zuul` from the list in the main section
|
|
||||||
- Fill in the necessary information as shown in the screenshots below
|
|
||||||
|
|
||||||
.. image:: images/hc_service3.png
|
|
||||||
|
|
||||||
.. image:: images/hc_service4.png
|
|
||||||
|
|
||||||
4. Approve Changes for gitstyring and Zuul
|
|
||||||
------------------------------------------
|
|
||||||
|
|
||||||
- Navigate to gitstyring repository in Gitea: https://gitea.eco.tsi-dev.otc-service.com/infra/gitstyring/pulls/
|
|
||||||
- Review and approve changes in the related Pull Request
|
|
||||||
- Wait until Gate-process has been finished
|
|
||||||
- Navigate to Zuul repository in Github: https://github.com/opentelekomcloud-infra/zuul-config/pulls
|
|
||||||
- Review and approve changes in the related Pull Request
|
|
Before Width: | Height: | Size: 74 KiB |
Before Width: | Height: | Size: 74 KiB |
Before Width: | Height: | Size: 72 KiB |
Before Width: | Height: | Size: 65 KiB |
@ -1,8 +0,0 @@
|
|||||||
=====================
|
|
||||||
Helpcenter Operations
|
|
||||||
=====================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
backstage_add_repo
|
|
@ -1,9 +0,0 @@
|
|||||||
=================================
|
|
||||||
Helpcenter Internal Documentation
|
|
||||||
=================================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
hc_ops/index
|
|
||||||
helpcenter_training/index
|
|
@ -3,10 +3,8 @@ Internal Documentation
|
|||||||
======================
|
======================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
|
|
||||||
APImon <apimon/index>
|
training/index
|
||||||
Status Dashboard <status_dashboard/index>
|
cpn/index
|
||||||
Helpcenter <helpcenter/index>
|
otcdocstheme/index
|
||||||
Circle Partner Navigator <cpn/index>
|
|
||||||
otcdocstheme <otcdocstheme/index>
|
|
@ -3,7 +3,7 @@ otcdocstheme Documentation
|
|||||||
==========================
|
==========================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
updating_the_theme
|
updating_the_theme
|
||||||
parsed_confpy_settings
|
parsed_confpy_settings
|
||||||
|
@ -1,8 +0,0 @@
|
|||||||
=======================================
|
|
||||||
Status Dashboard Internal Documentation
|
|
||||||
=======================================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
sd2_training/index
|
|
@ -26,4 +26,4 @@ If there is another issue/demand/request try to locate proper repository in
|
|||||||
https://github.com/orgs/stackmon/repositories
|
https://github.com/orgs/stackmon/repositories
|
||||||
|
|
||||||
For general questions you can write an E-Mail to the `Ecosystems Squad
|
For general questions you can write an E-Mail to the `Ecosystems Squad
|
||||||
<mailto:dl-pbcotcdeleco@t-systems.com>`_.
|
<mailto:dl-pbcotcdeleco@t-systems.com>`_.
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 109 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
@ -40,6 +40,6 @@ Logs
|
|||||||
|
|
||||||
|
|
||||||
For further details how to work with logs please refer to
|
For further details how to work with logs please refer to
|
||||||
:ref:`How To Read The Logs And Understand The Issue <working_with_logs>` FAQ
|
:ref:`How To Read The Logs And Understand The Issue <working_with_logs>` FAQ
|
||||||
page.
|
page.
|
||||||
|
|
@ -21,7 +21,7 @@ If the error has been acknowledged on Alerta, the new notification message for
|
|||||||
repeating error won't get posted again on Zulip.
|
repeating error won't get posted again on Zulip.
|
||||||
|
|
||||||
Notifications contain further details which help to identify root cause faster
|
Notifications contain further details which help to identify root cause faster
|
||||||
and more effectively.
|
and more effectively.
|
||||||
|
|
||||||
Notification parameters
|
Notification parameters
|
||||||
#######################
|
#######################
|
||||||
@ -63,3 +63,6 @@ Th EpMon notification consists of several fields:
|
|||||||
+----------------------------+------------------------------------------------------------------+
|
+----------------------------+------------------------------------------------------------------+
|
||||||
| **Request error response** | Error result of the requested API call |
|
| **Request error response** | Error result of the requested API call |
|
||||||
+----------------------------+------------------------------------------------------------------+
|
+----------------------------+------------------------------------------------------------------+
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -117,7 +117,7 @@ OpenStack SDK and otcextensions (otcextensions covers services which are out of
|
|||||||
scope of OpenStack SDK and extends its functionality with services provided by
|
scope of OpenStack SDK and extends its functionality with services provided by
|
||||||
OTC) support metric generation natively for every single API call and ApiMon
|
OTC) support metric generation natively for every single API call and ApiMon
|
||||||
executor supports collection of ansible playbook statistics so every single
|
executor supports collection of ansible playbook statistics so every single
|
||||||
scenario and task can store its result, duration and name in metric database.
|
scenario and task can store its result, duration and name in metric database.
|
||||||
|
|
||||||
But in some cases there's a need to provide measurement on multiple tasks which
|
But in some cases there's a need to provide measurement on multiple tasks which
|
||||||
represent some important aspect of the customer use case. For example measure
|
represent some important aspect of the customer use case. For example measure
|
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 188 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 88 KiB After Width: | Height: | Size: 88 KiB |
Before Width: | Height: | Size: 321 KiB After Width: | Height: | Size: 321 KiB |
Before Width: | Height: | Size: 142 KiB After Width: | Height: | Size: 142 KiB |
Before Width: | Height: | Size: 157 KiB After Width: | Height: | Size: 157 KiB |
Before Width: | Height: | Size: 184 KiB After Width: | Height: | Size: 184 KiB |
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 96 KiB |
Before Width: | Height: | Size: 165 KiB After Width: | Height: | Size: 165 KiB |
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 101 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
@ -25,3 +25,4 @@ ApiMon Flow Process
|
|||||||
alerts on Alerta.
|
alerts on Alerta.
|
||||||
#. Notifications containing alert details are sent to Zulip
|
#. Notifications containing alert details are sent to Zulip
|
||||||
#. Every test scenario stores it's job output log into Swift object storage for further analysis and investigation.
|
#. Every test scenario stores it's job output log into Swift object storage for further analysis and investigation.
|
||||||
|
|