Adding SDMoD documentation for SD2
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Haas, Robert <robert.haas@t-systems.com> Co-committed-by: Haas, Robert <robert.haas@t-systems.com>
BIN
doc/source/status_dashboard/SDMoD/images/blue.png
Normal file
After Width: | Height: | Size: 1.0 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/event_history.png
Normal file
After Width: | Height: | Size: 25 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/green.png
Normal file
After Width: | Height: | Size: 668 B |
BIN
doc/source/status_dashboard/SDMoD/images/inc1.png
Normal file
After Width: | Height: | Size: 29 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/inc2.png
Normal file
After Width: | Height: | Size: 42 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/inc3.png
Normal file
After Width: | Height: | Size: 37 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/inc4.png
Normal file
After Width: | Height: | Size: 48 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/inc5.png
Normal file
After Width: | Height: | Size: 19 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/inc6.png
Normal file
After Width: | Height: | Size: 8.1 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/inc_change.png
Normal file
After Width: | Height: | Size: 3.6 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/look&feel_before.png
Normal file
After Width: | Height: | Size: 66 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/menu.png
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/menu2.png
Normal file
After Width: | Height: | Size: 1.3 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/outage.png
Normal file
After Width: | Height: | Size: 616 B |
BIN
doc/source/status_dashboard/SDMoD/images/public_inc1.png
Normal file
After Width: | Height: | Size: 21 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/red.png
Normal file
After Width: | Height: | Size: 607 B |
BIN
doc/source/status_dashboard/SDMoD/images/region_switch.png
Normal file
After Width: | Height: | Size: 1.2 KiB |
BIN
doc/source/status_dashboard/SDMoD/images/yellow.png
Normal file
After Width: | Height: | Size: 545 B |
9
doc/source/status_dashboard/SDMoD/index.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
######################
|
||||||
|
SDMoD Overview
|
||||||
|
######################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
look&feel_before/index
|
||||||
|
look&feel_after/index
|
@ -0,0 +1,10 @@
|
|||||||
|
How to get a SDMoD login
|
||||||
|
=======================================
|
||||||
|
|
||||||
|
In general, you can login via your keycloak generated user or your GitHub user.
|
||||||
|
|
||||||
|
In case you need to get access, please raise a ticket via "Internal Incident" towards Ecosystem squad:
|
||||||
|
|
||||||
|
https://jira.tsi-dev.otc-service.com/servicedesk/customer/portal/4
|
||||||
|
|
||||||
|
Master Component must be: ECOSYSTEM - Ecosystem
|
14
doc/source/status_dashboard/SDMoD/look&feel_after/index.rst
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
===========================
|
||||||
|
Look&Feel after login
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
get_sdmod_login
|
||||||
|
new_incident
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
12
doc/source/status_dashboard/SDMoD/look&feel_before/index.rst
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
Look&feel before login
|
||||||
|
######################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
look&feel_before
|
||||||
|
regions_switch
|
||||||
|
status_services
|
||||||
|
menu/index
|
||||||
|
|
||||||
|
|
@ -0,0 +1,10 @@
|
|||||||
|
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
|
||||||
|
: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: ../../imags/outage.png | |
|
||||||
|
| :alt: Outage | |
|
||||||
|
+--------------------------------------+------------------------------------------------------------------------------+
|
@ -0,0 +1,13 @@
|
|||||||
|
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: ../../images/event_history.png
|
||||||
|
:alt: Event History
|
@ -0,0 +1,11 @@
|
|||||||
|
######################
|
||||||
|
The menu
|
||||||
|
######################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
menu
|
||||||
|
event_history
|
||||||
|
component_availability
|
||||||
|
user_manual
|
@ -0,0 +1,19 @@
|
|||||||
|
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. |
|
||||||
|
+---------------------------------+------------------------------------------------------------------------------+
|
||||||
|
|
@ -0,0 +1,6 @@
|
|||||||
|
User manual
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
The user manual can also be reached directly via the following link:
|
||||||
|
|
||||||
|
https://docs.otc.t-systems.com/status-dashboard/index.html
|
@ -0,0 +1,8 @@
|
|||||||
|
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
|
@ -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: ../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 |
|
||||||
|
+--------------------------------------+------------------------------------------------------------------------------+
|
||||||
|
|
@ -6,3 +6,4 @@ Status Dashboard Internal Documentation
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
sd2_training/index
|
sd2_training/index
|
||||||
|
SDMoD/index
|
||||||
|