Skip to content

Commit f992294

Browse files
committed
chore(doc): Add terraform-docs config file and create Readme file.
1 parent 36c872e commit f992294

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

.terraform-docs.yaml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
formatter: "markdown table"
2+
3+
header-from: main.tf
4+
footer-from: ""
5+
6+
recursive:
7+
enabled: false
8+
9+
sections:
10+
hide: ["providers"]
11+
12+
output:
13+
file: "README.md"
14+
mode: inject
15+
template: |-
16+
<!-- BEGIN_TF_DOCS -->
17+
{{ .Content }}
18+
<!-- END_TF_DOCS -->
19+
20+
output-values:
21+
enabled: false
22+
from: ""
23+
24+
sort:
25+
enabled: true
26+
by: required
27+
28+
settings:
29+
anchor: true
30+
default: true
31+
escape: false
32+
hide-empty: true
33+
html: false
34+
indent: 2
35+
required: true
36+
sensitive: true
37+
type: true

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Terraform / Scaleway
2+
3+
## Purpose
4+
5+
This repository is used to manage a Redis cluster on scaleway using terraform.
6+
7+
## Usage
8+
9+
- Setup the [scaleway provider](https://www.terraform.io/docs/providers/scaleway/index.html) in your tf file.
10+
- Include this module in your tf file. Refer to [documentation](https://www.terraform.io/docs/modules/sources.html#generic-git-repository).
11+
12+
```hcl
13+
module "my_cluster" {
14+
source = "scaleway-terraform-modules/redis/scaleway"
15+
version = "0.0.1"
16+
17+
}
18+
```
19+
20+
<!-- BEGIN_TF_DOCS -->
21+
## Requirements
22+
23+
| Name | Version |
24+
|------|---------|
25+
| <a name="requirement_terraform"></a> [terraform](#requirement_terraform) | >= 0.13 |
26+
| <a name="requirement_scaleway"></a> [scaleway](#requirement_scaleway) | >= 2.3.0 |
27+
28+
## Resources
29+
30+
| Name | Type |
31+
|------|------|
32+
| [scaleway_redis_cluster.this](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs/resources/redis_cluster) | resource |
33+
34+
## Inputs
35+
36+
| Name | Description | Type | Default | Required |
37+
|------|-------------|------|---------|:--------:|
38+
| <a name="input_cluster_name"></a> [cluster_name](#input_cluster_name) | Name of the Redis Cluster. | `string` | n/a | yes |
39+
| <a name="input_user_name"></a> [user_name](#input_user_name) | Identifier for the first user of the Redis Cluster. | `string` | n/a | yes |
40+
| <a name="input_user_password"></a> [user_password](#input_user_password) | Password for the first user of the Redis Cluster. | `string` | n/a | yes |
41+
| <a name="input_cluster_size"></a> [cluster_size](#input_cluster_size) | Nnumber of nodes in the Redis Cluster. | `number` | `1` | no |
42+
| <a name="input_cluster_version"></a> [cluster_version](#input_cluster_version) | Redis's Cluster version (e.g. `6.2.6`). | `string` | `"7.0.5"` | no |
43+
| <a name="input_instance_type"></a> [instance_type](#input_instance_type) | Type of Redis Cluster you want to create. | `string` | `"RED1-MICRO"` | no |
44+
| <a name="input_network_acls"></a> [network_acls](#input_network_acls) | List of acl rules (ie IP addresses authorized to connect to the cluster). | ```list(object({ ip = string description = string }))``` | ```[ { "description": "Allow all", "ip": "0.0.0.0/0" } ]``` | no |
45+
| <a name="input_project_id"></a> [project_id](#input_project_id) | ID of the project the namespace is associated with. Ressource will be created in the project set at the provider level if null. | `string` | `null` | no |
46+
| <a name="input_tags"></a> [tags](#input_tags) | Tags associated with the server and dedicated ip address. | `list(string)` | `[]` | no |
47+
| <a name="input_tls_enabled"></a> [tls_enabled](#input_tls_enabled) | Whether TLS is enabled or not. | `bool` | `true` | no |
48+
| <a name="input_zone"></a> [zone](#input_zone) | The zone in which the Redis Cluster should be created. Ressource will be created in the zone set at the provider level if null. | `string` | `null` | no |
49+
50+
## Outputs
51+
52+
| Name | Description |
53+
|------|-------------|
54+
| <a name="output_cluster_certificate"></a> [cluster_certificate](#output_cluster_certificate) | PEM of the certificate used by redis. |
55+
| <a name="output_cluster_id"></a> [cluster_id](#output_cluster_id) | ID of the Database Instance. |
56+
<!-- END_TF_DOCS -->
57+
58+
## Authors
59+
60+
Module is maintained with help from [the community](https://github.com/scaleway-terraform-modules/terraform-scaleway-domain/graphs/contributors).
61+
62+
## License
63+
64+
Mozilla Public License 2.0 Licensed. See [LICENSE](https://github.com/scaleway-terraform-modules/terraform-scaleway-domain/tree/master/LICENSE) for full details.

0 commit comments

Comments
 (0)