Skip to content

Commit 9976fb9

Browse files
committed
terraform-docs: automated update action
1 parent d70d0ff commit 9976fb9

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,48 @@ Wait until the backed-up resources are fully deployed and active. Use the kubect
6767
6868
<!--- BEGIN_TF_DOCS --->
6969
70+
## Requirements
71+
72+
| Name | Version |
73+
|------|---------|
74+
| terraform | >= 0.13 |
75+
| aws | >= 3.13, < 4.0 |
76+
| helm | >= 1.0, < 1.4.0 |
77+
| kubernetes | >= 1.10.0 |
78+
79+
## Providers
80+
81+
| Name | Version |
82+
|------|---------|
83+
| aws | >= 3.13, < 4.0 |
84+
| helm | >= 1.0, < 1.4.0 |
85+
| kubernetes | >= 1.10.0 |
86+
87+
## Inputs
88+
89+
| Name | Description | Type | Default | Required |
90+
|------|-------------|------|---------|:--------:|
91+
| aws\_region | AWS region where secrets are stored. | `string` | n/a | yes |
92+
| bucket\_name | Bucket name to store the backups. | `string` | n/a | yes |
93+
| cluster\_identity\_oidc\_issuer | The OIDC Identity issuer for the cluster. | `string` | n/a | yes |
94+
| cluster\_identity\_oidc\_issuer\_arn | The OIDC Identity issuer ARN for the cluster that can be used to associate IAM roles with a service account. | `string` | n/a | yes |
95+
| cluster\_name | The name of the cluster | `string` | n/a | yes |
96+
| create\_namespace | Whether to create Kubernetes namespace with name defined by `namespace`. | `bool` | `true` | no |
97+
| enabled | Variable indicating whether deployment is enabled. | `bool` | `true` | no |
98+
| helm\_chart\_name | Velero Helm chart name to be installed | `string` | `"velero"` | no |
99+
| helm\_chart\_release\_name | Helm release name | `string` | `"velero"` | no |
100+
| helm\_chart\_repo | Velero repository name. | `string` | `"https://vmware-tanzu.github.io/helm-charts"` | no |
101+
| helm\_chart\_version | Velero Helm chart version. | `string` | `"2.14.5"` | no |
102+
| mod\_dependency | Dependence variable binds all AWS resources allocated by this module, dependent modules reference this variable. | `any` | `null` | no |
103+
| namespace | Kubernetes namespace to deploy Velero Helm chart. | `string` | `"velero"` | no |
104+
| service\_account\_name | Velero service account name | `string` | `"velero"` | no |
105+
| settings | Additional settings which will be passed to the Helm chart values. | `map(any)` | `{}` | no |
106+
| volume\_snapshot\_name | Variable indicating the snapshot name. | `string` | `"velero-snapshot"` | no |
107+
108+
## Outputs
109+
110+
No output.
111+
70112
<!--- END_TF_DOCS --->
71113
72114
## Authors

0 commit comments

Comments
 (0)