Adds descriptions to repos variables

README.md

@@ -40,7 +40,7 @@ No provider.
 |------|-------------|------|---------|:--------:|
 | bucket\_name | S3 bucket where salt repo will be mirrored | `string` | n/a | yes |
 | repo\_endpoint | HTTP/S endpoint URL that hosts the yum repos; used with the baseurl in the yum .repo definitions | `string` | n/a | yes |
-| repos | n/a | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>    yum_prefix       = string<br>  }))</pre> | `[]` | no |
+| repos | Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror. `yum_prefix` is the S3 key prefix for the yum repo definition files. | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>    yum_prefix       = string<br>  }))</pre> | n/a | yes |
 
 ## Outputs
 

modules/defs/README.md

@@ -15,7 +15,7 @@ No requirements.
 |------|-------------|------|---------|:--------:|
 | bucket\_name | n/a | `string` | n/a | yes |
 | repo\_endpoint | n/a | `string` | n/a | yes |
-| repos | n/a | <pre>list(object({<br>    repo_prefix   = string<br>    salt_versions = list(string)<br>    yum_prefix    = string<br>  }))</pre> | `[]` | no |
+| repos | Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo is located. `salt_versions` is the list of salt versions for which repo definitions will be generated. `yum_prefix` is the S3 key prefix for the yum repo definition files. | <pre>list(object({<br>    repo_prefix   = string<br>    salt_versions = list(string)<br>    yum_prefix    = string<br>  }))</pre> | n/a | yes |
 
 ## Outputs
 

modules/defs/variables.tf

@@ -7,10 +7,10 @@ variable "repo_endpoint" {
 }
 
 variable "repos" {
+  description = "Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo is located. `salt_versions` is the list of salt versions for which repo definitions will be generated. `yum_prefix` is the S3 key prefix for the yum repo definition files."
   type = list(object({
     repo_prefix   = string
     salt_versions = list(string)
     yum_prefix    = string
   }))
-  default = []
 }

modules/repo/README.md

@@ -14,7 +14,7 @@ No requirements.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | bucket\_name | n/a | `string` | n/a | yes |
-| repos | n/a | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>  }))</pre> | `[]` | no |
+| repos | Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror. | <pre>list(object({<br>    repo_prefix      = string<br>    salt_s3_endpoint = string<br>    salt_versions    = list(string)<br>  }))</pre> | n/a | yes |
 
 ## Outputs
 

modules/repo/variables.tf

@@ -3,10 +3,10 @@ variable "bucket_name" {
 }
 
 variable "repos" {
+  description = "Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror."
   type = list(object({
     repo_prefix      = string
     salt_s3_endpoint = string
     salt_versions    = list(string)
   }))
-  default = []
 }

variables.tf

@@ -9,11 +9,11 @@ variable "repo_endpoint" {
 }
 
 variable "repos" {
+  description = "Schema list of repo objects. `repo_prefix` is the S3 key prefix where the repo will be mirrored. `salt_s3_endpoint` is the upstream s3 endpoint hosting the repos. `salt_versions` is the list of salt versions to mirror. `yum_prefix` is the S3 key prefix for the yum repo definition files."
   type = list(object({
     repo_prefix      = string
     salt_s3_endpoint = string
     salt_versions    = list(string)
     yum_prefix       = string
   }))
-  default = []
 }