Skip to content

Commit

Permalink
docs: auto update terraform docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 28, 2023
1 parent 558857e commit a5ee397
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ Made with [contributors-img](https://contrib.rocks).
| <a name="input_runner_worker_docker_machine_ec2_options"></a> [runner\_worker\_docker\_machine\_ec2\_options](#input\_runner\_worker\_docker\_machine\_ec2\_options) | List of additional options for the docker+machine config. Each element of this list must be a key=value pair. E.g. '["amazonec2-zone=a"]' | `list(string)` | `[]` | no |
| <a name="input_runner_worker_docker_machine_extra_egress_rules"></a> [runner\_worker\_docker\_machine\_extra\_egress\_rules](#input\_runner\_worker\_docker\_machine\_extra\_egress\_rules) | List of egress rules for the Runner Workers. | <pre>list(object({<br> cidr_blocks = list(string)<br> ipv6_cidr_blocks = list(string)<br> prefix_list_ids = list(string)<br> from_port = number<br> protocol = string<br> security_groups = list(string)<br> self = bool<br> to_port = number<br> description = string<br> }))</pre> | <pre>[<br> {<br> "cidr_blocks": [<br> "0.0.0.0/0"<br> ],<br> "description": "Allow all egress traffic for Runner Workers.",<br> "from_port": 0,<br> "ipv6_cidr_blocks": [<br> "::/0"<br> ],<br> "prefix_list_ids": null,<br> "protocol": "-1",<br> "security_groups": null,<br> "self": null,<br> "to_port": 0<br> }<br>]</pre> | no |
| <a name="input_runner_worker_docker_machine_fleet"></a> [runner\_worker\_docker\_machine\_fleet](#input\_runner\_worker\_docker\_machine\_fleet) | enable = Activates the fleet mode on the Runner. https://gitlab.com/cki-project/docker-machine/-/blob/v0.16.2-gitlab.19-cki.2/docs/drivers/aws.md#fleet-mode<br>key\_pair\_name = The name of the key pair used by the Runner to connect to the docker-machine Runner Workers. This variable is only supported when `enables` is set to `true`. | <pre>object({<br> enable = bool<br> key_pair_name = optional(string, "fleet-key")<br> })</pre> | <pre>{<br> "enable": false<br>}</pre> | no |
| <a name="input_runner_worker_docker_machine_instance"></a> [runner\_worker\_docker\_machine\_instance](#input\_runner\_worker\_docker\_machine\_instance) | For detailed documentation check https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersmachine-section<br><br>docker\_registry\_mirror\_url = The URL of the Docker registry mirror to use for the Runner Worker.<br>destroy\_after\_max\_builds = Destroy the instance after the maximum number of builds has been reached.<br>ebs\_optimized = Enable EBS optimization for the Runner Worker.<br>idle\_count = Number of idle Runner Worker instances (not working for the Docker Runner Worker) (IdleCount).<br>idle\_time = Idle time of the Runner Worker before they are destroyed (not working for the Docker Runner Worker) (IdleTime).<br>monitoring = Enable detailed monitoring for the Runner Worker.<br>name\_prefix = Set the name prefix and override the `Name` tag for the Runner Worker.<br>private\_address\_only = Restrict Runner Worker to the use of a private IP address. If `runner_instance.use_private_address_only` is set to `true` (default), `runner_worker_docker_machine_instance.private_address_only` will also apply for the Runner.<br>root\_size = The size of the root volume for the Runner Worker.<br>start\_script = Cloud-init user data that will be passed to the Runner Worker. Should not be base64 encrypted.<br>subnet\_ids = The list of subnet IDs to use for the Runner Worker when the fleet mode is enabled.<br>types = The type of instance to use for the Runner Worker. In case of fleet mode, multiple instance types are supported.<br>volume\_type = The type of volume to use for the Runner Worker. | <pre>object({<br> destroy_after_max_builds = optional(number, 0)<br> docker_registry_mirror_url = optional(string, "")<br> ebs_optimized = optional(bool, true)<br> idle_count = optional(number, 0)<br> idle_time = optional(number, 600)<br> monitoring = optional(bool, false)<br> name_prefix = optional(string, "")<br> private_address_only = optional(bool, true)<br> root_size = optional(number, 8)<br> start_script = optional(string, "")<br> subnet_ids = optional(list(string), [])<br> types = optional(list(string), ["m5.large"])<br> volume_type = optional(string, "gp2")<br> })</pre> | `{}` | no |
| <a name="input_runner_worker_docker_machine_instance"></a> [runner\_worker\_docker\_machine\_instance](#input\_runner\_worker\_docker\_machine\_instance) | For detailed documentation check https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersmachine-section<br><br>docker\_registry\_mirror\_url = The URL of the Docker registry mirror to use for the Runner Worker.<br>destroy\_after\_max\_builds = Destroy the instance after the maximum number of builds has been reached.<br>ebs\_optimized = Enable EBS optimization for the Runner Worker.<br>idle\_count = Number of idle Runner Worker instances (not working for the Docker Runner Worker) (IdleCount).<br>idle\_time = Idle time of the Runner Worker before they are destroyed (not working for the Docker Runner Worker) (IdleTime).<br>max\_growth\_rate = The maximum number of machines that can be added to the runner in parallel.<br>monitoring = Enable detailed monitoring for the Runner Worker.<br>name\_prefix = Set the name prefix and override the `Name` tag for the Runner Worker.<br>private\_address\_only = Restrict Runner Worker to the use of a private IP address. If `runner_instance.use_private_address_only` is set to `true` (default), `runner_worker_docker_machine_instance.private_address_only` will also apply for the Runner.<br>root\_size = The size of the root volume for the Runner Worker.<br>start\_script = Cloud-init user data that will be passed to the Runner Worker. Should not be base64 encrypted.<br>subnet\_ids = The list of subnet IDs to use for the Runner Worker when the fleet mode is enabled.<br>types = The type of instance to use for the Runner Worker. In case of fleet mode, multiple instance types are supported.<br>volume\_type = The type of volume to use for the Runner Worker. | <pre>object({<br> destroy_after_max_builds = optional(number, 0)<br> docker_registry_mirror_url = optional(string, "")<br> ebs_optimized = optional(bool, true)<br> idle_count = optional(number, 0)<br> idle_time = optional(number, 600)<br> max_growth_rate = optional(number, 0)<br> monitoring = optional(bool, false)<br> name_prefix = optional(string, "")<br> private_address_only = optional(bool, true)<br> root_size = optional(number, 8)<br> start_script = optional(string, "")<br> subnet_ids = optional(list(string), [])<br> types = optional(list(string), ["m5.large"])<br> volume_type = optional(string, "gp2")<br> })</pre> | `{}` | no |
| <a name="input_runner_worker_docker_machine_instance_spot"></a> [runner\_worker\_docker\_machine\_instance\_spot](#input\_runner\_worker\_docker\_machine\_instance\_spot) | enable = Enable spot instances for the Runner Worker.<br>max\_price = The maximum price willing to pay. By default the price is limited by the current on demand price for the instance type chosen. | <pre>object({<br> enable = optional(bool, true)<br> max_price = optional(string, "on-demand-price")<br> })</pre> | `{}` | no |
| <a name="input_runner_worker_docker_machine_role"></a> [runner\_worker\_docker\_machine\_role](#input\_runner\_worker\_docker\_machine\_role) | additional\_tags = Map of tags that will be added to the Runner Worker.<br>assume\_role\_policy\_json = Assume role policy for the Runner Worker.<br>policy\_arns = List of ARNs of IAM policies to attach to the Runner Workers.<br>profile\_name = Name of the IAM profile to attach to the Runner Workers. | <pre>object({<br> additional_tags = optional(map(string), {})<br> assume_role_policy_json = optional(string, "")<br> policy_arns = optional(list(string), [])<br> profile_name = optional(string, "")<br> })</pre> | `{}` | no |
| <a name="input_runner_worker_docker_machine_security_group_description"></a> [runner\_worker\_docker\_machine\_security\_group\_description](#input\_runner\_worker\_docker\_machine\_security\_group\_description) | A description for the Runner Worker security group | `string` | `"A security group containing Runner Worker instances"` | no |
Expand Down
6 changes: 3 additions & 3 deletions examples/runner-default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ check `.terraform-version` for the tested version.
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.14.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.15.0 |
| <a name="requirement_local"></a> [local](#requirement\_local) | 2.4.0 |
| <a name="requirement_null"></a> [null](#requirement\_null) | 3.2.1 |
| <a name="requirement_random"></a> [random](#requirement\_random) | 3.5.1 |
Expand All @@ -54,8 +54,8 @@ check `.terraform-version` for the tested version.

| Name | Type |
|------|------|
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/5.14.0/docs/data-sources/availability_zones) | data source |
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/5.14.0/docs/data-sources/security_group) | data source |
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/5.15.0/docs/data-sources/availability_zones) | data source |
| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/5.15.0/docs/data-sources/security_group) | data source |

## Inputs

Expand Down
6 changes: 3 additions & 3 deletions examples/runner-public/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ check `.terraform-version` for the tested version.
| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.14.0 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.15.0 |
| <a name="requirement_local"></a> [local](#requirement\_local) | 2.4.0 |
| <a name="requirement_null"></a> [null](#requirement\_null) | 3.2.1 |
| <a name="requirement_random"></a> [random](#requirement\_random) | 3.5.1 |
Expand All @@ -40,7 +40,7 @@ check `.terraform-version` for the tested version.

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.14.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.15.0 |

## Modules

Expand All @@ -55,7 +55,7 @@ check `.terraform-version` for the tested version.

| Name | Type |
|------|------|
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/5.14.0/docs/data-sources/availability_zones) | data source |
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/5.15.0/docs/data-sources/availability_zones) | data source |

## Inputs

Expand Down

0 comments on commit a5ee397

Please sign in to comment.