diff --git a/doc/source/status_dashboard/SDMoD/images/blue.png b/doc/source/status_dashboard/SDMoD/images/blue.png new file mode 100644 index 0000000..e52c89d Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/blue.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/event_history.png b/doc/source/status_dashboard/SDMoD/images/event_history.png new file mode 100644 index 0000000..bf67197 Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/event_history.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/green.png b/doc/source/status_dashboard/SDMoD/images/green.png new file mode 100644 index 0000000..a80eee7 Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/green.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/inc1.png b/doc/source/status_dashboard/SDMoD/images/inc1.png new file mode 100644 index 0000000..2f4abed Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/inc1.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/inc2.png b/doc/source/status_dashboard/SDMoD/images/inc2.png new file mode 100644 index 0000000..02c51aa Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/inc2.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/inc3.png b/doc/source/status_dashboard/SDMoD/images/inc3.png new file mode 100644 index 0000000..984a3ad Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/inc3.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/inc4.png b/doc/source/status_dashboard/SDMoD/images/inc4.png new file mode 100644 index 0000000..fc6cff3 Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/inc4.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/inc5.png b/doc/source/status_dashboard/SDMoD/images/inc5.png new file mode 100644 index 0000000..71274b2 Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/inc5.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/inc6.png b/doc/source/status_dashboard/SDMoD/images/inc6.png new file mode 100644 index 0000000..3b673ac Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/inc6.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/inc_change.png b/doc/source/status_dashboard/SDMoD/images/inc_change.png new file mode 100644 index 0000000..d36da4b Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/inc_change.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/look&feel_before.png b/doc/source/status_dashboard/SDMoD/images/look&feel_before.png new file mode 100644 index 0000000..b743efa Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/look&feel_before.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/menu.png b/doc/source/status_dashboard/SDMoD/images/menu.png new file mode 100644 index 0000000..518a69e Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/menu.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/menu2.png b/doc/source/status_dashboard/SDMoD/images/menu2.png new file mode 100644 index 0000000..d55c050 Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/menu2.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/outage.png b/doc/source/status_dashboard/SDMoD/images/outage.png new file mode 100644 index 0000000..482dc65 Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/outage.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/public_inc1.png b/doc/source/status_dashboard/SDMoD/images/public_inc1.png new file mode 100644 index 0000000..261a99d Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/public_inc1.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/red.png b/doc/source/status_dashboard/SDMoD/images/red.png new file mode 100644 index 0000000..d7a92a3 Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/red.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/region_switch.png b/doc/source/status_dashboard/SDMoD/images/region_switch.png new file mode 100644 index 0000000..a47481f Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/region_switch.png differ diff --git a/doc/source/status_dashboard/SDMoD/images/yellow.png b/doc/source/status_dashboard/SDMoD/images/yellow.png new file mode 100644 index 0000000..6180cdb Binary files /dev/null and b/doc/source/status_dashboard/SDMoD/images/yellow.png differ diff --git a/doc/source/status_dashboard/SDMoD/index.rst b/doc/source/status_dashboard/SDMoD/index.rst new file mode 100644 index 0000000..8747b40 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/index.rst @@ -0,0 +1,9 @@ +###################### +SDMoD Overview +###################### + +.. toctree:: + :maxdepth: 1 + + look&feel_before/index + look&feel_after/index \ No newline at end of file diff --git a/doc/source/status_dashboard/SDMoD/look&feel_after/get_sdmod_login.rst b/doc/source/status_dashboard/SDMoD/look&feel_after/get_sdmod_login.rst new file mode 100644 index 0000000..ffa2a37 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_after/get_sdmod_login.rst @@ -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 \ No newline at end of file diff --git a/doc/source/status_dashboard/SDMoD/look&feel_after/index.rst b/doc/source/status_dashboard/SDMoD/look&feel_after/index.rst new file mode 100644 index 0000000..91abc40 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_after/index.rst @@ -0,0 +1,14 @@ +=========================== +Look&Feel after login +=========================== + +.. toctree:: + :maxdepth: 1 + + get_sdmod_login + new_incident + + + + + diff --git a/doc/source/status_dashboard/SDMoD/look&feel_after/new_incident.rst b/doc/source/status_dashboard/SDMoD/look&feel_after/new_incident.rst new file mode 100644 index 0000000..87ddeb9 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_after/new_incident.rst @@ -0,0 +1,191 @@ +Create a new incident +--------------------------------------- + +After the login, the menu bar looks like the following: + +.. image:: ../images/menu2.png + :target: ../images/menu2.png + :alt: Menu after login + +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 + :alt: Overview New incident + + + +Fields and Options +~~~~~~~~~~~~~~~~~~~~~~ + + + ++--------------------------------------+------------------------------------------------------------------------------+ +| Field | Explanation | ++======================================+==============================================================================+ +| Incident title | - Enter a valid title for the Incident. In general please differentiate | +| | between Incident and Maintenance. | +| | - Example Incident: Service Impact | +| | - Example Maintenance: Scheduled Maintenance | ++--------------------------------------+------------------------------------------------------------------------------+ +| Incident Impact | You can select: | +| | | +| | - Scheduled Maintenance. See explanation of additional fields here | +| | - Minor incident | +| | - Major incident | +| | - Service Outage | ++--------------------------------------+------------------------------------------------------------------------------+ +| Affected services | - select the corresponding affected service(s) for a maintenance or Incident | +| | | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ +| Start | Enter the start date of the incident | +| | | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ + + + + + +Definitions of minor / major / outage +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + + ++--------------------------------------+------------------------------------------------------------------------------+ +| Definition | Explanation | ++======================================+==============================================================================+ +| Minor | - is triggered by the metric where the performance or the successrate | +| | decreased under the defined theresold | +| | | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ +| Incident Impact | - all API requests within a specific time frame are invalid due to timeout | +| | or error resonse codes. | +| | | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ +| Outage | - Triggered by SDMoD manually as a service outage | +| | - will never be triggered by the system automatically | +| | - is the only definition which do have impact to the | +| | `availability ` | ++--------------------------------------+------------------------------------------------------------------------------+ + + +Explanation of additional fields and options for Incident Impact “Scheduled Maintenance” +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +For a maintenance, the view looks like as follows: + +.. image:: ../images/inc2.png + :target: ../images/inc2.png + :alt: New Incident - details + +In addition to the ones explained above, you have the following fields: + ++--------------------------------------+------------------------------------------------------------------------------+ +| Definition | Explanation | ++======================================+==============================================================================+ +| Maintenance Description | - Describe the reason and the impact of the maintenance. The following | +| | sentence will be added automatically: *“In case of issues afterwards, | +| | please contact the Open Telekom Cloud Service Desk.”* | +| | | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ +| End | - End date of the maintenance. The Start field describes the start date | +| | of the maintenance. **Please note:** the time zone in the frontend | +| | will be detected from the browser. | +| | | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ + +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 + :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 + :alt: Adjust Incident + + +The adjustable options are: + ++--------------------------------------+------------------------------------------------------------------------------+ +| Definition | Explanation | ++======================================+==============================================================================+ +| Incident Title | - You can adjust the title – if needed | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ +| Incident Impact | You can raise or lower the Impact. Options are: | +| | - Minor incident (i.e., performance impact) | +| | - Major incident | +| | - Service outage: the published box in the frontend will be displayed in red | ++--------------------------------------+------------------------------------------------------------------------------+ +| Update messgae | - Update the Incident with the latest status/information | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ +| Update status | The options are: | +| | - Analyzing incident (problem not known yet) | +| | - Fixing incident (problem identified, working on fix) | +| | - Observing fix (fix deployed, watching recovery) | +| | - Incident resolved (service is fully available. Done) | ++--------------------------------------+------------------------------------------------------------------------------+ +| Next update by | - Date when the next update will be provided | +| | | ++--------------------------------------+------------------------------------------------------------------------------+ + + +Can an already closed incident re-opened? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Yes. It doesn´t matter if the incident was triggered automatically by the dashboard or created manually. In both cases, the incident can be adjusted. +Go to the Menu, Event History and select the corresponding Incident. + + +.. image:: ../images/inc4.png + :target: ../images/inc4.png + :alt: Adjust Incident + + +You can update by following options: + + - Incident reopened (resolved incident has been reopened) + - Incident changed: (end date has been changed) + + +Incident reopened (resolved incident has been reopened) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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 + :alt: Reopen Incident + +Incident changed: (end date has been changed) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In case a minor or major issue occured and was triggered by the system, the end date can be adjusted accordingly to the correct time. +**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 + :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 \ No newline at end of file diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/index.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/index.rst new file mode 100644 index 0000000..1ca5f9e --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/index.rst @@ -0,0 +1,12 @@ +Look&feel before login +###################### + +.. toctree:: + :maxdepth: 1 + + look&feel_before + regions_switch + status_services + menu/index + + \ No newline at end of file diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/look&feel_before.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/look&feel_before.rst new file mode 100644 index 0000000..fccd34c --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/look&feel_before.rst @@ -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. diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/menu/component_availability.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/component_availability.rst new file mode 100644 index 0000000..8db2fdd --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/component_availability.rst @@ -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 ` | +| :target: ../../imags/outage.png | | +| :alt: Outage | | ++--------------------------------------+------------------------------------------------------------------------------+ \ No newline at end of file diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/menu/event_history.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/event_history.rst new file mode 100644 index 0000000..c4dee70 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/event_history.rst @@ -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 \ No newline at end of file diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/menu/index.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/index.rst new file mode 100644 index 0000000..be770a2 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/index.rst @@ -0,0 +1,11 @@ +###################### +The menu +###################### + +.. toctree:: + :maxdepth: 1 + + menu + event_history + component_availability + user_manual diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/menu/menu.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/menu.rst new file mode 100644 index 0000000..6426a7a --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/menu.rst @@ -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. | ++---------------------------------+------------------------------------------------------------------------------+ + diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/menu/user_manual.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/user_manual.rst new file mode 100644 index 0000000..4d15326 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/menu/user_manual.rst @@ -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 diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/regions_switch.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/regions_switch.rst new file mode 100644 index 0000000..320eadc --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/regions_switch.rst @@ -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 \ No newline at end of file diff --git a/doc/source/status_dashboard/SDMoD/look&feel_before/status_services.rst b/doc/source/status_dashboard/SDMoD/look&feel_before/status_services.rst new file mode 100644 index 0000000..3290047 --- /dev/null +++ b/doc/source/status_dashboard/SDMoD/look&feel_before/status_services.rst @@ -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 | ++--------------------------------------+------------------------------------------------------------------------------+ + diff --git a/doc/source/status_dashboard/index.rst b/doc/source/status_dashboard/index.rst index e6f4fce..98b2c9d 100644 --- a/doc/source/status_dashboard/index.rst +++ b/doc/source/status_dashboard/index.rst @@ -6,3 +6,4 @@ Status Dashboard Internal Documentation :maxdepth: 2 sd2_training/index + SDMoD/index