From 27373330119e527efd2614da8d6cb90cf319b0ef Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 31 Oct 2026 07:17:12 +0000 Subject: [PATCH] chore(docs): Update Terraform documentation --- .../charm/cloudflare_configurator/README.md | 43 +++++++++++++++++++ terraform/charm/cloudflared/README.md | 42 ++++++++++++++++++ 2 files changed, 85 insertions(+) diff --git a/terraform/charm/cloudflare_configurator/README.md b/terraform/charm/cloudflare_configurator/README.md index db4a400..87cf995 100644 --- a/terraform/charm/cloudflare_configurator/README.md +++ b/terraform/charm/cloudflare_configurator/README.md @@ -57,6 +57,49 @@ The complete list of available integrations can be found [in the Integrations ta +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | ~> 1.12 | +| [juju](#requirement\_juju) | ~> 1.0 | + +## Providers + +| Name | Version | +|------|---------| +| [juju](#provider\_juju) | ~> 1.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [juju_application.cloudflare_configurator](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/application) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [app\_name](#input\_app\_name) | Name of the application in the Juju model. | `string` | `"cloudflare-configurator"` | no | +| [base](#input\_base) | The operating system on which to deploy. | `string` | `null` | no | +| [channel](#input\_channel) | The channel to use when deploying a charm. | `string` | `"latest/edge"` | no | +| [config](#input\_config) | Application config. Details about available options can be found at https://charmhub.io/cloudflare-configurator/configurations | `map(string)` | `{}` | no | +| [constraints](#input\_constraints) | Juju constraints to apply for this application. | `string` | `null` | no | +| [model\_uuid](#input\_model\_uuid) | UUID of the Juju model where the application will be deployed. | `string` | n/a | yes | +| [revision](#input\_revision) | Revision number of the charm. | `number` | `null` | no | +| [units](#input\_units) | The number of units to deploy. | `number` | `1` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [application](#output\_application) | The deployed application object. | +| [provides](#output\_provides) | Map of the provided integration endpoints. | +| [requires](#output\_requires) | Map of the required integration endpoints. | diff --git a/terraform/charm/cloudflared/README.md b/terraform/charm/cloudflared/README.md index ce7a962..2b42e26 100644 --- a/terraform/charm/cloudflared/README.md +++ b/terraform/charm/cloudflared/README.md @@ -57,6 +57,48 @@ The complete list of available integrations can be found [in the Integrations ta +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | ~> 1.12 | +| [juju](#requirement\_juju) | ~> 1.0 | + +## Providers + +| Name | Version | +|------|---------| +| [juju](#provider\_juju) | ~> 1.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [juju_application.cloudflared](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/application) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [app\_name](#input\_app\_name) | Name of the application in the Juju model. | `string` | `"cloudflared"` | no | +| [base](#input\_base) | The operating system on which to deploy. | `string` | `null` | no | +| [channel](#input\_channel) | The channel to use when deploying a charm. | `string` | `"latest/stable"` | no | +| [config](#input\_config) | Application config. Details about available options can be found at https://charmhub.io/cloudflared/configurations | `map(string)` | `{}` | no | +| [constraints](#input\_constraints) | Juju constraints to apply for this application. | `string` | `null` | no | +| [model\_uuid](#input\_model\_uuid) | UUID of the Juju model where the application will be deployed. | `string` | n/a | yes | +| [revision](#input\_revision) | Revision number of the charm. | `number` | `null` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [application](#output\_application) | The deployed application object. | +| [provides](#output\_provides) | Map of the provided integration endpoints. | +| [requires](#output\_requires) | Map of the required integration endpoints. |