adding terraform chapter

This commit is contained in:
vladimirhasko 2024-09-09 23:57:05 +00:00
parent 8b5c6fa1c3
commit d73748ea91
8 changed files with 141 additions and 0 deletions

View File

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

View File

@ -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 filing 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 `Ecosystems Squad <mailto:dl-pbcotcdeleco@t-systems.com>`_.

View File

@ -0,0 +1,71 @@
===============
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"
}
}

View File

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

View File

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

View File

@ -0,0 +1,20 @@
================
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 filing an issue on the Github repository under https://github.com/opentelekomcloud/terraform-provider-opentelekomcloud/issues
The following prerequisites must be met in case of new demands:
- Service or service feature must be released on PROD environment
- Documentation for service or service 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

View File

@ -0,0 +1,7 @@
=============
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 service and service features, bug fixes or enf-of-life features.

View File

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