Skip to content

Commit 1dbef48

Browse files
github-actions[bot]github-actions[bot]
authored
chore(docs): Update Terraform documentation
1 parent 2e67ea3 commit 1dbef48

2 files changed

Lines changed: 55 additions & 52 deletions

File tree

‎terraform/charm/README.md‎

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -62,48 +62,51 @@ The complete list of available integrations can be found [in the Integrations ta
6262
[github-runner-integrations]: https://charmhub.io/github-runner/integrations
6363

6464
<!-- BEGIN_TF_DOCS -->
65-
6665
## Requirements
6766

68-
| Name | Version |
69-
| --------------------------------------------------------- | -------- |
70-
| <a name="requirement_juju"></a> [juju](#requirement_juju) | >= 1.0.0 |
67+
| Name | Version |
68+
|------|---------|
69+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
70+
| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 1.0, < 2.0 |
7171

7272
## Providers
7373

74-
| Name | Version |
75-
| --------------------------------------------------- | -------- |
76-
| <a name="provider_juju"></a> [juju](#provider_juju) | >= 1.0.0 |
74+
| Name | Version |
75+
|------|---------|
76+
| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 1.0, < 2.0 |
7777

7878
## Modules
7979

8080
No modules.
8181

8282
## Resources
8383

84-
| Name | Type |
85-
| --------------------------------------------------------------------------------------------------------------------- | -------- |
84+
| Name | Type |
85+
|------|------|
8686
| [juju_application.github_runner](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/application) | resource |
8787

8888
## Inputs
8989

90-
| Name | Description | Type | Default | Required |
91-
| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------- | :------: |
92-
| <a name="input_app_name"></a> [app_name](#input_app_name) | Name of the application in the Juju model. | `string` | `"github-runner"` | no |
93-
| <a name="input_base"></a> [base](#input_base) | The operating system on which to deploy | `string` | `"ubuntu@22.04"` | no |
94-
| <a name="input_channel"></a> [channel](#input_channel) | The channel to use when deploying a charm. | `string` | `"latest/stable"` | no |
95-
| <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 |
96-
| <a name="input_constraints"></a> [constraints](#input_constraints) | Juju constraints to apply for this application. | `string` | `""` | no |
97-
| <a name="input_model_uuid"></a> [model_uuid](#input_model_uuid) | UUID of the Juju model. | `string` | `""` | no |
98-
| <a name="input_revision"></a> [revision](#input_revision) | Revision number of the charm | `number` | `null` | no |
99-
| <a name="input_units"></a> [units](#input_units) | Number of units to deploy | `number` | `1` | no |
90+
| Name | Description | Type | Default | Required |
91+
|------|-------------|------|---------|:--------:|
92+
| <a name="input_app_name"></a> [app\_name](#input\_app\_name) | Name of the application in the Juju model. | `string` | `"github-runner"` | no |
93+
| <a name="input_base"></a> [base](#input\_base) | The operating system on which to deploy | `string` | `"ubuntu@22.04"` | no |
94+
| <a name="input_channel"></a> [channel](#input\_channel) | The channel to use when deploying a charm. | `string` | `"latest/stable"` | no |
95+
| <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 |
96+
| <a name="input_constraints"></a> [constraints](#input\_constraints) | Juju constraints to apply for this application. | `string` | `""` | no |
97+
| <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 |
98+
| <a name="input_model_uuid"></a> [model\_uuid](#input\_model\_uuid) | Juju model UUID. | `string` | `""` | no |
99+
| <a name="input_revision"></a> [revision](#input\_revision) | Revision number of the charm | `number` | `null` | no |
100+
| <a name="input_units"></a> [units](#input\_units) | Number of units to deploy | `number` | `1` | no |
100101

101102
## Outputs
102103

103-
| Name | Description |
104-
| ----------------------------------------------------------- | --------------------------------- |
105-
| <a name="output_app_name"></a> [app_name](#output_app_name) | Name of the deployed application. |
106-
| <a name="output_provides"></a> [provides](#output_provides) | n/a |
107-
| <a name="output_requires"></a> [requires](#output_requires) | n/a |
108-
104+
| Name | Description |
105+
|------|-------------|
106+
| <a name="output_app_name"></a> [app\_name](#output\_app\_name) | Name of the deployed application. |
107+
| <a name="output_machines"></a> [machines](#output\_machines) | Set of machine IDs the application is placed on (if any). |
108+
| <a name="output_model_uuid"></a> [model\_uuid](#output\_model\_uuid) | Model UUID the application is deployed to. |
109+
| <a name="output_provides"></a> [provides](#output\_provides) | n/a |
110+
| <a name="output_requires"></a> [requires](#output\_requires) | n/a |
111+
| <a name="output_units"></a> [units](#output\_units) | Number of units to deploy when machines are not provided. |
109112
<!-- END_TF_DOCS -->

‎terraform/product/README.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -24,48 +24,48 @@ the bundle deployment onto any Kubernetes environment managed by [Juju][Juju].
2424
[Github runner image builder charm]: https://charmhub.io/github-runner-image-builder
2525

2626
<!-- BEGIN_TF_DOCS -->
27-
2827
## Requirements
2928

30-
| Name | Version |
31-
| --------------------------------------------------------- | -------- |
32-
| <a name="requirement_juju"></a> [juju](#requirement_juju) | >= 1.0.0 |
29+
| Name | Version |
30+
|------|---------|
31+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
32+
| <a name="requirement_juju"></a> [juju](#requirement\_juju) | >= 1.0.0, < 2.0.0 |
3333

3434
## Providers
3535

36-
| Name | Version |
37-
| --------------------------------------------------- | -------- |
38-
| <a name="provider_juju"></a> [juju](#provider_juju) | >= 1.0.0 |
36+
| Name | Version |
37+
|------|---------|
38+
| <a name="provider_juju"></a> [juju](#provider\_juju) | >= 1.0.0, < 2.0.0 |
3939

4040
## Modules
4141

42-
| Name | Source | Version |
43-
| -------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ------- |
44-
| <a name="module_github_runner"></a> [github_runner](#module_github_runner) | ../charm | n/a |
45-
| <a name="module_github_runner_image_builder"></a> [github_runner_image_builder](#module_github_runner_image_builder) | git::https://github.com/canonical/github-runner-image-builder-operator//terraform/charm | rev143 |
42+
| Name | Source | Version |
43+
|------|--------|---------|
44+
| <a name="module_github_runner"></a> [github\_runner](#module\_github\_runner) | ../charm | n/a |
45+
| <a name="module_github_runner_image_builder"></a> [github\_runner\_image\_builder](#module\_github\_runner\_image\_builder) | git::https://github.com/canonical/github-runner-image-builder-operator//terraform/charm | rev143 |
4646

4747
## Resources
4848

49-
| Name | Type |
50-
| --------------------------------------------------------------------------------------------------------------------- | ----------- |
51-
| [juju_integration.image_builder](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/integration) | resource |
52-
| [juju_model.github_runner](https://registry.terraform.io/providers/juju/juju/latest/docs/data-sources/model) | data source |
49+
| Name | Type |
50+
|------|------|
51+
| [juju_integration.image_builder](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/integration) | resource |
52+
| [juju_model.github_runner](https://registry.terraform.io/providers/juju/juju/latest/docs/data-sources/model) | data source |
5353

5454
## Inputs
5555

56-
| Name | Description | Type | Default | Required |
57-
| ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | :------: |
58-
| <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 |
59-
| <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 |
60-
| <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 |
56+
| Name | Description | Type | Default | Required |
57+
|------|-------------|------|---------|:--------:|
58+
| <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 |
59+
| <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 |
60+
| <a name="input_juju_model_owner"></a> [juju\_model\_owner](#input\_juju\_model\_owner) | n/a | `string` | `"admin"` | no |
61+
| <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 |
6162

6263
## Outputs
6364

64-
| Name | Description |
65-
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
66-
| <a name="output_all_app_names"></a> [all_app_names](#output_all_app_names) | Names of the all the deployed apps, github-runner plus github-runner-image-builder. |
67-
| <a name="output_all_runner_names"></a> [all_runner_names](#output_all_runner_names) | Names of the all the deployed github-runner applications. |
68-
| <a name="output_github_runner_image_builder_app_name"></a> [github_runner_image_builder_app_name](#output_github_runner_image_builder_app_name) | Name of the the deployed github-runner-image-builder application. |
69-
| <a name="output_reactive_runner_names"></a> [reactive_runner_names](#output_reactive_runner_names) | Names of the all the deployed github-runner applications that are reactive. |
70-
65+
| Name | Description |
66+
|------|-------------|
67+
| <a name="output_all_app_names"></a> [all\_app\_names](#output\_all\_app\_names) | Names of the all the deployed apps, github-runner plus github-runner-image-builder. |
68+
| <a name="output_all_runner_names"></a> [all\_runner\_names](#output\_all\_runner\_names) | Names of the all the deployed github-runner applications. |
69+
| <a name="output_github_runner_image_builder_app_name"></a> [github\_runner\_image\_builder\_app\_name](#output\_github\_runner\_image\_builder\_app\_name) | Name of the the deployed github-runner-image-builder application. |
70+
| <a name="output_reactive_runner_names"></a> [reactive\_runner\_names](#output\_reactive\_runner\_names) | Names of the all the deployed github-runner applications that are reactive. |
7171
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)