generated from professional-service-best-practices/best-practice-template
64 lines
No EOL
2.4 KiB
Markdown
64 lines
No EOL
2.4 KiB
Markdown
# STACKIT Service Prefixes Module
|
|
|
|
## Overview
|
|
|
|
This repository provides a Terraform Module to manage Route Tables to access STACKIT Managed Services like SKE, Load Balancers and S3 Object Storage.
|
|
|
|
## Prerequisites
|
|
|
|
Before using this template, ensure you have the following:
|
|
|
|
* **Tools**:
|
|
* Terraform version `1.5.7` or higher
|
|
* Git
|
|
* **Access & Permissions**:
|
|
* STACKIT Service Account with permissions on a STACKIT Route Table & Network Area
|
|
* STACKIT provider credentials configured
|
|
|
|
## How to Use
|
|
|
|
Follow these steps to implement the template:
|
|
|
|
1. **Select the Git Branch that fits your use case**
|
|
There are Branches for every supported product and region
|
|
|
|
2. **Configure the Terrafom Module:**
|
|
* Paste the following code block in the `provider.tf` file see the opetions in **Configuration** section below.
|
|
```terraform
|
|
module "stackit_service_routing_table" {
|
|
source = "git@ssh.professional-service.git.onstackit.cloud:professional-service-best-practices/stackit-service-prefixes.git?ref=eu01-s3"
|
|
stackit_org_id = "0000-0000-00000-00000-00000"
|
|
stackit_sna_id = "0000-0000-00000-00000-00000"
|
|
routing_table_name = "ske-rt"
|
|
dns_server = "9.9.9.9"
|
|
default_gateway = "172.21.13.2"
|
|
}
|
|
```
|
|
|
|
3. **Initialize and apply:**
|
|
```bash
|
|
terraform init
|
|
terraform plan
|
|
terraform apply
|
|
```
|
|
## Configuration
|
|
|
|
The following variables can be configured.
|
|
|
|
| Variable Name | Description | Type | Default Value | Required |
|
|
|---------------|---------------------------------------------|----------|---------------|----------|
|
|
| `stackit_org_id` | The STACKIT organization ID. | `string` | `null` | Yes |
|
|
| `stackit_sna_id` | The STACKIT Network Area ID. | `string` | `null` | Yes |
|
|
| `routing_table_name` | Name of the Routing Tabel | `string` | `null` | Yes |
|
|
| `dns_server` | Public DNS Server for the SKE Network| `string` | `null` | Yes (If SKE or LB is selected) |
|
|
| `default_gateway` | Default Gateway for the DNS Server | `string` | `null` | Yes (If SKE or LB is selected) |
|
|
|
|
### Dependencies
|
|
|
|
This template relies on the following pinned versions:
|
|
|
|
* **Provider STACKIT**: `~> 0.69.0`
|
|
|
|
## Changelog
|
|
|
|
All notable changes to this project are documented in the `CHANGELOG.md` file. |