Skip to content

Commit

Permalink
terraform-provider-sdm/docs: add tags to documentation
Browse files Browse the repository at this point in the history
GitOrigin-RevId: 79734be40ea0e63efe9f77964e125c26c88aeca7
  • Loading branch information
philhassey authored and SupportSDM committed Oct 8, 2021
1 parent cc0fbaa commit 2a4dbe8
Show file tree
Hide file tree
Showing 11 changed files with 120 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/data-sources/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Accounts are users that have access to strongDM. There are two types of accounts
data "sdm_account" "user-queries" {
type = "user"
email = "*@strongdm.com"
tags = {
region = "us-west"
env = "dev"
}
}
```
## Argument Reference
Expand All @@ -27,6 +31,7 @@ The following arguments are supported by a Accounts data source:
* `last_name` - (Optional) The User's last name.
* `name` - (Optional) Unique human-readable name of the Service.
* `suspended` - (Optional) The Service's suspended state.
* `tags` - (Optional) Tags is a map of key, value pairs.
## Attribute Reference
In addition to provided arguments above, the following attributes are returned by a Accounts data source:
* `id` - a generated id representing this request, unrelated to input id and sdm_account ids.
Expand Down
5 changes: 5 additions & 0 deletions docs/data-sources/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Nodes make up the strongDM network, and allow your users to connect securely to
```hcl
data "sdm_node" "gateway_query" {
type = "gateway"
tags = {
region = "us-west"
env = "dev"
}
}
```
## Argument Reference
Expand All @@ -28,6 +32,7 @@ The following arguments are supported by a Nodes data source:
* `id` - (Optional) Unique identifier of the Gateway.
* `listen_address` - (Optional) The public hostname/port tuple at which the gateway will be accessible to clients.
* `name` - (Optional) Unique human-readable name of the Gateway. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
* `tags` - (Optional) Tags is a map of key, value pairs.
## Attribute Reference
In addition to provided arguments above, the following attributes are returned by a Nodes data source:
* `id` - a generated id representing this request, unrelated to input id and sdm_node ids.
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ A Resource is a database or server for which strongDM manages access.
data "sdm_resource" "aurora_datasources" {
name = "us-west*"
type = "aurora_mysql"
tags = {
region = "us-west"
env = "dev"
}
}
```
## Argument Reference
Expand Down
5 changes: 5 additions & 0 deletions docs/data-sources/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ A Role is a collection of access grants, and typically corresponds to a team, Ac
```hcl
data "sdm_role" "composite_role_query" {
composite = true
tags = {
region = "us-west"
env = "dev"
}
}
```
## Argument Reference
Expand All @@ -21,6 +25,7 @@ The following arguments are supported by a Roles data source:
* `name` - (Optional) Unique human-readable name of the Role.
* `access_rules` - (Optional) AccessRules JSON encoded access rules data.
* `composite` - (Optional) True if the Role is a composite role.
* `tags` - (Optional) Tags is a map of key, value pairs.
## Attribute Reference
In addition to provided arguments above, the following attributes are returned by a Roles data source:
* `id` - a generated id representing this request, unrelated to input id and sdm_role ids.
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/secret_store.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The following arguments are supported by a SecretStores data source:
* `name` - (Optional) Unique human-readable name of the SecretStore.
* `region` - (Optional)
* `server_address` - (Optional)
* `tags` - (Optional) Tags is a map of key, value pairs.
## Attribute Reference
In addition to provided arguments above, the following attributes are returned by a SecretStores data source:
* `id` - a generated id representing this request, unrelated to input id and sdm_secret_store ids.
Expand Down
10 changes: 10 additions & 0 deletions docs/resources/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,20 @@ resource "sdm_account" "test-user" {
first_name = "al"
last_name = "bob"
email = "[email protected]"
tags = {
region = "us-west"
env = "dev"
}
}
}
resource "sdm_account" "test-service" {
service {
name = "test-service"
tags = {
region = "us-west"
env = "dev"
}
}
}
```
Expand All @@ -34,9 +42,11 @@ The following arguments are supported by the Account resource:
* `first_name` - (Required) The User's first name.
* `last_name` - (Required) The User's last name.
* `suspended` - (Optional) The User's suspended state.
* `tags` - (Optional) Tags is a map of key, value pairs.
* service:
* `name` - (Required) Unique human-readable name of the Service.
* `suspended` - (Optional) The Service's suspended state.
* `tags` - (Optional) Tags is a map of key, value pairs.
## Attribute Reference
In addition to provided arguments above, the following attributes are returned by the Account resource:
* `id` - A unique identifier for the Account resource.
10 changes: 10 additions & 0 deletions docs/resources/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,36 @@ resource "sdm_node" "gateway" {
name = "test-gateway"
listen_address = "165.23.40.1:21222"
bind_address = "0.0.0.0:21222"
tags = {
region = "us-west"
env = "dev"
}
}
}
resource "sdm_node" "relay" {
relay {
name = "test-relay"
tags = {
region = "us-west"
env = "dev"
}
}
}
```
## Argument Reference
The following arguments are supported by the Node resource:
* relay:
* `name` - (Optional) Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
* `tags` - (Optional) Tags is a map of key, value pairs.
* `gateway_filter` - (Optional) GatewayFilter can be used to restrict the peering between relays and
gateways.
* gateway:
* `name` - (Optional) Unique human-readable name of the Gateway. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
* `listen_address` - (Required) The public hostname/port tuple at which the gateway will be accessible to clients.
* `bind_address` - (Optional) The hostname/port tuple which the gateway daemon will bind to.
If not provided on create, set to "0.0.0.0:<listen_address_port>".
* `tags` - (Optional) Tags is a map of key, value pairs.
* `gateway_filter` - (Optional) GatewayFilter can be used to restrict the peering between relays and
gateways.
## Attribute Reference
Expand Down
Loading

0 comments on commit 2a4dbe8

Please sign in to comment.