CockroachDB Cloud: Installation & Configuration

Installation

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

• JavaScript/TypeScript: @pulumiverse/cockroach
• Python: pulumiverse_cockroach
• Go: github.com/pulumiverse/pulumi-cockroach/sdk/go/cockroach
• .NET: Pulumiverse.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/pulumiverse

Replace the version string with your desired version.

Migrating from the LbrLabs package

The maintenance of this provider has been transferred from LbrLabs to Pulumiverse. LbrLabs published up to v0.2.0, where Pulumiverse picks up with an initial v0.2.1 containing the renamed packages.

If you were using the LbrLabs edition, please update your dependencies to the Pulumiverse edition:

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.