Merge pull request #18 from canonical/update-terraform-files

chore: Housekeeping Terraform modules mostly to spec

Author: pedro-avalos

charmcraft.yaml

@@ -22,12 +22,10 @@ charm-libs:
 config:
   options:
     config-file:
-      description: |
-        Text contents of the conserver.cf config file.
+      description: Base64 encoded contents of the conserver.cf configuration file.
       type: string
     passwd-file:
-      description: |
-        Base64 encoded contents of the passwd file.
+      description: Base64 encoded contents of the conserver.passwd file.
       default: "IyBDb25zZXJ2ZXIgcGFzc3dkIGZpbGUKIyBGb3JtYXQ6IHVzZXJuYW1lOiQxJFkwWmpNbTJoJG9NWDVVeUxpMS95MFE5SVJXZjN2LzAKIyB5b3UgY2FuIGdlbmVyYXRlIHRoZSBoYXNoZWQgcGFzc3dvcmQgdXNpbmcgYG9wZW5zc2wgcGFzc3dkIC0xYAo="
       type: string
 

terraform/README.md

@@ -0,0 +1,46 @@
+# Terraform Module for Conserver
+
+This is a Terraform module facilitating the deployment of the Conserver charm,
+using the [Terraform Juju provider][juju-provider]. For more information, refer
+to the provider [documentation][juju-provider-docs].
+
+## Requirements
+
+This module requires a `juju` model to be available. Refer to the
+[usage section](#usage) below for more details
+
+## API
+
+### Inputs
+
+| Name          | Type   | Description                                                                       | Default       |
+| ------------- | ------ | --------------------------------------------------------------------------------- | ------------- |
+| app_name      | string | Name to give the deployed application                                             | conserver     |
+| charm_channel | string | Channel of the charm                                                              | latest/stable |
+| config_file   | string | Base64 encoded contents of conserver.cf                                           |               |
+| constraints   | string | String listing constraints for this application                                   | arch=amd64    |
+| juju_model    | string | Reference to an existing model resource or data source for the model to deploy to |               |
+| passwd_file   | string | Base64 encoded contents of conserver.passwd                                       |               |
+| revision      | number | Revision number of the charm                                                      | null          |
+
+### Outputs
+
+| Name     | Type   | Description                      |
+| -------- | ------ | -------------------------------- |
+| app_name | string | Name of the deployed application |
+
+## Usage
+
+### Basic Usage
+
+Users should ensure that Terraform is aware of the `juju_model` dependency of
+the charm module.
+
+To deploy this module, you can run
+
+```shell
+terraform apply -var="juju_model=<MODEL_NAME>" -auto-approve
+```
+
+[juju-provider]: https://github.com/juju/terraform-provider-juju/
+[juju-provider-docs]: https://registry.terraform.io/providers/juju/juju/latest/docs

terraform/main.tf

@@ -1,13 +1,14 @@
 resource "juju_application" "conserver" {
-  name  = "conserver"
-  model = var.juju_model
-
-  units = 1
+  name        = var.app_name
+  constraints = var.constraints
+  model       = var.juju_model
+  units       = 1
 
   charm {
-    name    = "conserver"
-    base    = "[email protected]"
-    channel = var.charm_channel
+    name     = "conserver"
+    base     = "[email protected]"
+    channel  = var.charm_channel
+    revision = var.revision
   }
 
   config = {

terraform/outputs.tf

@@ -0,0 +1,4 @@
+output "app_name" {
+  description = "Name of the deployed application"
+  value       = juju_application.conserver.name
+}

terraform/variables.tf

@@ -1,20 +1,40 @@
-variable "juju_model" {
-  description = "Name of the Juju model to deploy into"
+variable "app_name" {
+  description = "Name to give the deployed application"
   type        = string
+  default     = "conserver"
 }
 
 variable "charm_channel" {
-  description = "Channel to use for the charm (e.g., 'latest/stable')"
+  description = "Channel of the charm"
   type        = string
   default     = "latest/stable"
 }
 
 variable "config_file" {
-  description = "Content for the conserver.cf configuration file"
+  description = "Base64 encoded content for the conserver.cf configuration file"
+  type        = string
+}
+
+variable "constraints" {
+  description = "String listing constraints for this application"
+  type        = string
+  default     = "arch=amd64"
+}
+
+variable "juju_model" {
+  description = "Reference to an existing model resource or data source for the model to deploy to"
   type        = string
 }
 
 variable "passwd_file" {
   description = "Base64 encoded content for the conserver.passwd file"
   type        = string
-}
+  sensitive   = true
+}
+
+variable "revision" {
+  description = "Revision number of the charm"
+  type        = number
+  nullable    = true
+  default     = null
+}