Tailscale: Installation & Configuration

The Pulumi Tailscale provider uses the Tailscale SDK to manage resources.

Installation

The Tailscale provider is available as a package in all Pulumi languages:

• JavaScript/TypeScript: @pulumi/tailscale
• Python: pulumi-tailscale
• Go: github.com/pulumi/pulumi-tailscale/sdk/go/tailscale
• .NET: Pulumi.Tailscale

Configuring The Provider

Pulumi relies on the Tailscale SDK to authenticate requests from your computer to Tailscale. Your credentials are never sent to pulumi.com. Once the credentials are obtained, there are two ways to communicate your configuration parameters to Pulumi:

1. Set the environment variable TAILSCALE_API_KEY and TAILSCALE_TAILNET:

   $ export TAILSCALE_API_KEY=XXXXXX
   $ export TAILSCALE_TAILNET=YYYYYY
   

   With Oauth Client (conflicts with TAILSCALE_API_KEY):

   $ export OAUTH_CLIENT_SECRET=XXXXXX
   $ export OAUTH_CLIENT_ID=XXXXXX
   

2. If you prefer that they be stored alongside your Pulumi stack for easy multi-user access:

   $ pulumi config set tailscale:apiKey XXXXXX --secret
   $ pulumi config set tailscale:tailnet YYYYYY
   

   With Oauth Client (conflicts with TAILSCALE_API_KEY):

   $ pulumi config set tailscale:oauthClientSecret: XXXXXX --secret
   $ pulumi config set tailscale:oauthClientId: XXXXXX --secret
   

The complete list of configuration parameters is in the Tailscale provider README.