Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devoteamgcloud/petra
Private Terraform Registry Manager
https://github.com/devoteamgcloud/petra
go google-cloud-platform google-cloud-storage private-registry terraform
Last synced: about 1 month ago
JSON representation
Private Terraform Registry Manager
- Host: GitHub
- URL: https://github.com/devoteamgcloud/petra
- Owner: devoteamgcloud
- License: apache-2.0
- Created: 2022-02-15T20:40:01.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T20:17:34.000Z (6 months ago)
- Last Synced: 2024-08-02T00:26:28.459Z (4 months ago)
- Topics: go, google-cloud-platform, google-cloud-storage, private-registry, terraform
- Language: Go
- Homepage: https://devoteamgcloud.github.io/petra/
- Size: 13.7 MB
- Stars: 41
- Watchers: 1
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-opentofu - petra - Private registry manager using Google Cloud Storage. (Tools / Registry)
- awesome-tf - petra - Private Terraform Registry Manager (Self-Hosted Registries / Miscellaneous)
README
Petra (Private Terraform Registry)
Petra is a lightweight tool that allows to host your own private Terraform registry using Google Cloud Storage as a storage backend.
Petra is not an official Devoteam product and is provided as-is to the community.
## Components
### petra (server)
Server to get a terraform module versions / get a signed URL to download a module from a private registry (Google Cloud Storage bucket).
Configured by the following env vars :
- `GCS_BUCKET`: Bucket used to host Terraform modules
- `SIGNED_URL`: (Optional) Enables the use of a Signed URL for the download api routes. Defaults to false and just forwards a gcs:// link
### petractl (cli)
CLI to upload / remove / upload a terraform module to a private registry (Google Cloud Storage bucket).
Example usage :
```bash
petractl push --bucket tf-registry-petra ../tests/mod1
```
## Deployment
#### Deploy Server on Cloud Run
Cloud Run's service account must have the following roles:
- Service Account Token Creator (used to create signed url)
- Storage Object Admin (access objects in bucket) for the bucket where you store the terraform modules.
Then `terraform init`:
```terraform
// main.tf
module "my_module" {
source = "{CLOUD_RUN_URL}/{NAMESPACE}/{MODULE}/{PROVIDER}/{VERSION}"
}
```
or specify the module version separately :
```terraform
// main.tf
module "my_module" {
source = "{CLOUD_RUN_URL}/{NAMESPACE}/{MODULE}/{PROVIDER}"
version = "{VERSION}"
}
```
### Deploy Server on GKE with Workload Identity
Activate [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity) and the service account must have the following roles:
- Service Account Token Creator (create signed url)
- Storage Object Admin (access objects in bucket) for the bucket where you store the terraform modules
Then `terraform init`:
```terraform
// main.tf
module "my_module" {
source = "{PETRA_SERVER}/{NAMESPACE}/{MODULE}/{PROVIDER}"
version = "{VERSION}"
}
```
## Development
Follow these steps if you are OK installing and using Go on your machine.
1. Install [Go](https://golang.org/doc/install).
1. Install [Visual Studio Code](https://code.visualstudio.com/).
1. Install [Go extension](https://code.visualstudio.com/docs/languages/go).
1. Clone and open this repository.
1. `F1` -> `Go: Install/Update Tools` -> (select all) -> OK.
## Release
The release workflow is triggered each time a tag with `v` prefix is pushed.
_CAUTION_: Make sure to understand the consequences before you bump the major version. More info: [Go Wiki](https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher), [Go Blog](https://blog.golang.org/v2-go-modules).
## Maintainance
Remember to update Go version in [.github/workflows](.github/workflows)
Notable files:
- [.github/workflows](.github/workflows) - GitHub Actions workflows,
- [.github/dependabot.yml](.github/dependabot.yml) - Dependabot configuration,
- [.goreleaser.yml](.goreleaser.yml) - GoReleaser configuration,
- [go.mod](go.mod) - [Go module definition](https://github.com/golang/go/wiki/Modules#gomod),
## Contributing
Simply create an issue or a pull request.
## FAQ
### How can I customize the release or add deb/rpm/snap packages, Homebrew Tap, Scoop App Manifest etc
Take a look at GoReleaser [docs](https://goreleaser.com/customization/) as well as [its repo](https://github.com/goreleaser/goreleaser/) how it is dogfooding its functionality.