diff --git a/docs/index.md b/docs/index.md index 21c57b07..ddfa00f7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -22,16 +22,17 @@ provider "boundary" { } ``` + ## Schema ### Required -- **addr** (String, Required) The base url of the Boundary API, e.g. "http://127.0.0.1:9200". If not set, it will be read from the "BOUNDARY_ADDR" env var. +- **addr** (String) The base url of the Boundary API, e.g. "http://127.0.0.1:9200". If not set, it will be read from the "BOUNDARY_ADDR" env var. ### Optional -- **auth_method_id** (String, Optional) The auth method ID e.g. ampw_1234567890 -- **password_auth_method_login_name** (String, Optional) The auth method login name for password-style auth methods -- **password_auth_method_password** (String, Optional) The auth method password for password-style auth methods -- **recovery_kms_hcl** (String, Optional) Can be a heredoc string or a path on disk. If set, the string/file will be parsed as HCL and used with the recovery KMS mechanism. While this is set, it will override any other authentication information; the KMS mechanism will always be used. See Boundary's KMS docs for examples: https://boundaryproject.io/docs/configuration/kms -- **token** (String, Optional) The Boundary token to use, as a string or path on disk containing just the string. If set, the token read here will be used in place of authenticating with the auth method specified in "auth_method_id", although the recovery KMS mechanism will still override this. Can also be set with the BOUNDARY_TOKEN environment variable. +- **auth_method_id** (String) The auth method ID e.g. ampw_1234567890 +- **password_auth_method_login_name** (String) The auth method login name for password-style auth methods +- **password_auth_method_password** (String) The auth method password for password-style auth methods +- **recovery_kms_hcl** (String) Can be a heredoc string or a path on disk. If set, the string/file will be parsed as HCL and used with the recovery KMS mechanism. While this is set, it will override any other authentication information; the KMS mechanism will always be used. See Boundary's KMS docs for examples: https://boundaryproject.io/docs/configuration/kms +- **token** (String) The Boundary token to use, as a string or path on disk containing just the string. If set, the token read here will be used in place of authenticating with the auth method specified in "auth_method_id", although the recovery KMS mechanism will still override this. Can also be set with the BOUNDARY_TOKEN environment variable. \ No newline at end of file diff --git a/docs/resources/account.md b/docs/resources/account.md index 0f9fd21b..a4744bca 100644 --- a/docs/resources/account.md +++ b/docs/resources/account.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "boundary_account Resource - terraform-provider-boundary" subcategory: "" description: |- @@ -33,23 +34,24 @@ resource "boundary_account" "jeff" { } ``` + ## Schema ### Required -- **auth_method_id** (String, Required) The resource ID for the auth method. -- **type** (String, Required) The resource type. +- **auth_method_id** (String) The resource ID for the auth method. +- **type** (String) The resource type. ### Optional -- **description** (String, Optional) The account description. -- **login_name** (String, Optional) The login name for this account. -- **name** (String, Optional) The account name. Defaults to the resource name. -- **password** (String, Optional) The account password. +- **description** (String) The account description. +- **login_name** (String) The login name for this account. +- **name** (String) The account name. Defaults to the resource name. +- **password** (String) The account password. ### Read-only -- **id** (String, Read-only) The ID of the account. +- **id** (String) The ID of the account. ## Import diff --git a/docs/resources/auth_method.md b/docs/resources/auth_method.md index dce8604d..602bda5d 100644 --- a/docs/resources/auth_method.md +++ b/docs/resources/auth_method.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "boundary_auth_method Resource - terraform-provider-boundary" subcategory: "" description: |- @@ -26,23 +27,24 @@ resource "boundary_auth_method" "password" { } ``` + ## Schema ### Required -- **scope_id** (String, Required) The scope ID. -- **type** (String, Required) The resource type. +- **scope_id** (String) The scope ID. +- **type** (String) The resource type. ### Optional -- **description** (String, Optional) The auth method description. -- **min_login_name_length** (Number, Optional) The minimum login name length. -- **min_password_length** (Number, Optional) The minimum password length. -- **name** (String, Optional) The auth method name. Defaults to the resource name. +- **description** (String) The auth method description. +- **min_login_name_length** (Number) The minimum login name length. +- **min_password_length** (Number) The minimum password length. +- **name** (String) The auth method name. Defaults to the resource name. ### Read-only -- **id** (String, Read-only) The ID of the account. +- **id** (String) The ID of the account. ## Import diff --git a/docs/resources/group.md b/docs/resources/group.md index 98d1a037..f5f76593 100644 --- a/docs/resources/group.md +++ b/docs/resources/group.md @@ -45,10 +45,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_user" "foo" { @@ -64,21 +64,22 @@ resource "boundary_group" "example" { } ``` + ## Schema ### Required -- **scope_id** (String, Required) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. +- **scope_id** (String) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. ### Optional -- **description** (String, Optional) The group description. -- **member_ids** (Set of String, Optional) Resource IDs for group members, these are most likely boundary users. -- **name** (String, Optional) The group name. Defaults to the resource name. +- **description** (String) The group description. +- **member_ids** (Set of String) Resource IDs for group members, these are most likely boundary users. +- **name** (String) The group name. Defaults to the resource name. ### Read-only -- **id** (String, Read-only) The ID of the group. +- **id** (String) The ID of the group. ## Import diff --git a/docs/resources/host.md b/docs/resources/host.md index a6677bfe..13f16a49 100644 --- a/docs/resources/host.md +++ b/docs/resources/host.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "boundary_host Resource - terraform-provider-boundary" subcategory: "" description: |- @@ -21,10 +22,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host" "example" { @@ -35,22 +36,23 @@ resource "boundary_host" "example" { } ``` + ## Schema ### Required -- **host_catalog_id** (String, Required) -- **type** (String, Required) +- **host_catalog_id** (String) +- **type** (String) ### Optional -- **address** (String, Optional) The static address of the host resource as `` (note: port assignment occurs in the target resource definition, do not add :port here) or a domain name. -- **description** (String, Optional) The host description. -- **name** (String, Optional) The host name. Defaults to the resource name. +- **address** (String) The static address of the host resource as `` (note: port assignment occurs in the target resource definition, do not add :port here) or a domain name. +- **description** (String) The host description. +- **name** (String) The host name. Defaults to the resource name. ### Read-only -- **id** (String, Read-only) The ID of the host. +- **id** (String) The ID of the host. ## Import diff --git a/docs/resources/host_catalog.md b/docs/resources/host_catalog.md index 595c6fc3..3e64fd61 100644 --- a/docs/resources/host_catalog.md +++ b/docs/resources/host_catalog.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "boundary_host_catalog Resource - terraform-provider-boundary" subcategory: "" description: |- @@ -21,10 +22,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host_catalog" "example" { @@ -35,21 +36,22 @@ resource "boundary_host_catalog" "example" { } ``` + ## Schema ### Required -- **scope_id** (String, Required) The scope ID in which the resource is created. -- **type** (String, Required) The host catalog type. Only `Static` (yes, title case) is supported. +- **scope_id** (String) The scope ID in which the resource is created. +- **type** (String) The host catalog type. Only `Static` (yes, title case) is supported. ### Optional -- **description** (String, Optional) The host catalog description. -- **name** (String, Optional) The host catalog name. Defaults to the resource name. +- **description** (String) The host catalog description. +- **name** (String) The host catalog name. Defaults to the resource name. ### Read-only -- **id** (String, Read-only) The ID of the host catalog. +- **id** (String) The ID of the host catalog. ## Import diff --git a/docs/resources/host_set.md b/docs/resources/host_set.md index 28a5cb96..e1392a9c 100644 --- a/docs/resources/host_set.md +++ b/docs/resources/host_set.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "boundary_host_set Resource - terraform-provider-boundary" subcategory: "" description: |- @@ -21,10 +22,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host_catalog" "static" { @@ -56,22 +57,23 @@ resource "boundary_host_set" "web" { } ``` + ## Schema ### Required -- **host_catalog_id** (String, Required) The catalog for the hostset. -- **type** (String, Required) +- **host_catalog_id** (String) The catalog for the hostset. +- **type** (String) ### Optional -- **description** (String, Optional) The hostset description. -- **host_ids** (Set of String, Optional) The list of host IDs contained in this set. -- **name** (String, Optional) The hostset name. Defaults to the resource name. +- **description** (String) The hostset description. +- **host_ids** (Set of String) The list of host IDs contained in this set. +- **name** (String) The hostset name. Defaults to the resource name. ### Read-only -- **id** (String, Read-only) The ID of the hostset. +- **id** (String) The ID of the hostset. ## Import diff --git a/docs/resources/role.md b/docs/resources/role.md index 64d070b6..4f8d33dc 100644 --- a/docs/resources/role.md +++ b/docs/resources/role.md @@ -96,10 +96,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_user" "readonly" { @@ -117,24 +117,25 @@ resource "boundary_role" "readonly" { } ``` + ## Schema ### Required -- **scope_id** (String, Required) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. +- **scope_id** (String) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. ### Optional -- **default_role** (Boolean, Optional) Indicates that the role containing this value is the default role (that is, has the id 'r_default'), which triggers some specialized behavior to allow it to be imported and managed. -- **description** (String, Optional) The role description. -- **grant_scope_id** (String, Optional) -- **grant_strings** (Set of String, Optional) A list of stringified grants for the role. -- **name** (String, Optional) The role name. Defaults to the resource name. -- **principal_ids** (Set of String, Optional) A list of principal (user or group) IDs to add as principals on the role. +- **default_role** (Boolean) Indicates that the role containing this value is the default role (that is, has the id 'r_default'), which triggers some specialized behavior to allow it to be imported and managed. +- **description** (String) The role description. +- **grant_scope_id** (String) +- **grant_strings** (Set of String) A list of stringified grants for the role. +- **name** (String) The role name. Defaults to the resource name. +- **principal_ids** (Set of String) A list of principal (user or group) IDs to add as principals on the role. ### Read-only -- **id** (String, Read-only) The ID of the role. +- **id** (String) The ID of the role. ## Import diff --git a/docs/resources/scope.md b/docs/resources/scope.md index da910e6a..508c7f50 100644 --- a/docs/resources/scope.md +++ b/docs/resources/scope.md @@ -60,23 +60,24 @@ resource "boundary_role" "org_admin" { } ``` + ## Schema ### Required -- **scope_id** (String, Required) The scope ID containing the sub scope resource. +- **scope_id** (String) The scope ID containing the sub scope resource. ### Optional -- **auto_create_admin_role** (Boolean, Optional) If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. Marking this true makes for simpler HCL but results in role resources that are unmanaged by Terraform. -- **auto_create_default_role** (Boolean, Optional) Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. Marking this true makes for simpler HCL but results in role resources that are unmanaged by Terraform. -- **description** (String, Optional) The scope description. -- **global_scope** (Boolean, Optional) Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. -- **name** (String, Optional) The scope name. Defaults to the resource name. +- **auto_create_admin_role** (Boolean) If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives permissions to manage the scope to the provider's user. Marking this true makes for simpler HCL but results in role resources that are unmanaged by Terraform. +- **auto_create_default_role** (Boolean) Only relevant when creating an org scope. If set, when a new scope is created, the provider will not disable the functionality that automatically creates a role in the new scope and gives listing of scopes and auth methods and the ability to authenticate to the anonymous user. Marking this true makes for simpler HCL but results in role resources that are unmanaged by Terraform. +- **description** (String) The scope description. +- **global_scope** (Boolean) Indicates that the scope containing this value is the global scope, which triggers some specialized behavior to allow it to be imported and managed. +- **name** (String) The scope name. Defaults to the resource name. ### Read-only -- **id** (String, Read-only) The ID of the scope. +- **id** (String) The ID of the scope. ## Import diff --git a/docs/resources/target.md b/docs/resources/target.md index 2d8f10a6..f3a17655 100644 --- a/docs/resources/target.md +++ b/docs/resources/target.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "boundary_target Resource - terraform-provider-boundary" subcategory: "" description: |- @@ -26,10 +27,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host_catalog" "foo" { @@ -74,25 +75,26 @@ resource "boundary_target" "foo" { } ``` + ## Schema ### Required -- **scope_id** (String, Required) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. -- **type** (String, Required) The target resource type. +- **scope_id** (String) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. +- **type** (String) The target resource type. ### Optional -- **default_port** (Number, Optional) The default port for this target. -- **description** (String, Optional) The target description. -- **host_set_ids** (Set of String, Optional) A list of host set ID's. -- **name** (String, Optional) The target name. Defaults to the resource name. -- **session_connection_limit** (Number, Optional) -- **session_max_seconds** (Number, Optional) +- **default_port** (Number) The default port for this target. +- **description** (String) The target description. +- **host_set_ids** (Set of String) A list of host set ID's. +- **name** (String) The target name. Defaults to the resource name. +- **session_connection_limit** (Number) +- **session_max_seconds** (Number) ### Read-only -- **id** (String, Read-only) The ID of the target. +- **id** (String) The ID of the target. ## Import diff --git a/docs/resources/user.md b/docs/resources/user.md index 9dc7c1e8..4fa23970 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -1,4 +1,5 @@ --- +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "boundary_user Resource - terraform-provider-boundary" subcategory: "" description: |- @@ -40,21 +41,22 @@ resource "boundary_user" "jeff" { } ``` + ## Schema ### Required -- **scope_id** (String, Required) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. +- **scope_id** (String) The scope ID in which the resource is created. Defaults to the provider's `default_scope` if unset. ### Optional -- **account_ids** (Set of String, Optional) Account ID's to associate with this user resource. -- **description** (String, Optional) The user description. -- **name** (String, Optional) The username. Defaults to the resource name. +- **account_ids** (Set of String) Account ID's to associate with this user resource. +- **description** (String) The user description. +- **name** (String) The username. Defaults to the resource name. ### Read-only -- **id** (String, Read-only) The ID of the user. +- **id** (String) The ID of the user. ## Import diff --git a/examples/resources/boundary_group/project-specific/resource.tf b/examples/resources/boundary_group/project-specific/resource.tf index 26a5409c..f535556e 100644 --- a/examples/resources/boundary_group/project-specific/resource.tf +++ b/examples/resources/boundary_group/project-specific/resource.tf @@ -7,10 +7,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_user" "foo" { diff --git a/examples/resources/boundary_host/resource.tf b/examples/resources/boundary_host/resource.tf index 63b4d4dc..5b8fc5b8 100644 --- a/examples/resources/boundary_host/resource.tf +++ b/examples/resources/boundary_host/resource.tf @@ -7,10 +7,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host" "example" { diff --git a/examples/resources/boundary_host_catalog/resource.tf b/examples/resources/boundary_host_catalog/resource.tf index c2b52908..10e539ad 100644 --- a/examples/resources/boundary_host_catalog/resource.tf +++ b/examples/resources/boundary_host_catalog/resource.tf @@ -7,10 +7,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host_catalog" "example" { diff --git a/examples/resources/boundary_host_set/resource.tf b/examples/resources/boundary_host_set/resource.tf index fcf750be..0101b445 100644 --- a/examples/resources/boundary_host_set/resource.tf +++ b/examples/resources/boundary_host_set/resource.tf @@ -7,10 +7,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host_catalog" "static" { diff --git a/examples/resources/boundary_role/project-specific/resource.tf b/examples/resources/boundary_role/project-specific/resource.tf index 4e715d95..af2594c7 100644 --- a/examples/resources/boundary_role/project-specific/resource.tf +++ b/examples/resources/boundary_role/project-specific/resource.tf @@ -7,10 +7,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_user" "readonly" { diff --git a/examples/resources/boundary_target/resource.tf b/examples/resources/boundary_target/resource.tf index c6722ae4..cd667e37 100644 --- a/examples/resources/boundary_target/resource.tf +++ b/examples/resources/boundary_target/resource.tf @@ -12,10 +12,10 @@ resource "boundary_scope" "org" { } resource "boundary_scope" "project" { - name = "project_one" - description = "My first scope!" - scope_id = boundary_scope.org.id - auto_create_admin_role = true + name = "project_one" + description = "My first scope!" + scope_id = boundary_scope.org.id + auto_create_admin_role = true } resource "boundary_host_catalog" "foo" { diff --git a/go.mod b/go.mod index ddfe6fcb..720a7e9b 100644 --- a/go.mod +++ b/go.mod @@ -24,7 +24,7 @@ require ( github.com/hashicorp/go-kms-wrapping v0.5.16 github.com/hashicorp/golang-lru v0.5.4 // indirect github.com/hashicorp/hcl/v2 v2.6.0 // indirect - github.com/hashicorp/terraform-plugin-docs v0.2.0 + github.com/hashicorp/terraform-plugin-docs v0.3.1 github.com/hashicorp/terraform-plugin-sdk/v2 v2.0.5-0.20201016174159-3a1c6c51f716 github.com/hashicorp/yamux v0.0.0-20200609203250-aecfd211c9ce // indirect github.com/mitchellh/go-homedir v1.1.0 diff --git a/go.sum b/go.sum index 103dfffc..62f40e75 100644 --- a/go.sum +++ b/go.sum @@ -666,8 +666,8 @@ github.com/hashicorp/terraform-exec v0.10.0 h1:3nh/1e3u9gYRUQGOKWp/8wPR7ABlL2F14 github.com/hashicorp/terraform-exec v0.10.0/go.mod h1:tOT8j1J8rP05bZBGWXfMyU3HkLi1LWyqL3Bzsc3CJjo= github.com/hashicorp/terraform-json v0.5.0 h1:7TV3/F3y7QVSuN4r9BEXqnWqrAyeOtON8f0wvREtyzs= github.com/hashicorp/terraform-json v0.5.0/go.mod h1:eAbqb4w0pSlRmdvl8fOyHAi/+8jnkVYN28gJkSJrLhU= -github.com/hashicorp/terraform-plugin-docs v0.2.0 h1:A1Uk+WIvU0B4VP4pBbTBP9bZJ9w9F8yoVGj7MC1vYc0= -github.com/hashicorp/terraform-plugin-docs v0.2.0/go.mod h1:4jopztPjeyZAr51wPzX4b8Ld8bFQKQ9dbF40JbCQIts= +github.com/hashicorp/terraform-plugin-docs v0.3.1 h1:Slq2UAbxFCYtvN9wc+S2T1b30Ir29kLXtLrZ/JDdFcA= +github.com/hashicorp/terraform-plugin-docs v0.3.1/go.mod h1:4jopztPjeyZAr51wPzX4b8Ld8bFQKQ9dbF40JbCQIts= github.com/hashicorp/terraform-plugin-sdk/v2 v2.0.5-0.20201016174159-3a1c6c51f716 h1:c9UOoIrZ4LKF0LJQB0cORIjLt3y9yJGHBa88PaoEqR8= github.com/hashicorp/terraform-plugin-sdk/v2 v2.0.5-0.20201016174159-3a1c6c51f716/go.mod h1:GP0lmw4Y+XV1OfTmi/hK75t5KWGGzoOzEgUBPGZ6Wq4= github.com/hashicorp/vault/api v1.0.5-0.20200514164214-89b1987e38c2/go.mod h1:P8A7gn1a6j/7qQ4zOaWI6FC/Q9jQWEBRTOwZH33tC9o= diff --git a/internal/provider/provider.go b/internal/provider/provider.go index 8d583794..a2c756c4 100644 --- a/internal/provider/provider.go +++ b/internal/provider/provider.go @@ -25,7 +25,7 @@ func New() *schema.Provider { "addr": { Type: schema.TypeString, Required: true, - Description: `The base url of the Boundary API, e.g. "http://127.0.0.1". If not set, it will be read from the "BOUNDARY_ADDR" env var.`, + Description: `The base url of the Boundary API, e.g. "http://127.0.0.1:9200". If not set, it will be read from the "BOUNDARY_ADDR" env var.`, }, "token": { Type: schema.TypeString, diff --git a/main.go b/main.go index 0b10a3db..9565d349 100644 --- a/main.go +++ b/main.go @@ -5,6 +5,16 @@ import ( "github.com/hashicorp/terraform-provider-boundary/internal/provider" ) +// Run "go generate" to format example terraform files and generate the docs for the registry/website + +// If you do not have terraform installed, you can remove the formatting command, but its suggested to +// ensure the documentation is formatted properly. +//go:generate terraform fmt -recursive ./examples/ + +// Run the docs generation tool, check its repository for more information on how it works and how docs +// can be customized. +//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs + func main() { plugin.Serve(&plugin.ServeOpts{ProviderFunc: provider.New}) }