forked from docs/internal-documentation
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0e65fa9f48 | |||
| 149ee50bfb | |||
| 3bd7da070b | |||
| ac578d1baa | |||
| 516445ee34 | |||
| 3666984377 | |||
| 43500e04c6 | |||
| 21d8d17281 |
@ -37,11 +37,11 @@ Once you have obtained this head over to GitHub and follow the instructions to i
|
||||
Configuring your backend
|
||||
------------------------
|
||||
|
||||
Your backend needs to check the validity of the captcha token which the user generated.
|
||||
Your backend needs to check the validity of the captcha token which the user generated.
|
||||
You can do this easily by sending an request using the generated token from the client, your sitekey and your secret key to mCaptcha.
|
||||
|
||||
.. code:: Javascript
|
||||
|
||||
|
||||
const postData = {
|
||||
token: captcha_token,
|
||||
key: captcha_sitekey,
|
||||
|
||||
@ -24,7 +24,7 @@ How it works
|
||||
Compared to classic Captcha Solutions like Google's Recaptcha this service does not have any image challenges, audio challenges or any Cookie tracking.
|
||||
Instead it is using a proof-of-work solution. Each user will get a small puzzle which the browser needs to solve. This works by using WebAssembly to compute the solution using the CPU of the device from the client.
|
||||
Typically this will not take longer than around one second, although this time can be modified in the settings of mCaptcha for each unique site. In case there will be lots of traffic the puzzle will get more complex and the time for solving it will increase.
|
||||
This effectively makes attacks from outside very hard to impossible as they would need a lot of compute power to break the Captcha.
|
||||
This effectively makes attacks from outside very hard to impossible as they would need a lot of compute power to break the Captcha.
|
||||
ReCaptcha works in the same way, if you solve a lot of Captchas they will get harder and harder, just that you need to click on more and more pictures there instead of solving mathematical puzzles with compute power.
|
||||
|
||||
For more information on how to configure mCaptcha head over to `Configuration of a new Site <configuration_of_a_new_site>`
|
||||
For more information on how to configure mCaptcha head over to `Configuration of a new Site <configuration_of_a_new_site>`
|
||||
|
||||
@ -6,3 +6,4 @@ Helpcenter Operations
|
||||
:maxdepth: 2
|
||||
|
||||
backstage_add_repo
|
||||
service_based_view
|
||||
|
||||
87
doc/source/helpcenter/hc_ops/service_based_view.rst
Normal file
87
doc/source/helpcenter/hc_ops/service_based_view.rst
Normal file
@ -0,0 +1,87 @@
|
||||
============================
|
||||
Service Based View knowledge
|
||||
============================
|
||||
|
||||
This document describe necessary knowledge about our Service Based View (SVB)
|
||||
which is the landing page for the specific service. There you have a short
|
||||
description of the service and you get all the links for the service
|
||||
documents.
|
||||
|
||||
Service Based View Code Snippets
|
||||
--------------------------------
|
||||
|
||||
The following Code Snippets represents the necessary information which is
|
||||
needed that SVB can run properly.
|
||||
|
||||
Internal SVB Code Snippet
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code::
|
||||
|
||||
Cloud Container Engine
|
||||
======================
|
||||
|
||||
CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.
|
||||
|
||||
.. directive_wrapper::
|
||||
:class: container-sbv
|
||||
|
||||
.. service_card::
|
||||
:service_type: cce
|
||||
:environment: internal
|
||||
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
|
||||
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
|
||||
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
|
||||
|
||||
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>`_
|
||||
|
||||
|
||||
Public SVB Code Snippet
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code::
|
||||
|
||||
Cloud Container Engine
|
||||
======================
|
||||
|
||||
CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.
|
||||
|
||||
.. directive_wrapper::
|
||||
:class: container-sbv
|
||||
|
||||
.. service_card::
|
||||
:service_type: cce
|
||||
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
|
||||
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
|
||||
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
|
||||
|
||||
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>`_
|
||||
|
||||
Possible Document Names
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The following document short names can be used to reference specific document types which are listed in the `Helpcenter Metadata <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata>`_ .
|
||||
New document types can be requested by creating an issue under https://github.com/opentelekomcloud-docs/docsportal/issues or get in contact
|
||||
with Ecosystem Squad.
|
||||
|
||||
* api-ref
|
||||
* blueprints
|
||||
* caf
|
||||
* dev
|
||||
* image-creation-guide
|
||||
* tool-guide
|
||||
* mycredential
|
||||
* public-images
|
||||
* sdk-ref
|
||||
* operation-guide
|
||||
* operation-guide-lts
|
||||
* parallel-file-system
|
||||
* permissions-configuration-guide
|
||||
* permissions
|
||||
* swiftapi
|
||||
* s3api
|
||||
* umn
|
||||
* umn2
|
||||
* best-practice
|
||||
* sqlreference
|
||||
* guidelines
|
||||
@ -28,11 +28,11 @@ Sync work with main currently do not support sync in console and you need to do
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
Host gitea.eco.tsi-dev.otc-service.com
|
||||
User git
|
||||
Port 2222
|
||||
HostName gitea.eco.tsi-dev.otc-service.com
|
||||
IdentityFile ~/.ssh/id_rsa
|
||||
Host gitea.eco.tsi-dev.otc-service.com
|
||||
User git
|
||||
Port 2222
|
||||
HostName gitea.eco.tsi-dev.otc-service.com
|
||||
IdentityFile ~/.ssh/id_rsa
|
||||
|
||||
You should be able to ssh gitea and get You've successfully authenticated message.
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 66 KiB After Width: | Height: | Size: 66 KiB |
@ -5,5 +5,5 @@ SDMoD Overview
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
look&feel_before/index
|
||||
look&feel_after/index
|
||||
look_and_feel_before/index
|
||||
look_and_feel_after/index
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
Component Availability
|
||||
---------------------------------------
|
||||
|
||||
The component availability shows the availability of each service each month.
|
||||
The services are categorized and split between eu-de and eu-nl.
|
||||
|
||||
The availability page is also directly reachable via https://status.otc-service.com/availability
|
||||
|
||||
The component availability is impacted by the following status:
|
||||
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
| Icon | Explanation |
|
||||
+======================================+==============================================================================+
|
||||
| .. image:: ../../images/outage.png | see explanation :ref:`Status of Services <status_services>` |
|
||||
| :target: ../../imags/outage.png | |
|
||||
| :alt: Outage | |
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
@ -1,19 +0,0 @@
|
||||
The menu
|
||||
---------------------------------------
|
||||
|
||||
.. image:: ../../images/menu.png
|
||||
:target: ../../images/menu.png
|
||||
:alt: The menu
|
||||
|
||||
The menu includes:
|
||||
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
| Event History | The event history shows up all past events - even if minor, major issues, |
|
||||
| | outages, or maintenances. |
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
| Component Availability | The component availability shows the availability of a service in the |
|
||||
| | previous months and is the basis for SLA calculation. |
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
| User Manual | Link to the actual version of the user manual. |
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
|
||||
@ -1,41 +0,0 @@
|
||||
.. _status_services:
|
||||
|
||||
Status of services
|
||||
------------------
|
||||
|
||||
The services can vary between the following status:
|
||||
|
||||
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
| Icon | Explanation |
|
||||
+======================================+==============================================================================+
|
||||
| .. image:: ../images/green.png | - All services are running fine |
|
||||
| :target: ../imags/green.png | |
|
||||
| :alt: Operational | |
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/blue.png | - A maintenance is planned or ongoing for a service |
|
||||
| :target: ../imags/blue.png | - A maintenance is triggered by the SDMoD |
|
||||
| :alt: Maintenance | |
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/yellow.png | - A minor issue occurred. The service is available but may have restrictions |
|
||||
| :target: ../imags/yellow.png | or slow response. |
|
||||
| :alt: Minor Issue | - A minor issue can either be triggered by the system autoamtically or |
|
||||
| | by SDMoD |
|
||||
| | |
|
||||
| | |
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/red.png | - A major issue occurred. The service may be available, but the |
|
||||
| :target: ../imags/red.png | responsiveness is affected and may lead to interruptions on customer side. |
|
||||
| :alt: Major Issue | - A major issue can either be triggered by the system autoamtically or by |
|
||||
| | SDMoD |
|
||||
| | |
|
||||
| | |
|
||||
| | |
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/outage.png | - A service is not available anymore at all. |
|
||||
| :target: ../imags/outage.png | - An outage can **only** be triggered by SDMoD. This will never happen |
|
||||
| :alt: Outage | automatically by the system |
|
||||
| | - **Only** outages are SLA relevant and do have impact to the component |
|
||||
| | availability |
|
||||
+--------------------------------------+------------------------------------------------------------------------------+
|
||||
|
||||
@ -4,7 +4,7 @@ Create a new incident
|
||||
After the login, the menu bar looks like the following:
|
||||
|
||||
.. image:: ../images/menu2.png
|
||||
:target: ../images/menu2.png
|
||||
:target: /internal-documentation/_images/menu2.png
|
||||
:alt: Menu after login
|
||||
|
||||
There is an additional option, which is called “Open new incident”
|
||||
@ -12,7 +12,7 @@ There is an additional option, which is called “Open new incident”
|
||||
If you click on it, the following view will appear:
|
||||
|
||||
.. image:: ../images/inc1.png
|
||||
:target: ../images/inc1.png
|
||||
:target: /internal-documentation/_images/inc1.png
|
||||
:alt: Overview New incident
|
||||
|
||||
|
||||
@ -81,7 +81,7 @@ Explanation of additional fields and options for Incident Impact “Scheduled Ma
|
||||
For a maintenance, the view looks like as follows:
|
||||
|
||||
.. image:: ../images/inc2.png
|
||||
:target: ../images/inc2.png
|
||||
:target: /internal-documentation/_images/inc2.png
|
||||
:alt: New Incident - details
|
||||
|
||||
In addition to the ones explained above, you have the following fields:
|
||||
@ -108,13 +108,13 @@ How to adjust a minor/major incident or an outage?
|
||||
An incident will look like as follows:
|
||||
|
||||
.. image:: ../images/public_inc1.png
|
||||
:target: ../images/public_inc1.png
|
||||
:target: /internal-documentation/_images/public_inc1.png
|
||||
:alt: published Incident
|
||||
|
||||
By clicking the title (in the example above “Service Impact on ECS”, you can edit/update the incident. The view will look like as follows:
|
||||
|
||||
.. image:: ../images/inc3.png
|
||||
:target: ../images/inc3.png
|
||||
:target: /internal-documentation/_images/inc3.png
|
||||
:alt: Adjust Incident
|
||||
|
||||
|
||||
@ -153,7 +153,7 @@ Go to the Menu, Event History and select the corresponding Incident.
|
||||
|
||||
|
||||
.. image:: ../images/inc4.png
|
||||
:target: ../images/inc4.png
|
||||
:target: /internal-documentation/_images/inc4.png
|
||||
:alt: Adjust Incident
|
||||
|
||||
|
||||
@ -171,7 +171,7 @@ In case an issue will come back, for example, you can reopen the incident.
|
||||
The Message will also be back on status dashboard and look like as follows:
|
||||
|
||||
.. image:: ../images/inc5.png
|
||||
:target: ../images/inc5.png
|
||||
:target: /internal-documentation/_images/inc5.png
|
||||
:alt: Reopen Incident
|
||||
|
||||
Incident changed: (end date has been changed)
|
||||
@ -181,11 +181,11 @@ In case a minor or major issue occured and was triggered by the system, the end
|
||||
**Example:** A minor incident occured during the night and the SDMoD do take care of it during the next business hours, the end date can be adjusted accordingly.
|
||||
|
||||
.. image:: ../images/inc6.png
|
||||
:target: ../images/inc6.png
|
||||
:target: /internal-documentation/_images/inc6.png
|
||||
:alt: Adjust end date of an inc
|
||||
|
||||
This will also be mentioned in the change log of the incident publicly:
|
||||
|
||||
.. image:: ../images/inc_change.png
|
||||
:target: ../images/inc_change.png
|
||||
:alt: Changelog Incident
|
||||
:target: /internal-documentation/_images/inc_change.png
|
||||
:alt: Changelog Incident
|
||||
@ -4,9 +4,9 @@ Look&feel before login
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
look&feel_before
|
||||
look_and_feel_before
|
||||
regions_switch
|
||||
status_services
|
||||
menu/index
|
||||
|
||||
|
||||
|
||||
@ -3,8 +3,8 @@ The look & feel before login
|
||||
|
||||
Before logging-in, the screen will look like as follows:
|
||||
|
||||
.. image:: ../images/look&feel_before.png
|
||||
:target: ../images/look&feel_before.png
|
||||
.. image:: ../images/look_and_feel_before.png
|
||||
:target: /internal-documentation/_images/look_and_feel_before.png
|
||||
:alt: Look&Feel
|
||||
|
||||
There are various options, which will be explained in the next chapters.
|
||||
@ -0,0 +1,17 @@
|
||||
Component Availability
|
||||
---------------------------------------
|
||||
|
||||
The component availability shows the availability of each service each month.
|
||||
The services are categorized and split between eu-de and eu-nl.
|
||||
|
||||
The availability page is also directly reachable via https://status.otc-service.com/availability
|
||||
|
||||
The component availability is impacted by the following status:
|
||||
|
||||
+-------------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| Icon | Explanation |
|
||||
+=============================================================+==============================================================================+
|
||||
| .. image:: ../../images/outage.png | see explanation :ref:`Status of Services <status_services>` |
|
||||
| :target: /internal-documentation/_images/outage.png | |
|
||||
| :alt: Outage | |
|
||||
+-------------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
@ -9,5 +9,5 @@ https://status.otc-service.com/history
|
||||
An example is:
|
||||
|
||||
.. image:: ../../images/event_history.png
|
||||
:target: ../../images/event_history.png
|
||||
:alt: Event History
|
||||
:target: /internal-documentation/_images/event_history.png
|
||||
:alt: Event History
|
||||
@ -0,0 +1,68 @@
|
||||
The menu
|
||||
---------------------------------------
|
||||
|
||||
.. image:: ../../images/menu.png
|
||||
:target: /internal-documentation/_images/menu.png
|
||||
:alt: The menu
|
||||
|
||||
The menu includes:
|
||||
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
| Event History | The event history shows up all past events - even if minor, major issues, |
|
||||
| | outages, or maintenances. |
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
| Component Availability | The component availability shows the availability of a service in the |
|
||||
| | previous months and is the basis for SLA calculation. |
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
| User Manual | Link to the actual version of the user manual. |
|
||||
+---------------------------------+------------------------------------------------------------------------------+
|
||||
|
||||
|
||||
----------
|
||||
|
||||
|
||||
Event history
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The event history shows all past events, sorted by months.
|
||||
|
||||
A direct link exists:
|
||||
https://status.otc-service.com/history
|
||||
|
||||
An example is:
|
||||
|
||||
.. image:: ../../images/event_history.png
|
||||
:target: /internal-documentation/_images/event_history.png
|
||||
:alt: Event History
|
||||
|
||||
|
||||
----------
|
||||
|
||||
|
||||
Component Availability
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The component availability shows the availability of each service each month.
|
||||
The services are categorized and split between eu-de and eu-nl.
|
||||
|
||||
The availability page is also directly reachable via https://status.otc-service.com/availability
|
||||
|
||||
The component availability is impacted by the following status:
|
||||
|
||||
+-------------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| Icon | Explanation |
|
||||
+=============================================================+==============================================================================+
|
||||
| .. image:: ../../images/outage.png | see explanation :ref:`Status of Services <status_services>` |
|
||||
| :target: /internal-documentation/_images/outage.png | |
|
||||
| :alt: Outage | |
|
||||
+-------------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
|
||||
|
||||
----------
|
||||
|
||||
|
||||
User Manual
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The user manual can also be reached directly via the following link:
|
||||
https://docs.otc.t-systems.com/status-dashboard/index.html
|
||||
@ -4,5 +4,5 @@ Switch between regions
|
||||
Clients can easily switch between the services and check their availability by clicking the region:
|
||||
|
||||
.. image:: ../images/region_switch.png
|
||||
:target: ../images/region_switch.png
|
||||
:alt: Switch regions
|
||||
:target: /internal-documentation/_images/region_switch.png
|
||||
:alt: Switch regions
|
||||
@ -0,0 +1,41 @@
|
||||
.. _status_services:
|
||||
|
||||
Status of services
|
||||
------------------
|
||||
|
||||
The services can vary between the following status:
|
||||
|
||||
|
||||
+--------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| Icon | Explanation |
|
||||
+========================================================+==============================================================================+
|
||||
| .. image:: ../images/green.png | - All services are running fine |
|
||||
| :target: /internal-documentation/_images/green.png | |
|
||||
| :alt: Operational | |
|
||||
+--------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/blue.png | - A maintenance is planned or ongoing for a service |
|
||||
| :target: /internal-documentation/_images/blue.png | - A maintenance is triggered by the SDMoD |
|
||||
| :alt: Maintenance | |
|
||||
+--------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/yellow.png | - A minor issue occurred. The service is available but may have restrictions |
|
||||
| :target: /internal-documentation/_images/yellow.png | or slow response. |
|
||||
| :alt: Minor Issue | - A minor issue can either be triggered by the system autoamtically or |
|
||||
| | by SDMoD |
|
||||
| | |
|
||||
| | |
|
||||
+--------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/red.png | - A major issue occurred. The service may be available, but the |
|
||||
| :target: /internal-documentation/_images/red.png | responsiveness is affected and may lead to interruptions on customer side. |
|
||||
| :alt: Major Issue | - A major issue can either be triggered by the system autoamtically or by |
|
||||
| | SDMoD |
|
||||
| | |
|
||||
| | |
|
||||
| | |
|
||||
+--------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
| .. image:: ../images/outage.png | - A service is not available anymore at all. |
|
||||
| :target: /internal-documentation/_images/outage.png | - An outage can **only** be triggered by SDMoD. This will never happen |
|
||||
| :alt: Outage | automatically by the system |
|
||||
| | - **Only** outages are SLA relevant and do have impact to the component |
|
||||
| | availability |
|
||||
+--------------------------------------------------------+------------------------------------------------------------------------------+
|
||||
|
||||
@ -14,6 +14,9 @@ Prerequistes for new demands
|
||||
- Functional testing must be completed by QA engineer in the service squad
|
||||
- Regression testing must exist and reports must be available
|
||||
|
||||
.. warning::
|
||||
Ecosystem Squad is not relying on pre-PROD nor checking features on pre-PROD therefore make sure that demanded feature has been released to PROD already.
|
||||
|
||||
Once the prerequistes are met and issue is created on github repository, Ecosystem squad needs several days or weeks based on the complexity of the new demand to accomplish the task.
|
||||
|
||||
To avoid delays caused by not enough resources, the new demands should be identified and addressed upfront during PIP planning by the service squads or product management.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user