Compare commits

..

1 Commits

Author SHA1 Message Date
35df675490 Added Quay link 2024-02-15 10:27:53 +00:00
116 changed files with 60 additions and 221 deletions

View File

@ -1,8 +0,0 @@
=============================
APImon Internal Documentation
=============================
.. toctree::
:maxdepth: 2
apimon_training/index

View File

@ -10,5 +10,5 @@ You can update the Backend by following those steps:
1. Merge the Pull-Request 1. Merge the Pull-Request
2. Wait until the gate job has been passed 2. Wait until the gate job has been passed
3. Look at the Zuul-logs from the gate job. Find the line with `Successfully tagged quay.io` and remember the `:change_xx_latest` value 3. Look at the Zuul-logs from the gate job. Find the line with `Successfully tagged quay.io` and remember the `:change_xx_latest` value
4. Open a Pull-Request to adjust the kustomization config to the new tag from step 3. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/overlays/prod/kustomization.yaml#L14 4. Open a Pull-Request to adjust the kustomization config to the new tag from step 3. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/base/kustomization.yaml#L14
5. Merge this Pull-Request and wait 10 minutes. 5. Merge this Pull-Request and wait 10 minutes.

View File

@ -11,7 +11,7 @@ You can update the Frontend by following those steps:
2. Tag the desired commit and push the tag to Github. It should be visible afterwards on this page: https://github.com/opentelekomcloud-infra/circle-partner-navigator-frontend/tags 2. Tag the desired commit and push the tag to Github. It should be visible afterwards on this page: https://github.com/opentelekomcloud-infra/circle-partner-navigator-frontend/tags
3. Wait at least 10 minutes 3. Wait at least 10 minutes
4. Check whether your tag has been successfully published to the container repository: https://quay.io/repository/opentelekomcloud/circle-partner-navigator-frontend?tab=tags 4. Check whether your tag has been successfully published to the container repository: https://quay.io/repository/opentelekomcloud/circle-partner-navigator-frontend?tab=tags
5. Open a Pull-Request to adjust the kustomization config to the new tag. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/overlays/prod/kustomization.yaml#L16 5. Open a Pull-Request to adjust the kustomization config to the new tag. https://github.com/opentelekomcloud-infra/system-config/blob/main/kubernetes/circle-partner-navigator/base/kustomization.yaml#L16
6. Merge this Pull-Request and wait 10 minutes. 6. Merge this Pull-Request and wait 10 minutes.
Be aware that updating the Frontend will also pull the data from the Backend again and as a result will also update the partner data on the website. Be aware that updating the Frontend will also pull the data from the Backend again and as a result will also update the partner data on the website.

View File

@ -3,7 +3,7 @@ Circle Partner Navigator
======================== ========================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
backend/index backend/index
frontend/index frontend/index

View File

@ -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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

View File

@ -1,8 +0,0 @@
=====================
Helpcenter Operations
=====================
.. toctree::
:maxdepth: 2
backstage_add_repo

View File

@ -1,9 +0,0 @@
=================================
Helpcenter Internal Documentation
=================================
.. toctree::
:maxdepth: 2
hc_ops/index
helpcenter_training/index

View File

@ -3,10 +3,7 @@ Internal Documentation
====================== ======================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
APImon <apimon/index> training/index
Status Dashboard <status_dashboard/index> cpn/index
Helpcenter <helpcenter/index>
Circle Partner Navigator <cpn/index>
otcdocstheme <otcdocstheme/index>

View File

@ -1,9 +0,0 @@
==========================
otcdocstheme Documentation
==========================
.. toctree::
:maxdepth: 1
updating_the_theme
parsed_confpy_settings

View File

@ -1,20 +0,0 @@
================
Conf.Py Settings
================
The otcdocstheme provides a variety of configuration options which can be specified in each projects conf.py
1. repo_name = Name of the Repository which gets displayed on the left side of the HTML page
2. edit_enabled = Whether the `Edit page` button on the right side is being rendered or not
3. bug_report_enabled = Whether the `Report Documentation Bug` button on the right side is being rendered or not
4. doc_environment = `public` or `internal` to differentiate search
5. doc_link = The link to this document category, e.g. `/application-operations-management/umn/`
6. doc_title = The title of this document category, e.g. `User Guide`
7. doc_type = The type of this document, e.g. `umn`, limited to the following selection: https://github.com/opentelekomcloud/otc-sphinx-directives/blob/main/otc_sphinx_directives/service_card.py#L54
8. service_title = The service title, e.g. `Application Operations Management`
9. service_type = The service type, e.g. `aom`, limited to the following selection https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/services
10. service_category = The service category, e.g. `application`, limited to the following selection https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/service_categories
11. otcdocs_search_environment = Name of the search index, e.g. `hc_de`, limited to `hc_de` or `hc_swiss`
12. otcdocs_search_index = Search index wildcard name, e.g. `helpcenter-`, default: `helpcenter-`
13. otcdocs_search_url = Search URL for OpenSearch, e.g. `https://opensearch.eco.tsi-dev.otc-service.com/`

View File

@ -1,31 +0,0 @@
=========================
Updating the otcdocstheme
=========================
Updating the Scale Version
--------------------------
You can update the Scale version which the otcdocstheme uses by following those steps:
1. Obtain the newest Scale version from here: https://github.com/telekom/scale/releases/tag/latest
2. Look at the releasenotes and make sure there are no breaking changes
3. Download the `telekom-scale-components-x.x.x-beta.xxx.zip` file
4. Remove the `scale-components` folder inside `otcdocstheme/theme/otcdocs/static/`
5. Extract the new `scale-components` folder from the downloaded zip file to the same directory. We only need that folder and not the whole `dist` structure.
6. Render the new theme with `tox -e docs` and check for issues. Also remeber to check the sample `api-ref` documentation as well as `docsportal`
7. Open a new pull request with the changes and merge it
After that continue with the Step :ref:`new-release` to publish it to production or internal documentation.
.. _new-release:
Publishing a new Release
------------------------
After you merged changes into otcdocstheme you can proceed with releasing them to either the internal or external documentation.
1. Make sure to check whether you want your change to be only published to the internal helpcenter or to both of them.
2. Check the required version here: https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/templates/doc_requirements.txt.j2#L2
3. Check the current version number of otcdocstheme https://github.com/opentelekomcloud/otcdocstheme/tags
4. Add a new tag to the latest commit of otcdocstheme and specify the version, e.g. by using `git tag 0.2.11`. Be sure to specify a higher version than the latest one. If you only want to push the changes to internal helpcenter make sure to choose a version number which is higher than the maximum allowed number for public helpcenter from step 2.
5. The next rebuild of each documentation page which happens during the night will use the updated theme

View File

@ -1,8 +0,0 @@
=======================================
Status Dashboard Internal Documentation
=======================================
.. toctree::
:maxdepth: 2
sd2_training/index

View File

@ -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>`_.

View File

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

View File

@ -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.

View File

@ -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 |
+----------------------------+------------------------------------------------------------------+ +----------------------------+------------------------------------------------------------------+

View File

@ -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

View File

Before

Width:  |  Height:  |  Size: 188 KiB

After

Width:  |  Height:  |  Size: 188 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View File

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Some files were not shown because too many files have changed in this diff Show More