From ecd76023b9012ae2ddaa27bb2e0cecebc557bae4 Mon Sep 17 00:00:00 2001
From: "Hasko, Vladimir" <vladimir.hasko@t-systems.com>
Date: Tue, 10 Sep 2024 09:33:34 +0000
Subject: [PATCH] adding terraform chapter

Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
---
 doc/source/index.rst                        |  1 +
 doc/source/terraform/contact.rst            | 10 +++
 doc/source/terraform/getting_started.rst    | 70 +++++++++++++++++++++
 doc/source/terraform/index.rst              | 14 +++++
 doc/source/terraform/introduction.rst       | 11 ++++
 doc/source/terraform/process_overview.rst   | 21 +++++++
 doc/source/terraform/release_notes.rst      |  6 ++
 doc/source/terraform/supported_services.rst |  7 +++
 8 files changed, 140 insertions(+)
 create mode 100644 doc/source/terraform/contact.rst
 create mode 100644 doc/source/terraform/getting_started.rst
 create mode 100644 doc/source/terraform/index.rst
 create mode 100644 doc/source/terraform/introduction.rst
 create mode 100644 doc/source/terraform/process_overview.rst
 create mode 100644 doc/source/terraform/release_notes.rst
 create mode 100644 doc/source/terraform/supported_services.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index a346b05..354a44d 100644
--- a/doc/source/index.rst
+++ b/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>
diff --git a/doc/source/terraform/contact.rst b/doc/source/terraform/contact.rst
new file mode 100644
index 0000000..47222ae
--- /dev/null
+++ b/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>`_.
diff --git a/doc/source/terraform/getting_started.rst b/doc/source/terraform/getting_started.rst
new file mode 100644
index 0000000..0bd8e75
--- /dev/null
+++ b/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"
+       }
+    }
+
diff --git a/doc/source/terraform/index.rst b/doc/source/terraform/index.rst
new file mode 100644
index 0000000..1a8bb94
--- /dev/null
+++ b/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
+
diff --git a/doc/source/terraform/introduction.rst b/doc/source/terraform/introduction.rst
new file mode 100644
index 0000000..2a0b9f5
--- /dev/null
+++ b/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.
+
+
diff --git a/doc/source/terraform/process_overview.rst b/doc/source/terraform/process_overview.rst
new file mode 100644
index 0000000..a146e3e
--- /dev/null
+++ b/doc/source/terraform/process_overview.rst
@@ -0,0 +1,21 @@
+================
+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
+
+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
diff --git a/doc/source/terraform/release_notes.rst b/doc/source/terraform/release_notes.rst
new file mode 100644
index 0000000..2be0eb9
--- /dev/null
+++ b/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.
diff --git a/doc/source/terraform/supported_services.rst b/doc/source/terraform/supported_services.rst
new file mode 100644
index 0000000..7746c02
--- /dev/null
+++ b/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.