diff --git a/terraform/README.md b/terraform/README.md index be5eba4..dea0487 100644 --- a/terraform/README.md +++ b/terraform/README.md @@ -33,6 +33,7 @@ No providers. | Name | Source | Version | |------|--------|---------| +| [online-storage-dept](#module\_online-storage-dept) | ./modules/online-storage | n/a | | [ssrc-jupyter-dept](#module\_ssrc-jupyter-dept) | ./modules/jupyter | n/a | ## Resources @@ -47,7 +48,9 @@ No resources. ## Outputs -No outputs. +| Name | Description | +|------|-------------| +| [ip\_address](#output\_ip\_address) | The JupyterHub server's IP address | --- diff --git a/terraform/modules/jupyter/README.md b/terraform/modules/jupyter/README.md index ccd4956..27b2118 100644 --- a/terraform/modules/jupyter/README.md +++ b/terraform/modules/jupyter/README.md @@ -44,6 +44,7 @@ No modules. | Name | Description | |------|-------------| | [access\_url](#output\_access\_url) | The URL from which Jupyter can be accessed | +| [ip\_address](#output\_ip\_address) | The server's IP address | --- diff --git a/terraform/modules/online-storage/README.md b/terraform/modules/online-storage/README.md new file mode 100644 index 0000000..3f37aa2 --- /dev/null +++ b/terraform/modules/online-storage/README.md @@ -0,0 +1,45 @@ + +## Requirements + +| Name | Version | +|------|---------| +| [harvester](#requirement\_harvester) | >= 0.6.4 | + +## Providers + +| Name | Version | +|------|---------| +| [harvester](#provider\_harvester) | >= 0.6.4 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [harvester_cloudinit_secret.server](https://registry.terraform.io/providers/harvester/harvester/latest/docs/resources/cloudinit_secret) | resource | +| [harvester_virtualmachine.server](https://registry.terraform.io/providers/harvester/harvester/latest/docs/resources/virtualmachine) | resource | +| [harvester_volume.mount-disk](https://registry.terraform.io/providers/harvester/harvester/latest/docs/resources/volume) | resource | +| [harvester_image.rhel9](https://registry.terraform.io/providers/harvester/harvester/latest/docs/data-sources/image) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [disk\_settings](#input\_disk\_settings) | A map of disk settings | `map(string)` | `{}` | no | +| [namespace](#input\_namespace) | Namespace for the storage | `string` | n/a | yes | +| [network\_name](#input\_network\_name) | Name of the SSRC network | `string` | n/a | yes | +| [public\_key\_openssh](#input\_public\_key\_openssh) | SSH public key | `string` | n/a | yes | +| [ssh\_username](#input\_ssh\_username) | SSH username for the VM | `string` | `"cloud-user"` | no | +| [vm\_prefix](#input\_vm\_prefix) | Name of the VM | `string` | `"nfs"` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [server\_ip](#output\_server\_ip) | IP address to connect to the NFS server | + +--- + \ No newline at end of file