From 6c266cf48e9054f3ceba2e7fc0374b1df8678b03 Mon Sep 17 00:00:00 2001 From: Orfeas Kourkakis Date: Wed, 18 Sep 2024 11:55:48 +0300 Subject: [PATCH] feat: Add terraform module --- .github/workflows/integrate.yaml | 8 ++++ .gitignore | 3 ++ terraform/README.md | 63 ++++++++++++++++++++++++++++++++ terraform/main.tf | 13 +++++++ terraform/outputs.tf | 16 ++++++++ terraform/variables.tf | 34 +++++++++++++++++ terraform/versions.tf | 9 +++++ tox.ini | 7 ++++ 8 files changed, 153 insertions(+) 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 afa22df..3818326 100644 --- a/.github/workflows/integrate.yaml +++ b/.github/workflows/integrate.yaml @@ -35,6 +35,14 @@ jobs: path: training-operator-cov_html if: failure() + terraform-checks: + name: Terraform + uses: canonical/charmed-kubeflow-workflows/.github/workflows/terraform-checks.yaml@main + with: + charm-path: . + model: kubeflow + channel: latest/edge + integration-test: name: Integration runs-on: ubuntu-20.04 diff --git a/.gitignore b/.gitignore index 1b5defe..88bfc70 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,6 @@ __pycache__ .tox .coverage *.charm +venv/ +.terraform* +*.tfstate* diff --git a/terraform/README.md b/terraform/README.md new file mode 100644 index 0000000..bc5c397 --- /dev/null +++ b/terraform/README.md @@ -0,0 +1,63 @@ +# Terraform module for training-operator + +This is a Terraform module facilitating the deployment of the training-operator 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). + +## Compatibility +This terraform module is compatible with charms of version >= 1.8 due to changes in the charm's relations. + +## 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(number) | Map of charm resources revisions | 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 "training-operator" { + 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 "training-operator" { + source = "" + model_name = data.juju_model.testing.name +} +``` diff --git a/terraform/main.tf b/terraform/main.tf new file mode 100644 index 0000000..8954c3d --- /dev/null +++ b/terraform/main.tf @@ -0,0 +1,13 @@ +resource "juju_application" "training_operator" { + charm { + name = "training-operator" + 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..4c41323 --- /dev/null +++ b/terraform/outputs.tf @@ -0,0 +1,16 @@ +output "app_name" { + value = juju_application.training_operator.name +} + +output "provides" { + value = { + grafana_dashboard = "grafana-dashboard", + metrics_endpoint = "metrics-endpoint", + } +} + +output "requires" { + value = { + dashboard_links = "dashboard-links" + } +} diff --git a/terraform/variables.tf b/terraform/variables.tf new file mode 100644 index 0000000..faa63ec --- /dev/null +++ b/terraform/variables.tf @@ -0,0 +1,34 @@ +variable "app_name" { + description = "Application name" + type = string + default = "training-operator" +} + +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 revisions" + 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 bebb1c3..f35dda7 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} \