From f18c60e25fd4b5c066213c771b7c46f0fd346e69 Mon Sep 17 00:00:00 2001 From: Said Sef Date: Mon, 23 Dec 2024 06:38:58 +0000 Subject: [PATCH] chore: update docs and var description --- TERRAFORM.md | 26 +++++++++++++------------- variables.tf | 26 +++++++++++++------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/TERRAFORM.md b/TERRAFORM.md index 5e9e0fa..c4015b5 100644 --- a/TERRAFORM.md +++ b/TERRAFORM.md @@ -35,20 +35,20 @@ No modules. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [attach\_admin\_policy](#input\_attach\_admin\_policy) | Enable attachment of the AdministratorAccess policy | `bool` | `false` | no | -| [attach\_read\_only\_policy](#input\_attach\_read\_only\_policy) | Enable attachment of the ReadOnly policy | `bool` | `true` | no | -| [create\_oidc\_provider](#input\_create\_oidc\_provider) | Enable creation of the GitLab OIDC provider | `bool` | `true` | no | -| [enabled](#input\_enabled) | Enable creation of resources | `bool` | `true` | no | -| [force\_detach\_policies](#input\_force\_detach\_policies) | Force detachment of policies attached to the IAM role | `bool` | `false` | no | +| [attach\_admin\_policy](#input\_attach\_admin\_policy) | Attach AdministratorAccess policy | `bool` | `false` | no | +| [attach\_read\_only\_policy](#input\_attach\_read\_only\_policy) | Attach ReadOnly policy | `bool` | `true` | no | +| [create\_oidc\_provider](#input\_create\_oidc\_provider) | Create GitLab OIDC provider | `bool` | `true` | no | +| [enabled](#input\_enabled) | Enable resource creation | `bool` | `true` | no | +| [force\_detach\_policies](#input\_force\_detach\_policies) | Force detach IAM policies | `bool` | `false` | no | | [gitlab\_organisation](#input\_gitlab\_organisation) | GitLab organisation name | `string` | n/a | yes | -| [gitlab\_repositories](#input\_gitlab\_repositories) | List of GitLab repository name(s) and refs names or patterns |
list(object({
name = string
refs = list(string)
ref_type = string
}))
|
[
{
"name": "",
"ref_type": "",
"refs": []
}
]
| no | -| [iam\_role\_name](#input\_iam\_role\_name) | Name of the IAM role | `string` | `"gitlab-runner"` | no | -| [iam\_role\_path](#input\_iam\_role\_path) | Path to the IAM role | `string` | `"/"` | no | -| [iam\_role\_permissions\_boundary](#input\_iam\_role\_permissions\_boundary) | ARN of the permissions boundary to be used by the IAM role | `string` | `""` | no | -| [iam\_role\_policy\_arns](#input\_iam\_role\_policy\_arns) | List of IAM policy ARNs to attach to the IAM role | `list(string)` | `[]` | no | -| [max\_session\_duration](#input\_max\_session\_duration) | Maximum session duration in seconds | `number` | `3600` | no | -| [tags](#input\_tags) | Map of tags to be applied to all resources. | `map(string)` | `{}` | no | -| [url](#input\_url) | URL of identity provider | `string` | `"gitlab.com"` | no | +| [gitlab\_repositories](#input\_gitlab\_repositories) | List of GitLab repositories and refs |
list(object({
name = string
refs = list(string)
ref_type = string
}))
|
[
{
"name": "",
"ref_type": "",
"refs": []
}
]
| no | +| [iam\_role\_name](#input\_iam\_role\_name) | IAM role name | `string` | `"gitlab-runner"` | no | +| [iam\_role\_path](#input\_iam\_role\_path) | IAM role path | `string` | `"/"` | no | +| [iam\_role\_permissions\_boundary](#input\_iam\_role\_permissions\_boundary) | IAM role permissions boundary ARN | `string` | `""` | no | +| [iam\_role\_policy\_arns](#input\_iam\_role\_policy\_arns) | List of IAM policy ARNs | `list(string)` | `[]` | no | +| [max\_session\_duration](#input\_max\_session\_duration) | Max session duration (seconds) | `number` | `3600` | no | +| [tags](#input\_tags) | Resource tags | `map(string)` | `{}` | no | +| [url](#input\_url) | Identity provider URL | `string` | `"gitlab.com"` | no | ## Outputs diff --git a/variables.tf b/variables.tf index caceaa5..c58ff80 100644 --- a/variables.tf +++ b/variables.tf @@ -1,30 +1,30 @@ variable "attach_admin_policy" { default = false - description = "Enable attachment of the AdministratorAccess policy" + description = "Attach AdministratorAccess policy" type = bool } variable "attach_read_only_policy" { default = true - description = "Enable attachment of the ReadOnly policy" + description = "Attach ReadOnly policy" type = bool } variable "create_oidc_provider" { default = true - description = "Enable creation of the GitLab OIDC provider" + description = "Create GitLab OIDC provider" type = bool } variable "enabled" { default = true - description = "Enable creation of resources" + description = "Enable resource creation" type = bool } variable "force_detach_policies" { default = false - description = "Force detachment of policies attached to the IAM role" + description = "Force detach IAM policies" type = bool } @@ -51,7 +51,7 @@ variable "gitlab_repositories" { ref_type = "" } ] - description = "List of GitLab repository name(s) and refs names or patterns" + description = "List of GitLab repositories and refs" validation { condition = alltrue([for repo in var.gitlab_repositories : length(repo.name) > 0]) @@ -61,7 +61,7 @@ variable "gitlab_repositories" { variable "iam_role_name" { default = "gitlab-runner" - description = "Name of the IAM role" + description = "IAM role name" type = string validation { @@ -72,7 +72,7 @@ variable "iam_role_name" { variable "iam_role_path" { default = "/" - description = "Path to the IAM role" + description = "IAM role path" type = string sensitive = false @@ -84,21 +84,21 @@ variable "iam_role_path" { variable "iam_role_permissions_boundary" { default = "" - description = "ARN of the permissions boundary to be used by the IAM role" + description = "IAM role permissions boundary ARN" type = string sensitive = false } variable "iam_role_policy_arns" { default = [] - description = "List of IAM policy ARNs to attach to the IAM role" + description = "List of IAM policy ARNs" type = list(string) sensitive = false } variable "max_session_duration" { default = 3600 - description = "Maximum session duration in seconds" + description = "Max session duration (seconds)" type = number sensitive = false @@ -110,7 +110,7 @@ variable "max_session_duration" { variable "url" { type = string - description = "URL of identity provider" + description = "Identity provider URL" default = "gitlab.com" sensitive = false @@ -122,7 +122,7 @@ variable "url" { variable "tags" { default = {} - description = "Map of tags to be applied to all resources." + description = "Resource tags" type = map(string) sensitive = false }