Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/secrethub/terraform-provider-secrethub
Terraform Provider to manage and use secrets
https://github.com/secrethub/terraform-provider-secrethub
go golang hacktoberfest secrethub secrets secrets-management terraform terraform-provider
Last synced: about 2 months ago
JSON representation
Terraform Provider to manage and use secrets
- Host: GitHub
- URL: https://github.com/secrethub/terraform-provider-secrethub
- Owner: secrethub
- License: apache-2.0
- Archived: true
- Created: 2018-11-29T10:46:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-15T15:09:34.000Z (over 3 years ago)
- Last Synced: 2024-06-20T09:11:53.490Z (3 months ago)
- Topics: go, golang, hacktoberfest, secrethub, secrets, secrets-management, terraform, terraform-provider
- Language: Go
- Homepage: https://secrethub.io
- Size: 434 KB
- Stars: 49
- Watchers: 9
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tf - terraform-provider-secrethub - Provider for SecretHub. :skull: (Providers / Vendor supported providers)
README
SecretHub has joined 1Password! Find out more on the SecretHub blog. 🎉
# Terraform Provider
[][godoc]
[][circleci]
[][goreportcard]
[][latest-version]
[][discord]
[](https://github.com/shuaibiyy/awesome-terraform)
> [SecretHub][secrethub] is a secrets management tool that works for every engineer. Securely provision passwords and keys throughout your entire stack with just a few lines of code.
The SecretHub Terraform Provider lets you manage your secrets using Terraform.
It is officially supported and actively maintained by SecretHub, but community contributions are very welcome.
## Usage
### Terraform v0.13
```hcl
terraform {
required_providers {
secrethub = {
source = "secrethub/secrethub"
version = ">= 1.2.0"
}
}
}
resource "secrethub_secret" "db_password" {
path = "my-org/my-repo/db/password"
generate {
length = 22
charsets = ["alphanumeric"]
}
}
resource "secrethub_secret" "db_username" {
path = "my-org/my-repo/db/username"
value = "db-user"
}
resource "aws_db_instance" "default" {
allocated_storage = 10
storage_type = "gp2"
engine = "mysql"
engine_version = "5.7"
instance_class = "db.t2.micro"
name = "mydb"
username = secrethub_secret.db_username.value
password = secrethub_secret.db_password.value
parameter_group_name = "default.mysql5.7"
}
```
Have a look at the [reference docs](https://registry.terraform.io/providers/secrethub/secrethub/latest/docs) for more information on the supported resources and data sources.
### Terraform v0.12 and below
Manually install the secrethub provider by downloading the binary for your platform and moving it to `~/.terraform/plugins` or `%APPDATA%\terraform.d\plugins` on Windows.
Afterwards you can run the following example with Terraform.
```hcl
provider "secrethub" {}
resource "secrethub_secret" "db_password" {
path = "my-org/my-repo/db/password"
generate {
length = 22
charsets = ["alphanumeric"]
}
}
resource "secrethub_secret" "db_username" {
path = "my-org/my-repo/db/username"
value = "db-user"
}
resource "aws_db_instance" "default" {
allocated_storage = 10
storage_type = "gp2"
engine = "mysql"
engine_version = "5.7"
instance_class = "db.t2.micro"
name = "mydb"
username = secrethub_secret.db_username.value
password = secrethub_secret.db_password.value
parameter_group_name = "default.mysql5.7"
}
```
Have a look at the [reference docs](https://registry.terraform.io/providers/secrethub/secrethub/latest/docs) for more information on the supported resources and data sources.
## [Get Started]((https://secrethub.io/docs/terraform/))
Check out the [step-by-step integration guide](https://secrethub.io/docs/terraform/) to get started.
A detailed use case is described in the [original announcement](https://secrethub.io/blog/secret-management-for-terraform/).
There are also some [examples](/examples) in this repo.
## Support
If you need help, send us a message on the `#terraform` channel on [
Discord](https://discord.gg/wcxV5RD) or send an email to [[email protected]](mailto:[email protected])
## Development
### Building
Get the source code:
```
git clone https://github.com/secrethub/terraform-provider-secrethub
```
Build it using:
```
make build
```
### Testing
To run the [acceptance tests](https://www.terraform.io/docs/extend/testing/acceptance-tests/index.html), the following environment variables need to be set up.
* `SECRETHUB_CREDENTIAL` - a SecretHub credential.
* `SECRETHUB_TF_ACC_NAMESPACE` - a namespace registered on SecretHub. Make sure `SECRETHUB_CREDENTIAL` has admin access.
* `SECRETHUB_TF_ACC_REPOSITORY` - a repository within `SECRETHUB_TF_ACC_NAMESPACE` to be used in the acceptance tests. Make sure `SECRETHUB_CREDENTIAL` has admin access.
* `SECRETHUB_TF_ACC_SECOND_ACCOUNT_NAME` - an account other than the authenticated account, that is a member of the repository. It will be used to test access rules.
Only for the AWS acceptance tests:
* `SECRETHUB_TF_ACC_AWS_ROLE` - an AWS IAM role to use for testing AWS service accounts. The role should have decrypt permission on the key in `SECRETHUB_TF_ACC_AWS_KMS_KEY`.
* `SECRETHUB_TF_ACC_AWS_KMS_KEY` - an AWS KMS key to use for testing AWS service accounts. The authenticated AWS user or role should have encrypt permission on this key and the `SECRETHUB_TF_ACC_AWS_ROLE` should have decrypt permission.
Only for the GCP acceptance tests:
* `SECRETHUB_TF_ACC_GCP_SERVICE_ACCOUNT` - a GCP service account email to use for testing SecretHub GCP service accounts. It should have decrypt permission on the key in `SECRETHUB_TF_ACC_GCP_KMS_KEY`.
* `SECRETHUB_TF_ACC_GCP_KMS_KEY` - an GCP KMS key to use for testing GCP service accounts. The authenticated GCP user or role should have encrypt permission on this key and the `SECRETHUB_TF_ACC_GCP_SERVICE_ACCOUNT` should have decrypt permission.
With the environment variables properly set up, run:
```
make testacc
```
[secrethub]: https://secrethub.io
[godoc]: https://godoc.org/github.com/secrethub/terraform-provider-secrethub
[circleci]: https://circleci.com/gh/secrethub/terraform-provider-secrethub
[discord]: https://discord.gg/wcxV5RD
[latest-version]: https://github.com/secrethub/terraform-provider-secrethub/releases/latest
[goreportcard]: https://goreportcard.com/report/github.com/secrethub/terraform-provider-secrethub