tailscale: add node_id support (#513)

- Add `node_id` to both `tailscale_device` and `tailscale_devices` data
sources. This is already exposed by the Go client and something we want
to provide to users.
- Update docs to indicate that `id` is a legacy identifier and node_id
should be preferred.

- In `resource_device_authorization.go`, detect if the user passes a
node_id into device_id and save it to state instead of the legacy id,
this prevents a perpetual diff.
- Add backwards-compatibility and node_id tests in
`resource_device_authorization_test.go`

- In `resource_device_key.go`, detect if the user passes a node_id into
device_id and save it to state instead of the legacy id,
this prevents a perpetual diff.
- Add backwards compatibility and node_id tests in
`resource_device_key_test.go`

- In `resource_device_tags.go`, detect if the user passes a node_id into
device_id and save it to state instead of the legacy id,
this prevents a perpetual diff.
- Add backwards compatibility and node_id tests in
`resource_device_tags_test.go`

- Add a test in `resource_device_subnet_routes_test.go` to verify
backwards compatibility that `node_id` works as `device_id`. Since we
use a UUID for this resource, we don't need to update the read step as
with the others.

Long term, we will likely want to switch users over to using `node_id`
as the resource id, but will want to do that during a major version
change.

Signed-off-by: Zach Buchheit <[email protected]>

Author: zbuchheit

docs/data-sources/device.md

@@ -37,5 +37,6 @@ data "tailscale_device" "sample_device2" {
 
 - `addresses` (List of String) The list of device's IPs
 - `id` (String) The ID of this resource.
+- `node_id` (String) The preferred indentifier for a device.
 - `tags` (Set of String) The tags applied to the device
 - `user` (String) The user associated with the device

docs/data-sources/devices.md

@@ -39,5 +39,6 @@ Read-Only:
 - `hostname` (String)
 - `id` (String)
 - `name` (String)
+- `node_id` (String)
 - `tags` (Set of String)
 - `user` (String)

docs/resources/device_authorization.md

@@ -18,7 +18,8 @@ data "tailscale_device" "sample_device" {
 }
 
 resource "tailscale_device_authorization" "sample_authorization" {
-  device_id  = data.tailscale_device.sample_device.id
+  # Prefer the new, stable `node_id` attribute; the legacy `.id` field still works.
+  device_id  = data.tailscale_device.sample_device.node_id
   authorized = true
 }
 ```
@@ -40,6 +41,8 @@ resource "tailscale_device_authorization" "sample_authorization" {
 Import is supported using the following syntax:
 
 ```shell
-# Device authorization can be imported using the device id, e.g.,
+# Device authorization can be imported using the node ID (preferred), e.g.,
+terraform import tailscale_device_authorization.sample_authorization nodeidCNTRL
+# Device authorization can be imported using the legacy ID, e.g.,
 terraform import tailscale_device_authorization.sample_authorization 123456789
 ```

docs/resources/device_key.md

@@ -18,7 +18,8 @@ data "tailscale_device" "example_device" {
 }
 
 resource "tailscale_device_key" "example_key" {
-  device_id           = data.tailscale_device.example_device.id
+  # Prefer the new, stable `node_id` attribute; the legacy `.id` field still works.
+  device_id           = data.tailscale_device.example_device.node_id
   key_expiry_disabled = true
 }
 ```
@@ -43,6 +44,8 @@ resource "tailscale_device_key" "example_key" {
 Import is supported using the following syntax:
 
 ```shell
-# Device key can be imported using the device id, e.g.,
+# Device key can be imported using the node ID (preferred), e.g.,
+terraform import tailscale_device_key.sample nodeidCNTRL
+# Device key can be imported using the legacy ID, e.g.,
 terraform import tailscale_device_key.sample 123456789
 ```

docs/resources/device_subnet_routes.md

@@ -24,7 +24,8 @@ data "tailscale_device" "sample_device" {
 }
 
 resource "tailscale_device_subnet_routes" "sample_routes" {
-  device_id = data.tailscale_device.sample_device.id
+  # Prefer the new, stable `node_id` attribute; the legacy `.id` field still works.
+  device_id = data.tailscale_device.sample_device.node_id
   routes = [
     "10.0.1.0/24",
     "1.2.0.0/16",
@@ -33,7 +34,8 @@ resource "tailscale_device_subnet_routes" "sample_routes" {
 }
 
 resource "tailscale_device_subnet_routes" "sample_exit_node" {
-  device_id = data.tailscale_device.sample_device.id
+  # Prefer the new, stable `node_id` attribute; the legacy `.id` field still works.
+  device_id = data.tailscale_device.sample_device.node_id
   routes = [
     # Configure as an exit node
     "0.0.0.0/0",
@@ -59,6 +61,8 @@ resource "tailscale_device_subnet_routes" "sample_exit_node" {
 Import is supported using the following syntax:
 
 ```shell
-# Device subnet rules can be imported using the device id, e.g.,
+# Device subnet rules can be imported using the node ID (preferred), e.g.,
+terraform import tailscale_device_subnet_routes.sample nodeidCNTRL
+# Device subnet rules can be imported using the legacy ID, e.g.,
 terraform import tailscale_device_subnet_routes.sample 123456789
 ```

docs/resources/device_tags.md

@@ -18,7 +18,8 @@ data "tailscale_device" "sample_device" {
 }
 
 resource "tailscale_device_tags" "sample_tags" {
-  device_id = data.tailscale_device.sample_device.id
+  # Prefer the new, stable `node_id` attribute; the legacy `.id` field still works.
+  device_id = data.tailscale_device.sample_device.node_id
   tags      = ["room:bedroom"]
 }
 ```
@@ -40,6 +41,8 @@ resource "tailscale_device_tags" "sample_tags" {
 Import is supported using the following syntax:
 
 ```shell
-# Device tags can be imported using the device id, e.g.,
+# Device tags can be imported using the node ID (preferred), e.g.,
+terraform import tailscale_device_tags.sample nodeidCNTRL
+# Device tags can be imported using the legacy ID, e.g.,
 terraform import tailscale_device_tags.sample 123456789
 ```

examples/resources/tailscale_device_authorization/import.sh

@@ -1,2 +1,4 @@
-# Device authorization can be imported using the device id, e.g.,
+# Device authorization can be imported using the node ID (preferred), e.g.,
+terraform import tailscale_device_authorization.sample_authorization nodeidCNTRL
+# Device authorization can be imported using the legacy ID, e.g.,
 terraform import tailscale_device_authorization.sample_authorization 123456789

examples/resources/tailscale_device_authorization/resource.tf

@@ -3,7 +3,8 @@ data "tailscale_device" "sample_device" {
 }
 
 resource "tailscale_device_authorization" "sample_authorization" {
-  device_id  = data.tailscale_device.sample_device.id
+  # Prefer the new, stable `node_id` attribute; the legacy `.id` field still works.
+  device_id  = data.tailscale_device.sample_device.node_id
   authorized = true
 }
 

examples/resources/tailscale_device_key/import.sh

@@ -1,2 +1,4 @@
-# Device key can be imported using the device id, e.g.,
+# Device key can be imported using the node ID (preferred), e.g.,
+terraform import tailscale_device_key.sample nodeidCNTRL
+# Device key can be imported using the legacy ID, e.g.,
 terraform import tailscale_device_key.sample 123456789

examples/resources/tailscale_device_key/resource.tf

@@ -3,6 +3,7 @@ data "tailscale_device" "example_device" {
 }
 
 resource "tailscale_device_key" "example_key" {
-  device_id           = data.tailscale_device.example_device.id
+  # Prefer the new, stable `node_id` attribute; the legacy `.id` field still works.
+  device_id           = data.tailscale_device.example_device.node_id
   key_expiry_disabled = true
 }