From 29e87a851f72fed7a6603493957b6fe678ef464e Mon Sep 17 00:00:00 2001 From: Orfeas Kourkakis Date: Fri, 27 Sep 2024 14:56:44 +0300 Subject: [PATCH] feat: Add Terraform module (#156) Create a `terraform/` directory that hosts the Terraform module for this charm. It follows the structure proposed in [this spec](https://docs.google.com/document/d/1EG71A2pJ244PQRaGVzGj7Mx2B_bzE4U_OSqx4eeVI1E/edit) and it is follows what was done in canonical/argo-operators#198. Ref #152 --- .github/workflows/integrate.yaml | 8 ++++- .gitignore | 3 ++ terraform/README.md | 60 ++++++++++++++++++++++++++++++++ terraform/main.tf | 13 +++++++ terraform/outputs.tf | 15 ++++++++ terraform/variables.tf | 34 ++++++++++++++++++ terraform/versions.tf | 9 +++++ tox.ini | 7 ++++ 8 files changed, 148 insertions(+), 1 deletion(-) create mode 100644 terraform/README.md create mode 100644 terraform/main.tf create mode 100644 terraform/outputs.tf create mode 100644 terraform/variables.tf create mode 100644 terraform/versions.tf diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml index 42f05bb..7da6963 100644 --- a/.github/workflows/integrate.yaml +++ b/.github/workflows/integrate.yaml @@ -42,7 +42,13 @@ jobs: - name: Run unit tests run: tox -e unit - + + terraform-checks: + name: Terraform + uses: canonical/charmed-kubeflow-workflows/.github/workflows/terraform-checks.yaml@main + with: + charm-path: . + integration: name: Integration Tests runs-on: ubuntu-20.04 diff --git a/.gitignore b/.gitignore index 967174b..26b2d91 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,6 @@ build/ .tox/ __pycache__ .idea +venv/ +.terraform* +*.tfstate* diff --git a/terraform/README.md b/terraform/README.md new file mode 100644 index 0000000..ae54a34 --- /dev/null +++ b/terraform/README.md @@ -0,0 +1,60 @@ +# Terraform module for admission-webhook + +This is a Terraform module facilitating the deployment of the admission-webhook charm, using the [Terraform juju provider](https://github.com/juju/terraform-provider-juju/). For more information, refer to the provider [documentation](https://registry.terraform.io/providers/juju/juju/latest/docs). + +## Requirements +This module requires a `juju` model to be available. Refer to the [usage section](#usage) below for more details. + +## API + +### Inputs +The module offers the following configurable inputs: + +| Name | Type | Description | Required | +| - | - | - | - | +| `app_name`| string | Application name | False | +| `channel`| string | Channel that the charm is deployed from | False | +| `config`| map(string) | Map of the charm configuration options | False | +| `model_name`| string | Name of the model that the charm is deployed on | True | +| `resources`| map(string) | Map of the charm resources | False | +| `revision`| number | Revision number of the charm name | False | + +### Outputs +Upon applied, the module exports the following outputs: + +| Name | Description | +| - | - | +| `app_name`| Application name | +| `provides`| Map of `provides` endpoints | +| `requires`| Map of `reqruires` endpoints | + +## Usage + +This module is intended to be used as part of a higher-level module. When defining one, users should ensure that Terraform is aware of the `juju_model` dependency of the charm module. There are two options to do so when creating a high-level module: + +### Define a `juju_model` resource +Define a `juju_model` resource and pass to the `model_name` input a reference to the `juju_model` resource's name. For example: + +``` +resource "juju_model" "testing" { + name = kubeflow +} + +module "admission-webhook" { + source = "" + model_name = juju_model.testing.name +} +``` + +### Define a `data` source +Define a `data` source and pass to the `model_name` input a reference to the `data.juju_model` resource's name. This will enable Terraform to look for a `juju_model` resource with a name attribute equal to the one provided, and apply only if this is present. Otherwise, it will fail before applying anything. +``` +data "juju_model" "testing" { + name = var.model_name +} + +module "admission-webhook" { + source = "" + model_name = data.juju_model.testing.name +} +``` diff --git a/terraform/main.tf b/terraform/main.tf new file mode 100644 index 0000000..dd26ab4 --- /dev/null +++ b/terraform/main.tf @@ -0,0 +1,13 @@ +resource "juju_application" "admission_webhook" { + charm { + name = "admission-webhook" + channel = var.channel + revision = var.revision + } + config = var.config + model = var.model_name + name = var.app_name + resources = var.resources + trust = true + units = 1 +} diff --git a/terraform/outputs.tf b/terraform/outputs.tf new file mode 100644 index 0000000..8d44516 --- /dev/null +++ b/terraform/outputs.tf @@ -0,0 +1,15 @@ +output "app_name" { + value = juju_application.admission_webhook.name +} + +output "provides" { + value = { + pod_defaults = "pod-defaults", + } +} + +output "requires" { + value = { + "logging" = "logging", + } +} diff --git a/terraform/variables.tf b/terraform/variables.tf new file mode 100644 index 0000000..29141b6 --- /dev/null +++ b/terraform/variables.tf @@ -0,0 +1,34 @@ +variable "app_name" { + description = "Application name" + type = string + default = "admission-webhook" +} + +variable "channel" { + description = "Charm channel" + type = string + default = null +} + +variable "config" { + description = "Map of charm configuration options" + type = map(string) + default = {} +} + +variable "model_name" { + description = "Model name" + type = string +} + +variable "resources" { + description = "Map of resources" + type = map(string) + default = null +} + +variable "revision" { + description = "Charm revision" + type = number + default = null +} diff --git a/terraform/versions.tf b/terraform/versions.tf new file mode 100644 index 0000000..eb357ca --- /dev/null +++ b/terraform/versions.tf @@ -0,0 +1,9 @@ +terraform { + required_version = ">= 1.6" + required_providers { + juju = { + source = "juju/juju" + version = "~> 0.14.0" + } + } +} diff --git a/tox.ini b/tox.ini index 359317f..660727e 100644 --- a/tox.ini +++ b/tox.ini @@ -64,6 +64,13 @@ deps = -r requirements-lint.txt description = Check code against coding style standards +[testenv:tflint] +allowlist_externals = + tflint +commands = + tflint --chdir=terraform --recursive +description = Check Terraform code against coding style standards + [testenv:unit] commands = coverage run --source={[vars]src_path} \