-
Notifications
You must be signed in to change notification settings - Fork 58
Cleanup #50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Cleanup #50
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
24143fa
Cleanup some of the repo, prep for release
paultyng 3dc7803
Rework docs to new registry structure
paultyng dda2272
Add docs generator tooling
paultyng 2c28e0e
Generate the docs
paultyng cf5c2d1
update deps
malnick 4c3ccf3
docs: add docs generation command to readme
malnick 49e47ee
Fix syntax for host address
paultyng 1e19f8f
Use true factory for tests
paultyng File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 1.15.2 |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| ## 0.1.0 (Unreleased) | ||
|
|
||
| BACKWARDS INCOMPATIBILITIES / NOTES: | ||
| Initial release! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| page_title: "Provider: Boundary" | ||
| subcategory: "" | ||
| description: |- | ||
| Terraform provider for configuring Boundary. | ||
| --- | ||
|
|
||
| # Boundary Provider | ||
|
|
||
| Terraform provider for configuring Boundary. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| Do not keep your authentication password in HCL for production environments, use Terraform environment variables. | ||
|
|
||
| ```terraform | ||
| provider "boundary" { | ||
| 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 | ||
| } | ||
| ``` | ||
|
|
||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **addr** (String, Required) 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. | ||
|
|
||
| ### 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. | ||
| - **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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| page_title: "boundary_account Resource - terraform-provider-boundary" | ||
| subcategory: "" | ||
| description: |- | ||
| The account resource allows you to configure a Boundary account. | ||
| --- | ||
|
|
||
| # Resource `boundary_account` | ||
|
|
||
| The account resource allows you to configure a Boundary account. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "boundary_scope" "org" { | ||
| name = "organization_one" | ||
| description = "My first scope!" | ||
| scope_id = "global" | ||
| auto_create_role = true | ||
| } | ||
|
|
||
| resource "boundary_auth_method" "password" { | ||
| scope_id = boundary_scope.org.id | ||
| type = "password" | ||
| } | ||
|
|
||
| resource "boundary_account" "jeff" { | ||
| auth_method_id = boundary_auth_method.password.id | ||
| type = "password" | ||
| login_name = "jeff" | ||
| password = "$uper$ecure" | ||
| } | ||
| ``` | ||
|
|
||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **auth_method_id** (String, Required) The resource ID for the authentication method. | ||
| - **type** (String, Required) The resource type. | ||
|
|
||
| ### Optional | ||
|
|
||
| - **description** (String, Optional) The account description. | ||
| - **id** (String, Optional) The ID of this resource. | ||
| - **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. | ||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| page_title: "boundary_auth_method Resource - terraform-provider-boundary" | ||
| subcategory: "" | ||
| description: |- | ||
| The auth method resource allows you to configure a Boundary auth_method. | ||
| --- | ||
|
|
||
| # Resource `boundary_auth_method` | ||
|
|
||
| The auth method resource allows you to configure a Boundary auth_method. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "boundary_scope" "org" { | ||
| name = "organization_one" | ||
| description = "My first scope!" | ||
| scope_id = "global" | ||
| auto_create_role = true | ||
| } | ||
|
|
||
| resource "boundary_auth_method" "password" { | ||
| scope_id = boundary_scope.org.id | ||
| type = "password" | ||
| } | ||
| ``` | ||
|
|
||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **scope_id** (String, Required) The scope ID. | ||
| - **type** (String, Required) The resource type. | ||
|
|
||
| ### Optional | ||
|
|
||
| - **description** (String, Optional) The auth method description. | ||
| - **id** (String, Optional) The ID of this resource. | ||
| - **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. | ||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| page_title: "boundary_host Resource - terraform-provider-boundary" | ||
| subcategory: "" | ||
| description: |- | ||
| The host resource allows you to configure a Boundary static host. Hosts are always part of a project, so a project resource should be used inline or you should have the project ID in hand to successfully configure a host. | ||
| --- | ||
|
|
||
| # Resource `boundary_host` | ||
|
|
||
| The host resource allows you to configure a Boundary static host. Hosts are always part of a project, so a project resource should be used inline or you should have the project ID in hand to successfully configure a host. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| resource "boundary_scope" "org" { | ||
| name = "organization_one" | ||
| description = "My first scope!" | ||
| scope_id = "global" | ||
| auto_create_role = true | ||
| } | ||
|
|
||
| resource "boundary_scope" "project" { | ||
| name = "project_one" | ||
| description = "My first scope!" | ||
| scope_id = boundary_scope.org.id | ||
| auto_create_role = true | ||
| } | ||
|
|
||
| resource "boundary_host" "example" { | ||
| name = "My catalog" | ||
| description = "My first host!" | ||
| address = "10.0.0.1" | ||
| scope_id = boundary_scope.project.id | ||
| } | ||
| ``` | ||
|
|
||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **host_catalog_id** (String, Required) | ||
| - **type** (String, Required) | ||
|
|
||
| ### Optional | ||
|
|
||
| - **address** (String, Optional) The static address of the host resource as `<IP>:<port>` or a domain name. | ||
| - **description** (String, Optional) The host description. | ||
| - **id** (String, Optional) The ID of this resource. | ||
| - **name** (String, Optional) The host name. Defaults to the resource name. | ||
|
|
||
|
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.