Skip to content

Commit ba59c1d

Browse files
chore(docs): Update Terraform documentation
1 parent aeaa27f commit ba59c1d

2 files changed

Lines changed: 11 additions & 5 deletions

File tree

terraform/charm/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,14 @@ The complete list of available integrations can be found [in the Integrations ta
6363

6464
| Name | Version |
6565
|------|---------|
66-
| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 0.11.0 |
66+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
67+
| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 0.11.0, < 1.0.0 |
6768

6869
## Providers
6970

7071
| Name | Version |
7172
|------|---------|
72-
| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 0.11.0 |
73+
| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 0.11.0, < 1.0.0 |
7374

7475
## Modules
7576

@@ -90,6 +91,7 @@ No modules.
9091
| <a name="input_channel"></a> [channel](#input\_channel) | The channel to use when deploying a charm. | `string` | `"latest/stable"` | no |
9192
| <a name="input_config"></a> [config](#input\_config) | Application config. Details about available options can be found at https://charmhub.io/github-runner/configurations | `map(string)` | `{}` | no |
9293
| <a name="input_constraints"></a> [constraints](#input\_constraints) | Juju constraints to apply for this application. | `string` | `""` | no |
94+
| <a name="input_machines"></a> [machines](#input\_machines) | Optional set of target machine IDs to place units on. Mutually exclusive with units; if set, units is ignored. | `set(string)` | `null` | no |
9395
| <a name="input_model"></a> [model](#input\_model) | Reference to a `juju_model`. | `string` | `""` | no |
9496
| <a name="input_revision"></a> [revision](#input\_revision) | Revision number of the charm | `number` | `null` | no |
9597
| <a name="input_units"></a> [units](#input\_units) | Number of units to deploy | `number` | `1` | no |
@@ -99,6 +101,9 @@ No modules.
99101
| Name | Description |
100102
|------|-------------|
101103
| <a name="output_app_name"></a> [app\_name](#output\_app\_name) | Name of the deployed application. |
104+
| <a name="output_machines"></a> [machines](#output\_machines) | Set of machine IDs the application is placed on (if any). |
105+
| <a name="output_model"></a> [model](#output\_model) | Model the application is deployed to. |
102106
| <a name="output_provides"></a> [provides](#output\_provides) | n/a |
103107
| <a name="output_requires"></a> [requires](#output\_requires) | n/a |
108+
| <a name="output_units"></a> [units](#output\_units) | Number of units to deploy when machines are not provided. |
104109
<!-- END_TF_DOCS -->

terraform/product/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@ the bundle deployment onto any Kubernetes environment managed by [Juju][Juju].
2626

2727
| Name | Version |
2828
|------|---------|
29-
| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 0.11.0 |
29+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
30+
| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 0.11.0, < 1.0.0 |
3031

3132
## Providers
3233

3334
| Name | Version |
3435
|------|---------|
35-
| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 0.11.0 |
36+
| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 0.11.0, < 1.0.0 |
3637

3738
## Modules
3839

@@ -53,7 +54,7 @@ the bundle deployment onto any Kubernetes environment managed by [Juju][Juju].
5354
| Name | Description | Type | Default | Required |
5455
|------|-------------|------|---------|:--------:|
5556
| <a name="input_github_runner_image_builder"></a> [github\_runner\_image\_builder](#input\_github\_runner\_image\_builder) | n/a | <pre>object({<br/> app_name = optional(string, "github-runner-image-builder")<br/> channel = optional(string, "latest/stable")<br/> config = optional(map(string), {})<br/> constraints = optional(string, "arch=amd64 cores=2 mem=8192M root-disk=20000M")<br/> revision = optional(number)<br/> base = optional(string, "ubuntu@22.04")<br/> units = optional(number, 1)<br/> })</pre> | n/a | yes |
56-
| <a name="input_github_runners"></a> [github\_runners](#input\_github\_runners) | n/a | <pre>list(object({<br/> app_name = optional(string, "github-runner")<br/> channel = optional(string, "latest/stable")<br/> config = optional(map(string), {})<br/> constraints = optional(string, "arch=amd64 cores=2 mem=8192M root-disk=20000M")<br/> revision = optional(number)<br/> base = optional(string, "ubuntu@22.04")<br/> units = optional(number, 1)<br/> }))</pre> | n/a | yes |
57+
| <a name="input_github_runners"></a> [github\_runners](#input\_github\_runners) | n/a | <pre>list(object({<br/> app_name = optional(string, "github-runner")<br/> channel = optional(string, "latest/stable")<br/> config = optional(map(string), {})<br/> constraints = optional(string, "arch=amd64 cores=2 mem=8192M root-disk=20000M")<br/> revision = optional(number)<br/> base = optional(string, "ubuntu@22.04")<br/> units = optional(number, 1)<br/> machines = optional(set(string))<br/> }))</pre> | n/a | yes |
5758
| <a name="input_model"></a> [model](#input\_model) | Reference to the Juju model to deploy the github-runner and github-runner-image-builder operators. | `string` | n/a | yes |
5859

5960
## Outputs

0 commit comments

Comments
 (0)