-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
14cbbf4
commit b1fe78e
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Terraform module for mongodb-operator | ||
|
||
This is a Terraform module facilitating the deployment of the MongoDB charm with [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 | | ||
| `base`| string | The series to be used for this charm | 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 | | ||
| `units`| number | Number of units to be deployed | False | | ||
| `constraints`| string | Machine constraints for the charm | False | | ||
| `storage`| map(string) | Storage description, must follow the juju provider schema | False | | ||
|
||
|
||
### Outputs | ||
Upon applied, the module exports the following outputs: | ||
|
||
| Name | Description | | ||
| - | - | | ||
| `app_name`| Application name | | ||
| `provides`| Map of `provides` endpoints | | ||
| `requires`| Map of `requires` 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" "mongodb" { | ||
name = mongodb | ||
} | ||
module "mongodb-operator" { | ||
source = "<path-to-this-directory>" | ||
model_name = juju_model.mongodb.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" "mongodb" { | ||
name = var.model_name | ||
} | ||
module "mongodb" { | ||
source = "<path-to-this-directory>" | ||
model_name = data.juju_model.mongodb.name | ||
} | ||
``` |