Skip to content

Commit

Permalink
Docs fix example (#38)
Browse files Browse the repository at this point in the history 
* docs: fix complex example syntax and login_name argument

* docs: fix missing arguments and argument names

* docs: fix type capitalization
  • Loading branch information
Randall Morey authored Sep 16, 2020
1 parent d19dd70 commit 0ccd13e
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 75 deletions.
139 changes: 86 additions & 53 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Terraform Provider Boundary
Terraform Provider Boundary
==================

Requirements
Expand All @@ -12,7 +12,7 @@ Building The Provider

1. Clone the repository
1. Enter the repository directory
1. Build the provider using the Go `install` command:
1. Build the provider using the Go `install` command:
```sh
$ go install
```
Expand All @@ -39,14 +39,14 @@ Please see our detailed docs for individual resource usage. Below is a complex e

```hcl
provider "boundary" {
addr = "http://127.0.0.1:9200"
auth_method_id = "ampw_1234567890"
password_auth_method_username = "admin"
password_auth_method_password = "passpass"
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
}
variable "backend_team" {
type = set(string)
type = set(string)
default = [
"Jim Lambert",
"Mike Gaffney",
Expand All @@ -55,15 +55,15 @@ variable "backend_team" {
}
variable "frontend_team" {
type = set(string)
type = set(string)
default = [
"Randy Morey",
"Randall Morey",
"Susmitha Girumala",
]
}
variable "leadership_team" {
type = set(string)
type = set(string)
default = [
"Jeff Mitchell",
"Pete Pacent",
Expand All @@ -72,227 +72,260 @@ variable "leadership_team" {
]
}
variable "frontend_server_ips" {
type = set(string)
variable "web_server_ips" {
type = set(string)
default = [
"10.0.0.1",
"10.0.0.2",
]
}
variable "backend_server_ips" {
type = set(string)
type = set(string)
default = [
"10.1.0.1",
"10.1.0.2",
]
}
resource "boundary_organization" "corp" {}
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
}
resource "boundary_user" "backend" {
for_each = var.backend_team
name = each.key
description = "Backend user: ${each.key}"
scope_id = boundary_organization.corp.id
scope_id = boundary_scope.corp.id
}
resource "boundary_user" "frontend" {
for_each = var.frontend_team
name = each.key
description = "Frontend user: ${each.key}"
scope_id = boundary_organization.corp.id
scope_id = boundary_scope.corp.id
}
resource "boundary_user" "leadership" {
for_each = var.leadership_team
name = each.key
description = "WARNING: Managers should be read-only"
scope_id = boundary_organization.corp.id
scope_id = boundary_scope.corp.id
}
// 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]
scope_id = boundary_organization.corp.id
scope_id = boundary_scope.corp.id
}
// add org-level role for readonly access
resource "boundary_role" "organization_readonly" {
name = "readonly"
description = "Read-only role"
principals = [boundary_group.leadership.id]
grants = ["id=*;actions=read"]
scope_id = boundary_organization.corp.id
principal_ids = [boundary_group.leadership.id]
grant_strings = ["id=*;actions=read"]
scope_id = boundary_scope.corp.id
}
// add org-level role for administration access
resource "boundary_role" "organization_admin" {
name = "admin"
description = "Administrator role"
principals = concat(
principal_ids = concat(
[for user in boundary_user.backend : user.id],
[for user in boundary_user.frontend : user.id]
)
grants = ["id=*;actions=create,read,update,delete"]
scope_id = boundary_organization.corp.id
grant_strings = ["id=*;actions=create,read,update,delete"]
scope_id = boundary_scope.corp.id
}
// create a project for core infrastructure
resource "boundary_project" "core_infra" {
description = "Core infrastrcture"
scope_id = boundary_organization.corp.id
resource "boundary_scope" "core_infra" {
description = "Core infrastrcture"
scope_id = boundary_scope.corp.id
auto_create_role = true
}
resource "boundary_group" "backend_core_infra" {
name = "backend"
description = "Backend team group"
member_ids = [for user in boundary_user.backend : user.id]
scope_id = boundary_project.core_infra.id
scope_id = boundary_scope.core_infra.id
}
resource "boundary_group" "frontend_core_infra" {
name = "frontend"
description = "Frontend team group"
member_ids = [for user in boundary_user.frontend : user.id]
scope_id = boundary_project.core_infra.id
scope_id = boundary_scope.core_infra.id
}
resource "boundary_host" "backend_servers_service" {
for_each = var.backend_server_ips
type = "static"
name = "backend_server_service_${each.value}"
description = "Backend server host for service port"
address = "${each.key}:9200"
scope_id = boundary_project.core_infra.id
host_catalog_id = boundary_host_catalog.backend_servers.id
}
resource "boundary_host" "backend_servers_ssh" {
for_each = var.backend_server_ips
type = "static"
name = "backend_server_ssh_${each.value}"
description = "Backend server host for SSH port"
address = "${each.key}:22"
scope_id = boundary_project.core_infra.id
host_catalog_id = boundary_host_catalog.backend_servers.id
}
resource "boundary_host" "frontend_servers_console" {
for_each = var.frontend_server_ips
type = "static"
name = "frontend_server_console_${each.value}"
description = "Frontend server host for console port"
address = "${each.key}:443"
scope_id = boundary_project.core_infra.id
host_catalog_id = boundary_host_catalog.web_servers.id
host_catalog_id = boundary_host_catalog.frontend_servers.id
}
resource "boundary_host" "frontend_servers_ssh" {
for_each = var.frontend_server_ips
type = "static"
name = "frontend_server_ssh_${each.value}"
description = "Frontend server host for SSH port"
address = "${each.key}:22"
scope_id = boundary_project.core_infra.id
host_catalog_id = boundary_host_catalog.web_servers.id
host_catalog_id = boundary_host_catalog.frontend_servers.id
}
resource "boundary_host_catalog" "web_servers" {
name = "web_servers"
description = "Web servers for frontend team"
type = "Static"
scope_id = boundary_project.core_infra.id
type = "static"
scope_id = boundary_scope.core_infra.id
}
resource "boundary_host_catalog" "backend_servers" {
name = "backend_servers"
description = "Web servers for backend team"
type = "Static"
scope_id = boundary_project.core_infra.id
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
}
resource "boundary_host_set" "backend_servers_service" {
type = "static"
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" {
type = "static"
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" {
type = "static"
name = "frontend_servers_console"
description = "Host set for frontend servers console access"
host_catalog_id = boundary_host_catalog.web_servers.id
host_catalog_id = boundary_host_catalog.frontend_servers.id
host_ids = [for host in boundary_host.frontend_servers_console : host.id]
}
resource "boundary_host_set" "frontend_servers_ssh" {
type = "static"
name = "frontend_servers_ssh"
description = "Host set for frontend servers SSH access"
host_catalog_id = boundary_host_catalog.web_servers.id
host_catalog_id = boundary_host_catalog.frontend_servers.id
host_ids = [for host in boundary_host.frontend_servers_ssh : host.id]
}
resource "boundary_target" "frontend_servers_console" {
type = "tcp"
name = "frontend_servers_console"
description = "Frontend console target"
scope_id = boundary_project.core_infra.id
scope_id = boundary_scope.core_infra.id
host_set_ids = [
boundary_host_set.frontend_servers_console.id
]
}
resource "boundary_target" "frontend_servers_ssh" {
type = "tcp"
name = "frontend_servers_ssh"
description = "Frontend SSH target"
scope_id = boundary_project.core_infra.id
scope_id = boundary_scope.core_infra.id
host_set_ids = [
boundary_host_set.frontend_servers_ssh.id
]
}
resource "boundary_target" "backend_servers_service" {
type = "tcp"
name = "backend_servers_service"
description = "Backend service target"
scope_id = boundary_project.core_infra.id
scope_id = boundary_scope.core_infra.id
host_set_ids = [
boundary_host_set.backend_servers_service.id,
boundary_host_set.backend_servers_service.id
]
}
resource "boundary_target" "backend_servers_ssh" {
type = "tcp"
name = "backend_servers_ssh"
description = "Backend SSH target"
scope_id = boundary_project.core_infra.id
scope_id = boundary_scope.core_infra.id
host_set_ids = [
boundary_host_set.backend_servers_ssh.id,
boundary_host_set.backend_servers_ssh.id
]
}
// 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"
principals = [boundary_group.backend_core_infra.id]
grants = ["id=${boundary_host_catalog.backend_servers.id};actions=create,read,update,delete"]
scope_id = boundary_project.core_infra.id
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
}
// 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"
principals = [boundary_group.frontend_core_infra.id]
grants = ["id=${boundary_host_catalog.web_servers.id};actions=create,read,update,delete"]
scope_id = boundary_project.core_infra.id
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
}
```

Developing the Provider
Expand Down
Loading

0 comments on commit 0ccd13e

Please sign in to comment.