Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document defaults for device_key and tailnet_key #292

Merged
merged 2 commits into from
Oct 5, 2023
Merged

Document defaults for device_key and tailnet_key #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09ddd11
Document defaults for `device_key` and `tailnet_key`
clstokes Oct 5, 2023
3d3aa04
Update docs
clstokes Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/resources/device_key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ resource "tailscale_device_key" "example_key" {

### Optional

- `key_expiry_disabled` (Boolean) Determines whether or not the device's key will expire
- `key_expiry_disabled` (Boolean) Determines whether or not the device's key will expire. Defaults to `false`.

### Read-Only

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/tailnet_key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ resource "tailscale_tailnet_key" "sample_key" {

### Optional

- `description` (String) A description of the key consisting of alphanumeric characters.
- `ephemeral` (Boolean) Indicates if the key is ephemeral.
- `expiry` (Number) The expiry of the key in seconds
- `preauthorized` (Boolean) Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default.
- `reusable` (Boolean) Indicates if the key is reusable or single-use.
- `description` (String) A description of the key consisting of alphanumeric characters. Defaults to `""`.
- `ephemeral` (Boolean) Indicates if the key is ephemeral. Defaults to `false`.
- `expiry` (Number) The expiry of the key in seconds. Defaults to `7776000` (90 days).
- `preauthorized` (Boolean) Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to `false`.
- `reusable` (Boolean) Indicates if the key is reusable or single-use. Defaults to `false`.
- `tags` (Set of String) List of tags to apply to the machines authenticated by the key.

### Read-Only
Expand Down
2 changes: 1 addition & 1 deletion tailscale/resource_device_key.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ func resourceDeviceKey() *schema.Resource {
"key_expiry_disabled": {
Type: schema.TypeBool,
Optional: true,
Description: "Determines whether or not the device's key will expire",
Description: "Determines whether or not the device's key will expire. Defaults to `false`.",
},
},
}
Expand Down
10 changes: 5 additions & 5 deletions tailscale/resource_tailnet_key.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ func resourceTailnetKey() *schema.Resource {
"reusable": {
Type: schema.TypeBool,
Optional: true,
Description: "Indicates if the key is reusable or single-use.",
Description: "Indicates if the key is reusable or single-use. Defaults to `false`.",
ForceNew: true,
},
"ephemeral": {
Type: schema.TypeBool,
Optional: true,
Description: "Indicates if the key is ephemeral.",
Description: "Indicates if the key is ephemeral. Defaults to `false`.",
ForceNew: true,
},
"tags": {
Expand All @@ -41,7 +41,7 @@ func resourceTailnetKey() *schema.Resource {
"preauthorized": {
Type: schema.TypeBool,
Optional: true,
Description: "Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default.",
Description: "Determines whether or not the machines authenticated by the key will be authorized for the tailnet by default. Defaults to `false`.",
ForceNew: true,
},
"key": {
Expand All @@ -53,7 +53,7 @@ func resourceTailnetKey() *schema.Resource {
"expiry": {
Type: schema.TypeInt,
Optional: true,
Description: "The expiry of the key in seconds",
Description: "The expiry of the key in seconds. Defaults to `7776000` (90 days).",
ForceNew: true,
},
"created_at": {
Expand All @@ -69,7 +69,7 @@ func resourceTailnetKey() *schema.Resource {
"description": {
Type: schema.TypeString,
Optional: true,
Description: "A description of the key consisting of alphanumeric characters.",
Description: "A description of the key consisting of alphanumeric characters. Defaults to `\"\"`.",
ForceNew: true,
},
},
Expand Down
Loading