Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs and var description #45

Merged
merged 1 commit into from
Dec 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions TERRAFORM.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,20 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_attach_admin_policy"></a> [attach\_admin\_policy](#input\_attach\_admin\_policy) | Enable attachment of the AdministratorAccess policy | `bool` | `false` | no |
| <a name="input_attach_read_only_policy"></a> [attach\_read\_only\_policy](#input\_attach\_read\_only\_policy) | Enable attachment of the ReadOnly policy | `bool` | `true` | no |
| <a name="input_create_oidc_provider"></a> [create\_oidc\_provider](#input\_create\_oidc\_provider) | Enable creation of the GitLab OIDC provider | `bool` | `true` | no |
| <a name="input_enabled"></a> [enabled](#input\_enabled) | Enable creation of resources | `bool` | `true` | no |
| <a name="input_force_detach_policies"></a> [force\_detach\_policies](#input\_force\_detach\_policies) | Force detachment of policies attached to the IAM role | `bool` | `false` | no |
| <a name="input_attach_admin_policy"></a> [attach\_admin\_policy](#input\_attach\_admin\_policy) | Attach AdministratorAccess policy | `bool` | `false` | no |
| <a name="input_attach_read_only_policy"></a> [attach\_read\_only\_policy](#input\_attach\_read\_only\_policy) | Attach ReadOnly policy | `bool` | `true` | no |
| <a name="input_create_oidc_provider"></a> [create\_oidc\_provider](#input\_create\_oidc\_provider) | Create GitLab OIDC provider | `bool` | `true` | no |
| <a name="input_enabled"></a> [enabled](#input\_enabled) | Enable resource creation | `bool` | `true` | no |
| <a name="input_force_detach_policies"></a> [force\_detach\_policies](#input\_force\_detach\_policies) | Force detach IAM policies | `bool` | `false` | no |
| <a name="input_gitlab_organisation"></a> [gitlab\_organisation](#input\_gitlab\_organisation) | GitLab organisation name | `string` | n/a | yes |
| <a name="input_gitlab_repositories"></a> [gitlab\_repositories](#input\_gitlab\_repositories) | List of GitLab repository name(s) and refs names or patterns | <pre>list(object({<br> name = string<br> refs = list(string)<br> ref_type = string<br> }))</pre> | <pre>[<br> {<br> "name": "",<br> "ref_type": "",<br> "refs": []<br> }<br>]</pre> | no |
| <a name="input_iam_role_name"></a> [iam\_role\_name](#input\_iam\_role\_name) | Name of the IAM role | `string` | `"gitlab-runner"` | no |
| <a name="input_iam_role_path"></a> [iam\_role\_path](#input\_iam\_role\_path) | Path to the IAM role | `string` | `"/"` | no |
| <a name="input_iam_role_permissions_boundary"></a> [iam\_role\_permissions\_boundary](#input\_iam\_role\_permissions\_boundary) | ARN of the permissions boundary to be used by the IAM role | `string` | `""` | no |
| <a name="input_iam_role_policy_arns"></a> [iam\_role\_policy\_arns](#input\_iam\_role\_policy\_arns) | List of IAM policy ARNs to attach to the IAM role | `list(string)` | `[]` | no |
| <a name="input_max_session_duration"></a> [max\_session\_duration](#input\_max\_session\_duration) | Maximum session duration in seconds | `number` | `3600` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to be applied to all resources. | `map(string)` | `{}` | no |
| <a name="input_url"></a> [url](#input\_url) | URL of identity provider | `string` | `"gitlab.com"` | no |
| <a name="input_gitlab_repositories"></a> [gitlab\_repositories](#input\_gitlab\_repositories) | List of GitLab repositories and refs | <pre>list(object({<br/> name = string<br/> refs = list(string)<br/> ref_type = string<br/> }))</pre> | <pre>[<br/> {<br/> "name": "",<br/> "ref_type": "",<br/> "refs": []<br/> }<br/>]</pre> | no |
| <a name="input_iam_role_name"></a> [iam\_role\_name](#input\_iam\_role\_name) | IAM role name | `string` | `"gitlab-runner"` | no |
| <a name="input_iam_role_path"></a> [iam\_role\_path](#input\_iam\_role\_path) | IAM role path | `string` | `"/"` | no |
| <a name="input_iam_role_permissions_boundary"></a> [iam\_role\_permissions\_boundary](#input\_iam\_role\_permissions\_boundary) | IAM role permissions boundary ARN | `string` | `""` | no |
| <a name="input_iam_role_policy_arns"></a> [iam\_role\_policy\_arns](#input\_iam\_role\_policy\_arns) | List of IAM policy ARNs | `list(string)` | `[]` | no |
| <a name="input_max_session_duration"></a> [max\_session\_duration](#input\_max\_session\_duration) | Max session duration (seconds) | `number` | `3600` | no |
| <a name="input_tags"></a> [tags](#input\_tags) | Resource tags | `map(string)` | `{}` | no |
| <a name="input_url"></a> [url](#input\_url) | Identity provider URL | `string` | `"gitlab.com"` | no |

## Outputs

Expand Down
26 changes: 13 additions & 13 deletions variables.tf
Original file line number Diff line number Diff line change
@@ -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
}

Expand All @@ -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])
Expand All @@ -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 {
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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
}
Loading