Skip to content

Commit

Permalink
additional hints on module structure
Browse files Browse the repository at this point in the history
  • Loading branch information
PacoVK committed Dec 29, 2023
1 parent 2dc197d commit 4161e17
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,18 @@ When you publish a Terraform module, a corresponding DeployKey must be created f
* Versioning must follow [Semantic Versioning](https://semver.org) specs
* Currently only `.zip` is supported.

**NOTE**: The zipped module directory layout should follow the [Terraform module structure](https://www.terraform.io/docs/language/modules/develop/structure.html).

Example:
```
module.zip
├── main.tf
├── outputs.tf
├── README.md
├── variables.tf
└── <any-other-file-or-directory>
```

You can simply upload modules to the registry via its HTTP REST-Api. It will return HTTP status `200` on success.
```shell
curl -XPOST -H 'x-api-key: <API_KEY>' --fail-with-body -F [email protected] "https://example.corp.com/terraform/modules/v1/<namespace>/<name>/<provider>/<version>"
Expand Down

0 comments on commit 4161e17

Please sign in to comment.