CockroachDB Cloud: Installation & Configuration

Installation

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

• JavaScript/TypeScript: @lbrlabs/pulumi-cockroach
• Python: lbrlabs_pulumi_cockroach
• Go: github.com/lbrlabs/pulumi-cockroach/sdk/go/cockroach
• .NET: Lbrlabs.PulumiPackage.Cockroach

Provider Binary

The Cockroach provider binary is a third party binary. It can be installed using the pulumi plugin command.

pulumi plugin install resource cockroach <version> --server github://api.github.com/lbrlabs

Replace the version string with your desired version.

Setup

To provision resources with the Pulumi Cockroach provider, you need to have Cockroach credentials.

Set environment variables

Once you have provisioned these credentials, you can set environment variables to provision resources in Cockroach:

$ export COCKROACH_API_KEY=<COCKROACH_API_KEY>

$ export COCKROACH_API_KEY=<COCKROACH_API_KEY>

> $env:COCKROACH_API_KEY = "<COCKROACH_API_KEY>"

Configuration Options

Use pulumi config set cockroach:<option> or pass options to the constructor of new cockroach.Provider.