diff --git a/terraform/charm/README.md b/terraform/charm/README.md index a037c60..d377dcc 100644 --- a/terraform/charm/README.md +++ b/terraform/charm/README.md @@ -55,6 +55,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) | ~> 2.0 | + +## Providers + +| Name | Version | +|------|---------| +| [juju](#provider\_juju) | ~> 2.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [juju_application.aproxy](https://registry.terraform.io/providers/juju/juju/latest/docs/resources/application) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [app\_name](#input\_app\_name) | Application name for aproxy. | `string` | `"aproxy"` | 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/aproxy/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. |