Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hashicorp/terraform-provider-hcs
Terraform provider for HashiCorp Consul Service on Azure.
https://github.com/hashicorp/terraform-provider-hcs
consul hashicorp-consul-service hcs terraform-provider
Last synced: about 1 month ago
JSON representation
Terraform provider for HashiCorp Consul Service on Azure.
- Host: GitHub
- URL: https://github.com/hashicorp/terraform-provider-hcs
- Owner: hashicorp
- License: mpl-2.0
- Created: 2020-11-23T20:49:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T05:32:55.000Z (4 months ago)
- Last Synced: 2024-09-27T12:41:57.594Z (about 2 months ago)
- Topics: consul, hashicorp-consul-service, hcs, terraform-provider
- Language: Go
- Homepage:
- Size: 771 KB
- Stars: 4
- Watchers: 239
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
HashiCorp Consul Service on Azure (HCS) Terraform Provider
==================
Requirements
------------
- [Terraform](https://www.terraform.io/downloads.html) >= 0.12.x
- [Go](https://golang.org/doc/install) >= 1.15
Building The Provider
---------------------
1. Clone the repository
1. Enter the repository directory
1. Build the provider using the `make dev` command
Adding Dependencies
---------------------
This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
Please see the Go documentation for the most up to date information about using Go modules.
To add a new dependency `github.com/author/dependency` to your Terraform provider:
```
go get github.com/author/dependency
go mod tidy
```
Then commit the changes to `go.mod` and `go.sum`.
Developing the Provider
---------------------------
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).
To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
To generate the latest models for the HCS Custom Resource Provider actions, run:
```
make generate-hcs-ama-api-spec-models
```
In order to run the full suite of Acceptance tests, run `make testacc`.
*Note:* Acceptance tests create real resources, and often cost money to run.
```sh
$ make testacc
```
Generating Docs
----------------------
From the root of the repo run:
```
go generate && go mod tidy
```
Using the provider
----------------------
Please see the docs for details about a particular resource.
Below is a complex example that leverages the Azure Terraform provider and creates a federation of two HCS clusters.
```hcl
// Configure the provider
provider "hcs" {}
provider "azurerm" {
features {}
}
// If you have not already done so, accept the HCS Marketplace agreement
data "hcs_plan_defaults" "hcs_plan" {}
resource "azurerm_marketplace_agreement" "hcs_marketplace_agreement" {
publisher = data.hcs_plan_defaults.hcs_plan.publisher
offer = data.hcs_plan_defaults.hcs_plan.offer
plan = data.hcs_plan_defaults.hcs_plan.plan_name
}
// Create the Resource Group for the primary cluster
resource "azurerm_resource_group" "primary" {
name = "hcs-tf-federation-primary-rg"
location = "westus2"
}
// Create the primary cluster
resource "hcs_cluster" "primary" {
resource_group_name = azurerm_resource_group.primary.name
managed_application_name = "hcs-tf-federation-primary"
email = "[email protected]"
cluster_mode = "production"
min_consul_version = "v1.9.0"
vnet_cidr = "172.25.16.0/24"
consul_datacenter = "hcs-tf-federation-example"
}
// Create a federation token
data "hcs_federation_token" "fed" {
resource_group_name = hcs_cluster.primary.resource_group_name
managed_application_name = hcs_cluster.primary.managed_application_name
}
// Create the Resource Group for the secondary cluster
resource "azurerm_resource_group" "secondary" {
name = "hcs-tf-federation-secondary-rg"
location = "eastus"
}
// Create the secondary cluster using the federation token from above
resource "hcs_cluster" "secondary" {
resource_group_name = azurerm_resource_group.secondary.name
managed_application_name = "hcs-tf-federation-secondary"
email = "[email protected]"
cluster_mode = "production"
min_consul_version = "v1.9.0"
vnet_cidr = "172.25.17.0/24"
consul_datacenter = "hcs-tf-federation-secondary"
consul_federation_token = data.hcs_federation_token.fed.token
}
```