Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scaleway-terraform-modules/terraform-scaleway-domain

Manage Domains on Scaleway with Terraform.
https://github.com/scaleway-terraform-modules/terraform-scaleway-domain

dns domain-name scaleway tem terraform-module

Last synced: 6 days ago
JSON representation

Manage Domains on Scaleway with Terraform.

Awesome Lists containing this project

README

        

# Terraform / Scaleway

## Purpose

This repository is used to manage a domain on scaleway using terraform.
Beware this module *can not* be used to register a new domain. Existing domains must first be imported manually after initializing the terraform project. Refer to examples for more informations.

## Usage

- Setup the [scaleway provider](https://www.terraform.io/docs/providers/scaleway/index.html) in your tf file.
- Include this module in your tf file. Refer to [documentation](https://www.terraform.io/docs/modules/sources.html#generic-git-repository).

```hcl
module "my_domain" {
source = "scaleway-terraform-modules/domain/scaleway"
version = "1.0.2"

}
```

## Requirements

| Name | Version |
|------|---------|
| [terraform](#requirement_terraform) | >= 0.13 |
| [scaleway](#requirement_scaleway) | >= 2.40.0 |

## Resources

| Name | Type |
|------|------|
| [scaleway_domain_record.dkim](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/domain_record) | resource |
| [scaleway_domain_record.dmarc](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/domain_record) | resource |
| [scaleway_domain_record.mx](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/domain_record) | resource |
| [scaleway_domain_record.spf](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/domain_record) | resource |
| [scaleway_domain_zone.this](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/domain_zone) | resource |
| [scaleway_tem_domain.this](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/tem_domain) | resource |
| [scaleway_tem_domain_validation.this](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/tem_domain_validation) | resource |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [domain](#input_domain) | Name of the domain to manage. | `string` | n/a | yes |
| [mx_servers](#input_mx_servers) | Informations regarding MX servers. **MX servers are required to enable Transactional Emails.** | ```list(object({ address = string priority = number }))``` | ```[ { "address": "blackhole.scw-tem.cloud.", "priority": 10 } ]``` | no |
| [project_id](#input_project_id) | ID of the project the domain is associated with. Ressource will be created in the project set at the provider level if null. | `string` | `null` | no |
| [setup_tem](#input_setup_tem) | Whether to create a Transaction Email service. **Beware that the service is only available in region `fr-par` at the moment.** | `bool` | `false` | no |
| [subdomain](#input_subdomain) | Name of the subdomain to manage. | `string` | `""` | no |

## Outputs

| Name | Description |
|------|-------------|
| [dns_zone](#output_dns_zone) | DNS Zone of the domain. |
| [tem_id](#output_tem_id) | ID of the Transaction Email Domain. |
| [tem_reputation](#output_tem_reputation) | Reputation of the Transaction Email Domain. |
| [tem_status](#output_tem_status) | Status of the Transaction Email Domain. |
| [tem_validated](#output_tem_validated) | Indicates if the domain has been verified for email sending. |

## Authors

Module is maintained with help from [the community](https://github.com/scaleway-terraform-modules/terraform-scaleway-domain/graphs/contributors).

## License

Mozilla Public License 2.0 Licensed. See [LICENSE](https://github.com/scaleway-terraform-modules/terraform-scaleway-domain/tree/master/LICENSE) for full details.