Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erikvanbrakel/anthology
A private Terraform registry implementation as an alternative to the official registry.
https://github.com/erikvanbrakel/anthology
registry terraform
Last synced: about 2 months ago
JSON representation
A private Terraform registry implementation as an alternative to the official registry.
- Host: GitHub
- URL: https://github.com/erikvanbrakel/anthology
- Owner: erikvanbrakel
- License: mit
- Created: 2018-04-08T17:25:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-12-03T04:12:40.000Z (almost 3 years ago)
- Last Synced: 2024-06-20T08:22:18.280Z (3 months ago)
- Topics: registry, terraform
- Language: Go
- Homepage:
- Size: 7.97 MB
- Stars: 132
- Watchers: 6
- Forks: 22
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-terraform - anthology - Private Terraform registry implementation as an alternative to the official registry. (Private Module Registries / Miscellaneous)
- awesome-tf - anthology - Private Terraform registry implementation as an alternative to the official registry. (Self-Hosted Registries / Miscellaneous)
README
[](https://gitter.im/anthology-registry/community)
# Anthology, a private Terraform Registry
## Description
Anthology is a reimplementation of the Terraform Registry API, intended to be used when your modules can't, shouldn't
or don't need to be public. For all means and purposes it works in the same way as the [public registry][terraform-registry].
## How to use
### Using Docker
Every release is automatically published to the [Docker Hub][docker-hub]. You can set commandline parameters by
overriding the command.
__running on port `80`, using `my-module-bucket` for storage:__
`docker run -p 80:80 erikvanbrakel/anthology --port=80 --backend=s3 --s3.bucket=my-module-bucket`
__using docker-compose__
```yaml
version: '2.1'
services:
registry:
command: --port=80 --backend=s3 --s3.bucket=my-module-bucket
build: erikvanbrakel/anthology:latest
ports:
- 80:80
```
### AWS + terraform
The easiest way to deploy is to use the [anthology module][anthology-module] in the [public registry][terraform-registry].
```hcl
module "anthology" {
source = "erikvanbrakel/anthology/aws"
version = "0.0.2"
storage_bucket = "this-bucket-stores-my-modules"
tld = "example.com" # the registry will be hosted at registry.example.com
}
```
__WARNING WARNING WARNING__
This module provisions several resources, among which compute and storage components. This is not free, so make sure you
are aware of the cost before provisioning!
## Command line parameters
### Common parameters
| Parameter | Description | Allowed | Default |
| --------------------- | --------------------------------- | ------------------------ | ------- |
| --port | Port to listen on | 1-65535 | 1234 |
| --backend | Backend to use. | [memory, filesystem, s3] | |
| --ssl.certificate | Path to the server certificate | Any valid path | |
| --ssl.key | Path to the server certificate | Any valid path | |
### Filesystem backend
| Parameter | Description | Allowed | Default |
| --------------------- | --------------------------------- | ------------------------ | ------- |
| --filesystem.basepath | Base path for module storage | Any valid path | |
### S3 backend
| Parameter | Description | Allowed | Default |
| --------------------- | --------------------------------- | -------------------------- | ------- |
| --s3.bucket | Name of the S3 bucket for storage | Any valid s3 bucket name | |
| --s3.endpoint | Alternative S3 endpoint | http[s]://[hostname]:[port]| |
[terraform-registry]: https://registry.terraform.io/
[anthology-module]: https://registry.terraform.io/modules/erikvanbrakel/anthology/aws/
[docker-hub]: https://hub.docker.com/r/erikvanbrakel/anthology/