small-typo fix

Reviewed-by: otcbot <otcbot@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>

doc/requirements.txt

@@ -9,3 +9,4 @@ otc-sphinx-directives>=0.1.0
 sphinx-minify>=0.0.1 # Apache-2.0
 git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
 setuptools
+gitpython

doc/source/apimon/apimon_training/workflow.rst

@@ -5,7 +5,7 @@ ApiMon Flow Process
 
 
 .. image:: training_images/apimon_data_flow.svg
-   :target: training_images/apimon_data_flow.svg
+   :target: /_images/apimon_data_flow.svg
    :alt: apimon_data_flow
 
 

doc/source/conf.py

@@ -16,6 +16,8 @@
 
 import os
 import sys
+from git import Repo
+from datetime import datetime
 
 extensions = [
     'otcdocstheme',
@@ -111,3 +113,9 @@ html_copy_source = False
 
 # -- Options for PDF output --------------------------------------------------
 latex_documents = []
+
+# Get the Git commit values for last updated timestamp on each page
+repo = Repo(search_parent_directories=True)
+commit = repo.head.commit
+current_commit_hash = commit.hexsha
+current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')

doc/source/helpcenter/hc_ops/index.rst

@@ -6,3 +6,4 @@ Helpcenter Operations
    :maxdepth: 2
 
    backstage_add_repo
+   service_based_view

doc/source/helpcenter/hc_ops/service_based_view.rst

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

doc/source/helpcenter/helpcenter_training/faq/how_to_update_a_landing_page.rst

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

doc/source/index.rst

@@ -11,3 +11,4 @@ Internal Documentation
    Helpcenter <helpcenter/index>
    Circle Partner Navigator <cpn/index>
    otcdocstheme <otcdocstheme/index>
+   OTC Terraform Provider <terraform/index>

doc/source/status_dashboard/SDMoD/index.rst

@@ -0,0 +1,9 @@
+######################
+SDMoD Overview
+######################
+
+.. toctree::
+   :maxdepth: 1
+
+   look_and_feel_before/index
+   look_and_feel_after/index

doc/source/status_dashboard/SDMoD/look_and_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

doc/source/status_dashboard/SDMoD/look_and_feel_after/index.rst

@@ -0,0 +1,14 @@
+===========================
+Look&Feel after login
+===========================
+
+.. toctree::
+   :maxdepth: 1
+
+   get_sdmod_login
+   new_incident
+
+
+
+
+

doc/source/status_dashboard/SDMoD/look_and_feel_before/index.rst

@@ -0,0 +1,12 @@
+Look&feel before login
+######################
+
+.. toctree::
+   :maxdepth: 1
+
+   look_and_feel_before
+   regions_switch
+   status_services
+   menu/index
+
+   

doc/source/status_dashboard/SDMoD/look_and_feel_before/look_and_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_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.

doc/source/status_dashboard/SDMoD/look_and_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 <status_services>`                  |
+|    :target: /internal-documentation/_images/outage.png      |                                                                              |
+|    :alt: Outage                                             |                                                                              |
++-------------------------------------------------------------+------------------------------------------------------------------------------+

doc/source/status_dashboard/SDMoD/look_and_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: /internal-documentation/_images/event_history.png
+   :alt: Event History

doc/source/status_dashboard/SDMoD/look_and_feel_before/menu/index.rst

@@ -0,0 +1,11 @@
+######################
+The menu
+######################
+
+.. toctree::
+   :maxdepth: 1
+
+   menu
+   event_history
+   component_availability
+   user_manual

doc/source/status_dashboard/SDMoD/look_and_feel_before/menu/menu.rst

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

doc/source/status_dashboard/SDMoD/look_and_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 

doc/source/status_dashboard/SDMoD/look_and_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: /internal-documentation/_images/region_switch.png
+   :alt: Switch regions

doc/source/status_dashboard/SDMoD/look_and_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: /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                                                               |
++--------------------------------------------------------+------------------------------------------------------------------------------+
+

doc/source/status_dashboard/index.rst

@@ -6,3 +6,4 @@ Status Dashboard Internal Documentation
    :maxdepth: 2
 
    sd2_training/index
+   SDMoD/index

doc/source/terraform/contact.rst

@@ -0,0 +1,10 @@
+Contact - Whom to address for Feedback?
+=======================================
+
+In case you have any feedback, proposals or found any issues regarding the OTC Terraform provider, you can address them in the corresponding GitHub repository.
+
+Issues or feedback regarding the **OTC Terrarform provider** as well as new feature requests can be addressed by filling an issue on the Github repository under https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues
+
+If a documentation for OTC Terraform provider is incomplete or the new supported services are not described, please open a ticket on the Github repository: https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues
+
+For general questions you can write an E-Mail to the `DL OTC Ecosystem Squad <mailto:OTC_Ecosystem_Squad@t-systems.com>`_.

doc/source/terraform/getting_started.rst

@@ -0,0 +1,70 @@
+===============
+Getting Started
+===============
+
+
+Prerequisite:
+
+ - Install terraform following the guide at https://developer.hashicorp.com/terraform/install
+
+
+1. Add [opentelekomcloud/opentelekomcloud](https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs) to your `required_providers`.
+
+.. code-block::
+
+    # provider.tf
+    terraform {
+       required_providers {
+          opentelekomcloud = {
+             source = "opentelekomcloud/opentelekomcloud"
+             version = ">= 1.23.2"
+          }
+       }
+    }
+
+
+2. Run `terraform init -upgrade` to download the provider.
+3. Add the provider and supply your `tenant_name` and `domain_name` for minimum configuration.
+
+.. code-block::
+
+    # provider.tf
+    provider "opentelekomcloud" {
+       # OpenTelekomCloud Provider Documentation:
+       # https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs
+       # domain_name = "..."
+       # tenant_name = "..."
+       # auth_url    = "https://iam.eu-de.otc.t-systems.com/v3"
+       # user_name   = "..."
+       # password    = "..."
+    }
+
+5. [Authenticate](https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs#authentication) either by providing `user_name` and `password` in the previous file or setting them as environment variables.
+
+.. code-block::
+
+    # Linux
+    OS_USERNAME="<your_username>"
+    OS_PASSWORD="<your_password"
+    # Windows
+    $env:OS_USERNAME="<your_username>"
+    $env:OS_PASSWORD="<your_password"
+
+7. Create your first resource.
+
+.. code-block::
+
+    # main.tf
+
+    # Create an Elastic Cloud Server resource
+    resource "opentelekomcloud_compute_instance_v2" "debian_ecs" {
+       name        = "debian_ecs"
+       image_name  = "Standard_Debian_12_latest"
+       flavor_name = "s3.medium.1"
+       key_pair        = "kp_ecs"
+       security_groups = ["default"]
+       network {
+          name = "network_ecs"
+       }
+    }
+

doc/source/terraform/index.rst

@@ -0,0 +1,14 @@
+================================
+Terraform Internal Documentation
+================================
+
+.. toctree::
+   :maxdepth: 2
+
+   introduction
+   getting_started
+   process_overview
+   supported_services
+   release_notes
+   contact
+

doc/source/terraform/introduction.rst

@@ -0,0 +1,11 @@
+============
+Introduction
+============
+
+Terraform is an infrastructure as code tool that lets you build, change, and version cloud and on-prem resources safely and efficiently.
+
+A provider in Terraform is a plugin that enables interaction with an API. This includes Cloud providers and Software-as-a-service providers.
+
+The Open Telekom Cloud provider is used to interact with the many resources supported by OpenTelekomCloud. It's open-source project hosted at Github repository https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud.
+
+

doc/source/terraform/process_overview.rst

@@ -0,0 +1,24 @@
+================
+Process Overview
+================
+
+Open Telekom Cloud Terraform Provider is developed by Ecosystem squad and it's open-sourced on Github at https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/
+
+Issues or new feature requests are addressed by filling an issue on the Github repository under https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues
+
+Prerequistes for new demands
+============================
+
+ - Service or feature must be released on PROD environment
+ - Documentation for service or feature must be released on public HelpCenter portal
+ - 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.
+
+The accomplished demands result in new OTC Terraform provider release available at https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest. The release notes describe the changes at https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest

doc/source/terraform/release_notes.rst

@@ -0,0 +1,6 @@
+=============
+Release Notes
+=============
+
+Each OTC Terraform provider release is supplied with release notes which are described in detail at https://docs.otc.t-systems.com/releasenotes/terraform-provider-opentelekomcloud/
+Release notes contain information about new services, features, bug fixes and/or end-of-life features.

doc/source/terraform/supported_services.rst

@@ -0,0 +1,7 @@
+==================
+Supported Services
+==================
+
+Actual list of the supported services, data sources and resources can be found at https://docs.otc.t-systems.com/terraform-provider-opentelekomcloud/ or at https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs.
+
+Documentation also contains example usage for all supported services.

zuul.yaml

@@ -1,3 +1,4 @@
+---
 - project:
     merge-mode: squash-merge
     default-branch: main