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 Circle Partner Navigator otcdocstheme + OTC Terraform Provider diff --git a/doc/source/terraform/contact.rst b/doc/source/terraform/contact.rst new file mode 100644 index 0000000..0115db8 --- /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 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 `_. diff --git a/doc/source/terraform/getting_started.rst b/doc/source/terraform/getting_started.rst new file mode 100644 index 0000000..44b7ad4 --- /dev/null +++ b/doc/source/terraform/getting_started.rst @@ -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="" + OS_PASSWORD="