2020-09-16 16:34:26 -04:00
Terraform Provider Boundary
2020-05-14 17:06:23 -07:00
==================
Requirements
------------
- [Terraform ](https://www.terraform.io/downloads.html ) >= 0.12.x
- [Go ](https://golang.org/doc/install ) >= 1.12
Building The Provider
---------------------
1. Clone the repository
1. Enter the repository directory
2020-09-17 16:27:48 -04:00
1. Build the provider using `make dev` . This will place the provider onto your system in a [Terraform 0.13-compliant ](https://www.terraform.io/upgrade-guides/0-13.html#in-house-providers ) manner.
You'll need to ensure that your Terraform file contains the information necessary to find the plugin when running `terraform init` . `make dev` will use a version number of 0.0.1, so the following block will work:
```hcl
terraform {
required_providers {
boundary = {
source = "localhost/providers/boundary"
version = "0.0.1"
}
}
}
2020-05-14 17:06:23 -07:00
```
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` .
Using the provider
----------------------
2020-09-03 15:53:29 -07:00
Please see our detailed docs for individual resource usage. Below is a complex example using the Boundary provider to configure all resource types available:
```hcl
provider "boundary" {
2020-09-16 16:34:26 -04:00
addr = "http://127.0.0.1:9200"
auth_method_id = "ampw_1234567890" # changeme
password_auth_method_login_name = "myuser" # changeme
password_auth_method_password = "passpass" # changeme
2020-09-03 15:53:29 -07:00
}
variable "backend_team" {
2020-09-16 16:34:26 -04:00
type = set ( string )
2020-09-03 15:53:29 -07:00
default = [
"Jim Lambert" ,
"Mike Gaffney" ,
"Todd Knight" ,
]
}
variable "frontend_team" {
2020-09-16 16:34:26 -04:00
type = set ( string )
2020-09-03 15:53:29 -07:00
default = [
2020-09-16 16:34:26 -04:00
"Randall Morey" ,
2020-09-03 15:53:29 -07:00
"Susmitha Girumala" ,
]
}
variable "leadership_team" {
2020-09-16 16:34:26 -04:00
type = set ( string )
2020-09-03 15:53:29 -07:00
default = [
"Jeff Mitchell" ,
"Pete Pacent" ,
"Jonathan Thomas (JT)" ,
"Jeff Malnick"
]
}
2020-09-16 16:34:26 -04:00
variable "web_server_ips" {
type = set ( string )
2020-09-03 15:53:29 -07:00
default = [
"10.0.0.1" ,
"10.0.0.2" ,
]
}
variable "backend_server_ips" {
2020-09-16 16:34:26 -04:00
type = set ( string )
2020-09-03 15:53:29 -07:00
default = [
"10.1.0.1" ,
"10.1.0.2" ,
]
}
2020-09-16 16:34:26 -04:00
variable "frontend_server_ips" {
type = set ( string )
default = [
"10.2.0.1" ,
"10.2.0.2" ,
]
}
resource "boundary_scope" "global" {
global_scope = true
scope_id = "global"
}
resource "boundary_scope" "corp" {
scope_id = boundary_scope . global . id
auto_create_role = true
}
2020-09-03 15:53:29 -07:00
resource "boundary_user" "backend" {
for_each = var . backend_team
name = each . key
description = "Backend user: ${each.key}"
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . corp . id
2020-09-03 15:53:29 -07:00
}
resource "boundary_user" "frontend" {
for_each = var . frontend_team
name = each . key
description = "Frontend user: ${each.key}"
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . corp . id
2020-09-03 15:53:29 -07:00
}
resource "boundary_user" "leadership" {
for_each = var . leadership_team
name = each . key
description = "WARNING: Managers should be read-only"
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . corp . id
2020-09-03 15:53:29 -07:00
}
// organiation level group for the leadership team
resource "boundary_group" "leadership" {
name = "leadership_team"
description = "Organization group for leadership team"
member_ids = [ for user in boundary_user . leadership : user . id ]
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . corp . id
2020-09-03 15:53:29 -07:00
}
// add org - level role for readonly access
resource "boundary_role" "organization_readonly" {
name = "readonly"
description = "Read-only role"
2020-09-16 16:34:26 -04:00
principal_ids = [ boundary_group . leadership . id ]
grant_strings = ["id = *;actions = read " ]
scope_id = boundary_scope . corp . id
2020-09-03 15:53:29 -07:00
}
// add org - level role for administration access
resource "boundary_role" "organization_admin" {
name = "admin"
description = "Administrator role"
2020-09-16 16:34:26 -04:00
principal_ids = concat (
2020-09-03 15:53:29 -07:00
[ for user in boundary_user . backend : user . id ],
[ for user in boundary_user . frontend : user . id ]
)
2020-09-16 16:34:26 -04:00
grant_strings = ["id = *;actions = create , read , update , delete " ]
scope_id = boundary_scope . corp . id
2020-09-03 15:53:29 -07:00
}
// create a project for core infrastructure
2020-09-16 16:34:26 -04:00
resource "boundary_scope" "core_infra" {
description = "Core infrastrcture"
scope_id = boundary_scope . corp . id
auto_create_role = true
2020-09-03 15:53:29 -07:00
}
resource "boundary_group" "backend_core_infra" {
name = "backend"
description = "Backend team group"
member_ids = [ for user in boundary_user . backend : user . id ]
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
}
resource "boundary_group" "frontend_core_infra" {
name = "frontend"
description = "Frontend team group"
member_ids = [ for user in boundary_user . frontend : user . id ]
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
}
2020-05-14 17:06:23 -07:00
2020-09-03 15:53:29 -07:00
resource "boundary_host" "backend_servers_service" {
for_each = var . backend_server_ips
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "backend_server_service_${each.value}"
description = "Backend server host for service port"
address = "${each.key}:9200"
host_catalog_id = boundary_host_catalog . backend_servers . id
}
resource "boundary_host" "backend_servers_ssh" {
for_each = var . backend_server_ips
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "backend_server_ssh_${each.value}"
description = "Backend server host for SSH port"
address = "${each.key}:22"
host_catalog_id = boundary_host_catalog . backend_servers . id
}
resource "boundary_host" "frontend_servers_console" {
for_each = var . frontend_server_ips
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "frontend_server_console_${each.value}"
description = "Frontend server host for console port"
address = "${each.key}:443"
2020-09-16 16:34:26 -04:00
host_catalog_id = boundary_host_catalog . frontend_servers . id
2020-09-03 15:53:29 -07:00
}
resource "boundary_host" "frontend_servers_ssh" {
for_each = var . frontend_server_ips
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "frontend_server_ssh_${each.value}"
description = "Frontend server host for SSH port"
address = "${each.key}:22"
2020-09-16 16:34:26 -04:00
host_catalog_id = boundary_host_catalog . frontend_servers . id
2020-09-03 15:53:29 -07:00
}
resource "boundary_host_catalog" "web_servers" {
name = "web_servers"
description = "Web servers for frontend team"
2020-09-16 16:34:26 -04:00
type = "static"
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
}
resource "boundary_host_catalog" "backend_servers" {
name = "backend_servers"
description = "Web servers for backend team"
2020-09-16 16:34:26 -04:00
type = "static"
scope_id = boundary_scope . core_infra . id
}
resource "boundary_host_catalog" "frontend_servers" {
name = "frontend_servers"
description = "Web servers for backend team"
type = "static"
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
}
resource "boundary_host_set" "backend_servers_service" {
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "backend_servers_service"
description = "Host set for services servers"
host_catalog_id = boundary_host_catalog . backend_servers . id
host_ids = [ for host in boundary_host . backend_servers_service : host . id ]
}
resource "boundary_host_set" "backend_servers_ssh" {
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "backend_servers_ssh"
description = "Host set for backend servers SSH access"
host_catalog_id = boundary_host_catalog . backend_servers . id
host_ids = [ for host in boundary_host . backend_servers_ssh : host . id ]
}
resource "boundary_host_set" "frontend_servers_console" {
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "frontend_servers_console"
description = "Host set for frontend servers console access"
2020-09-16 16:34:26 -04:00
host_catalog_id = boundary_host_catalog . frontend_servers . id
2020-09-03 15:53:29 -07:00
host_ids = [ for host in boundary_host . frontend_servers_console : host . id ]
}
resource "boundary_host_set" "frontend_servers_ssh" {
2020-09-16 16:34:26 -04:00
type = "static"
2020-09-03 15:53:29 -07:00
name = "frontend_servers_ssh"
description = "Host set for frontend servers SSH access"
2020-09-16 16:34:26 -04:00
host_catalog_id = boundary_host_catalog . frontend_servers . id
2020-09-03 15:53:29 -07:00
host_ids = [ for host in boundary_host . frontend_servers_ssh : host . id ]
}
resource "boundary_target" "frontend_servers_console" {
2020-09-16 16:34:26 -04:00
type = "tcp"
2020-09-03 15:53:29 -07:00
name = "frontend_servers_console"
description = "Frontend console target"
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
host_set_ids = [
boundary_host_set . frontend_servers_console . id
]
}
resource "boundary_target" "frontend_servers_ssh" {
2020-09-16 16:34:26 -04:00
type = "tcp"
2020-09-03 15:53:29 -07:00
name = "frontend_servers_ssh"
description = "Frontend SSH target"
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
host_set_ids = [
boundary_host_set . frontend_servers_ssh . id
]
}
resource "boundary_target" "backend_servers_service" {
2020-09-16 16:34:26 -04:00
type = "tcp"
2020-09-03 15:53:29 -07:00
name = "backend_servers_service"
description = "Backend service target"
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
host_set_ids = [
2020-09-16 16:34:26 -04:00
boundary_host_set . backend_servers_service . id
2020-09-03 15:53:29 -07:00
]
}
resource "boundary_target" "backend_servers_ssh" {
2020-09-16 16:34:26 -04:00
type = "tcp"
2020-09-03 15:53:29 -07:00
name = "backend_servers_ssh"
description = "Backend SSH target"
2020-09-16 16:34:26 -04:00
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
host_set_ids = [
2020-09-16 16:34:26 -04:00
boundary_host_set . backend_servers_ssh . id
2020-09-03 15:53:29 -07:00
]
}
// only allow the backend team access to the backend web servers host catalog
resource "boundary_role" "admin_backend_core_infra" {
description = "Administrator role for backend core infrastructure"
2020-09-16 16:34:26 -04:00
principal_ids = [ boundary_group . backend_core_infra . id ]
grant_strings = ["id = ${boundary_host_catalog.backend_servers.id};actions = create , read , update , delete " ]
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
}
// only allow the frontend team access to the frontend web servers host catalog
resource "boundary_role" "admin_frontend_core_infra" {
description = "Administrator role for frontend core infrastructure"
2020-09-16 16:34:26 -04:00
principal_ids = [ boundary_group . frontend_core_infra . id ]
grant_strings = ["id = ${boundary_host_catalog.web_servers.id};actions = create , read , update , delete " ]
scope_id = boundary_scope . core_infra . id
2020-09-03 15:53:29 -07:00
}
2020-09-16 16:34:26 -04:00
2020-09-03 15:53:29 -07:00
```
2020-05-14 17:06:23 -07:00
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.
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
```