Welcome to Spawn
Spawn makes it easier to include the database as an automated component in your DevOps pipeline.
The Spawn service does this by creating ("Spawning") databases that more accurately represent what's in production, and in a way that reduces the burden of infrastructure and data management.
This guide explains how Spawn works, and how to control it via the command-line.
Getting started
If you're new to Spawn, we'd recommend following the steps below.
Download and install Spawn
Spawn is currently in open beta. Complete the installation instructions to get access, and then follow the instructions below to download and install Spawn.
Install Spawn
Windows
- Download spawnctl
- Add the folder containing spawnctl to the path
Mac and Linux
- Run this
curl -sL https://run.spawn.cc/install | sh
- Add spawnctl to your path
export PATH=$PATH:$HOME/.spawnctl/bin
Verify the CLI is installed by running
spawnctl version
On-board to Spawn
- Authenticate to the Spawn service
spawnctl auth
- Onboard to the Spawn service
spawnctl onboard
Docker
To pull and run the spawnctl container image, spawnctl
docker run --rm redgatefoundry/spawnctl
Standard interactive authentication using
spawnctl auth
will not work for docker containers
Use one of the following methods to access spawn using access token:
- Using
SPAWNCTL_ACCESS_TOKEN
environment variable
docker run --rm -e SPAWNCTL_ACCESS_TOKEN:<access-token-string> redgatefoundry/spawnctl
- Append --accessToken to
spawnctl
command
docker run --rm redgatefoundry/spawnctl get all --accessToken <access-token-string>
Using Spawn
The next section introduces the concepts of Spawn, and the terminology it uses. We recommend getting familiar with the concepts of Spawn before working through the examples in the Commands section.