Skip to content

Commit 6d77eed

Browse files
terraform-docs: automated action
1 parent 010c6b5 commit 6d77eed

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

examples/complete/README.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
3+
## Example `tfvars` Configuration
4+
5+
```hcl
6+
# Required Parameters
7+
public_subnet_ids = ["subnet-050928489741239", "subnet-98347019238472343"]
8+
private_subnet_ids = ["subnet-09483509823434", "subnet-57093487509234870"]
9+
vpc_id = "vpc-43523452345265253"
10+
atlantis_url = "example.your-domain.com"
11+
atlantis_gh_user = "your-github-username"
12+
atlantis_repo_allowlist = ["repo1", "repo2"]
13+
14+
# Optional Parameters
15+
thumbprint_list = ["oidc-thumbprint-1", "oidc-thumbprint-2"]
16+
atlantis_docker_image = = "<your-custom-docker-image>"
17+
```
18+
19+
## Requirements
20+
21+
| Name | Version |
22+
|------|---------|
23+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.6.0 |
24+
25+
## Providers
26+
27+
No providers.
28+
29+
## Modules
30+
31+
| Name | Source | Version |
32+
|------|--------|---------|
33+
| <a name="module_atlantis"></a> [atlantis](#module\_atlantis) | ../.. | n/a |
34+
35+
## Resources
36+
37+
No resources.
38+
39+
## Inputs
40+
41+
| Name | Description | Type | Default | Required |
42+
|------|-------------|------|---------|:--------:|
43+
| <a name="input_atlantis_docker_image"></a> [atlantis\_docker\_image](#input\_atlantis\_docker\_image) | The Docker image to use for the Atlantis server | `string` | `"ghcr.io/runatlantis/atlantis:v0.23.1"` | no |
44+
| <a name="input_atlantis_gh_user"></a> [atlantis\_gh\_user](#input\_atlantis\_gh\_user) | GitHub username for Atlantis | `string` | n/a | yes |
45+
| <a name="input_atlantis_repo_allowlist"></a> [atlantis\_repo\_allowlist](#input\_atlantis\_repo\_allowlist) | GitHub repository allowlist for Atlantis | `string` | n/a | yes |
46+
| <a name="input_atlantis_url"></a> [atlantis\_url](#input\_atlantis\_url) | Full URL for the Atlantis server | `string` | n/a | yes |
47+
| <a name="input_private_subnet_ids"></a> [private\_subnet\_ids](#input\_private\_subnet\_ids) | List of private subnet IDs | `list(string)` | n/a | yes |
48+
| <a name="input_public_subnet_ids"></a> [public\_subnet\_ids](#input\_public\_subnet\_ids) | List of public subnet IDs | `list(string)` | n/a | yes |
49+
| <a name="input_thumbprint_list"></a> [thumbprint\_list](#input\_thumbprint\_list) | List of thumbprints for the OIDC provider | `list(string)` | <pre>[<br> "e252aa6e92432f32cbc1b182056627c239652678"<br>]</pre> | no |
50+
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | VPC ID where resources will be deployed | `string` | n/a | yes |
51+
52+
## Outputs
53+
54+
| Name | Description |
55+
|------|-------------|
56+
| <a name="output_authorized_javascript_origin"></a> [authorized\_javascript\_origin](#output\_authorized\_javascript\_origin) | The base URL for your application that is authorized to use JavaScript for OAuth requests. |
57+
| <a name="output_authorized_redirect_uri"></a> [authorized\_redirect\_uri](#output\_authorized\_redirect\_uri) | The redirect URI used by your OAuth provider to return responses to your application. |
58+
| <a name="output_github_webhook_url"></a> [github\_webhook\_url](#output\_github\_webhook\_url) | The URL for GitHub webhook |
59+
| <a name="output_private_subnet_ids"></a> [private\_subnet\_ids](#output\_private\_subnet\_ids) | The IDs of the private subnets. |
60+
| <a name="output_public_subnet_ids"></a> [public\_subnet\_ids](#output\_public\_subnet\_ids) | The IDs of the public subnets. |
61+
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The ID of the VPC. |
62+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)