grantorchardandJohan Brandhorst-Satzkorn
9fca93399b
* add initial prototype of self managed worker resource and associated tests * Add self managed worker resource and associated tests * Update internal/provider/resource_self_managed_worker.go Accept suggested schema changes for tags Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * add environment variable check for worker led auth testing * change resource name from self_managed_worker to worker for consistency with the api * update tag schemas, ensure all attributes have descriptions * add generated docs for worker * add examples for worker resource * add examples for worker resource * remove merge conflict * Remove funtionality for reflecting tags in the schema * remove unused attributes (all tags) from schema, updates tests to use 'boundary_worker' on resource checks * update example for inclusion in the website docs --------- Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "boundary_worker Resource - terraform-provider-boundary"
|
|
subcategory: ""
|
|
description: |-
|
|
The resource allows you to create a self-managed worker object.
|
|
---
|
|
|
|
# boundary_worker (Resource)
|
|
|
|
The resource allows you to create a self-managed worker object.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "boundary_worker" "controller_led" {
|
|
scope_id = "global"
|
|
name = "worker 1"
|
|
description = "self managed worker with controller led auth"
|
|
}
|
|
|
|
resource "boundary_self_managed_worker" "worker_led" {
|
|
scope_id = "global"
|
|
name = "worker 2"
|
|
description = "self managed worker with worker led auth"
|
|
worker_generated_auth_token = var.worker_generated_auth_token
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Optional
|
|
|
|
- `description` (String) The description for the worker.
|
|
- `name` (String) The name for the worker.
|
|
- `scope_id` (String) The scope for the worker. Defaults to `global`.
|
|
- `worker_generated_auth_token` (String) The worker authentication token required to register the worker for the worker-led authentication flow. Leaving this blank will result in a controller generated token.
|
|
|
|
### Read-Only
|
|
|
|
- `address` (String) The accessible address of the self managed worker.
|
|
- `authorized_actions` (List of String) A list of actions that the worker is entitled to perform.
|
|
- `controller_generated_activation_token` (String) A single use token generated by the controller to be passed to the self-managed worker.
|
|
- `id` (String) The ID of the worker.
|
|
- `release_version` (Number) The version of the Boundary binary running on the self managed worker.
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
```shell
|
|
terraform import boundary_worker.foo <my-id>
|
|
```
|