Skip to content

Commit

Permalink
docs: Add documentation for trust token
Browse files Browse the repository at this point in the history
Signed-off-by: Din Music <[email protected]>
  • Loading branch information
MusicDin committed Aug 21, 2024
1 parent fcf8a43 commit 923a8bd
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/resources/trust_token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# lxd_trust_token

The `lxd_trust_token` resource allows you to create new tokens in the LXD trust store.

## Example Usage

```hcl
resource "lxd_trust_token" "token1" {
name = "mytoken"
}
output "token" {
value = lxd_trust_token.token1.token
}
```

## Argument Reference

* `name` - **Required** - Name of the token.

* `projects` - *Optional* - List of projects to restrict the token to.

* `remote` - *Optional* - The remote in which the resource will be created. If not provided,
the provider's default remote will be used.

* `trigger` - *Optional* - When to trigger the token generation. Possible values are `once` and `always` (if missing). Defaults to `always`.

## Attribute Reference

The following attributes are exported:

* `token` - The generated token.

* `expires_at` - Time when trust token expires. If token expiry is configured, the value will be in format `YYYY/MM/DD hh:mm TZ`.

## Trust token expiry

~> **Warning**
The provider is unable to differentiate between the expired and consumed token.
If token generation is set to `once` and the token expires, it will not be regenerated.

Trust token expiry is defined by the system configuration `core.remote_token_expiry`.
If the setting is configured, `expires_at` attribute will be populated, otherwise, it will be empty.

For example, to set the token expiry to 20 minutes, run the following command:
```
lxc config set core.remote_token_expiry=20M
```

If token expires or is manually removed, a new one will be created. Otherwise, the existing one is returned.

## Notes

* Token's unique identifier is the operation ID and not the token name. Therefore, multiple tokens can exist with the same name.

* See the LXD [documentation](https://documentation.ubuntu.com/lxd/en/latest/authentication/#authentication-token) for more information on trust tokens.

0 comments on commit 923a8bd

Please sign in to comment.