Skip to main content

Spare Cores Runner

Spare Cores Runner is a command-line tool and Python API designed to simplify the process of provisioning and managing cloud instances across various cloud providers. It leverages Pulumi to handle infrastructure-as-code and automate the creation and destruction of compute instances in your preferred cloud environment.

Spare Cores Runner (sc-runner from now on) is used by Spare Cores Inspector to start up basic cloud instances with the required minimum configuration and environment to start the machine with a custom cloud-init script, but it can also be used to simply start an instance with a given SSH key, making it available for basic use cases.

Supported Cloud Providers and their Credentials

sc-runner uses the Spare Cores database to pre-fill the available configuration options, like what regions and instance types are available for a given cloud provider. To use a given cloud provider, you have to provide credentials for them, either by running it in an environment where the underlying library can pick them up, or by specifying them through environment variables or command line options.

For more details, see the supported vendor's Pulumi integration:

Pulumi

As sc-runner uses Pulumi under the hood to manage the cloud providers, it'll need to have a Pulumi project. You can configure Pulumi project-related settings either by specifying them using command line arguments, shown below:

sc-runner create --help
Usage: sc-runner create [OPTIONS] COMMAND [ARGS]...

Options:
  --project-name TEXT        Pulumi project name  [default: runner]
  --work-dir TEXT            Pulumi work dir  [default: /data/workdir]
  --pulumi-home TEXT         Pulumi home  [default: /root/.pulumi]
  --pulumi-backend-url TEXT  Pulumi backend URL  [default: file:///data/backend]
  --stack-name TEXT          Pulumi stack name, defaults to
                             {vendor}.{region}.{zone}.{instance_id} or similar
  --help                     Show this message and exit.

Commands:
  aws
  azure
  gcp
  hcloud
  alicloud
  ovh
  upcloud
  vultr

Or by setting the following environment variables:

  • PULUMI_PROJECT_NAME
  • PULUMI_WORK_DIR
  • PULUMI_HOME
  • PULUMI_BACKEND_URL

sc-runner should create the project on the first invocation, during which it'll create multiple stacks for each vendor.region.zone.instance_id tuple. This allows concurrent creation of instances, supporting our Spare Cores Inspector use case, where we start a given instance type once to collect data from them.

Usage

CLI examples

Create instances

Create and destroy a default t3.micro instance in the default VPC/subnet in AWS:

sc-runner create aws
sc-runner destroy aws

Create an Azure instance with a public key:

sc-runner create azure --instance Standard_DS1_v2 --public-key $(cat .ssh/id_ed25519.pub)

Create an AWS instance with public IP and an already stored SSH key named spare_cores:

sc-runner create aws --region us-west-2 --instance t4g.large --instance-opts '{"associate_public_ip_address": true,"key_name":"spare-cores"}' --public-key ""

Destroy instances

sc-runner destroy azure --instance Standard_DS1_v2
sc-runner destroy aws --region us-west-2 --instance t4g.large

You can also use destroy-stack instead of destroy, which performs a pulumi refresh first, synchronizing the underlying cloud state with Pulumi's internal backend and destroying only what's really there (so it won't fail on already deleted resources).

Cancelling Pulumi Locks

Sometimes Pulumi might leave a lock file in its state store, preventing further operations. With this command you can cancel those:

sc-runner cancel aws --region us-west-2 --instance t4g.large

Docker

sc-runner is available through a Docker image as well, which you can use with the following command:

docker run --rm -ti ghcr.io/sparecores/sc-runner:main --help

You'll have to set up the same environment variables or configure the cloud credentials for Pulumi.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sparecores_runner-0.0.71.tar.gz (43.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sparecores_runner-0.0.71-py3-none-any.whl (55.0 kB view details)

Uploaded Python 3

File details

Details for the file sparecores_runner-0.0.71.tar.gz.

File metadata

  • Download URL: sparecores_runner-0.0.71.tar.gz
  • Upload date:
  • Size: 43.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sparecores_runner-0.0.71.tar.gz
Algorithm Hash digest
SHA256 9e76891b2541dbbc8750326bcc376244146dae47f993bbec3f506838c9a40c90
MD5 3b273a9deb2b0f5b6af47f263391ab6f
BLAKE2b-256 e4c28ce48fde3caf53075816fb4f77be009210970469ad2e5dcdf6bc05a09bae

See more details on using hashes here.

Provenance

The following attestation bundles were made for sparecores_runner-0.0.71.tar.gz:

Publisher: release.yml on SpareCores/sc-runner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sparecores_runner-0.0.71-py3-none-any.whl.

File metadata

File hashes

Hashes for sparecores_runner-0.0.71-py3-none-any.whl
Algorithm Hash digest
SHA256 371381ae3ed34d134e53bd457f0dc841e2338322bf237b725cb99f9e495f1f91
MD5 09b8b18acc87f6cf5c769e9729825573
BLAKE2b-256 299929e72231db1b1587448859e762df421f02453952c2c3852c8884706032da

See more details on using hashes here.

Provenance

The following attestation bundles were made for sparecores_runner-0.0.71-py3-none-any.whl:

Publisher: release.yml on SpareCores/sc-runner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.0.75

2 files

0.0.74

2 files

0.0.73

2 files

0.0.72

2 files

This release

0.0.71 This release

2 files

0.0.70

2 files

0.0.69

2 files

0.0.68

2 files

0.0.67

2 files

0.0.66

2 files

0.0.65

2 files

0.0.64

2 files

0.0.63

2 files

0.0.62

2 files

0.0.61

2 files

0.0.60

2 files

0.0.59

2 files

0.0.58

2 files

0.0.57

2 files

0.0.56

2 files

0.0.55

2 files

0.0.54

2 files

0.0.53

2 files

0.0.52

2 files

0.0.51

2 files

0.0.50

2 files

0.0.49

2 files

0.0.48

2 files

0.0.46

2 files

0.0.45

2 files

0.0.44

2 files

0.0.43

2 files

0.0.42

2 files

0.0.41

2 files

0.0.40

2 files

0.0.39

2 files

0.0.38

2 files

0.0.37

2 files

0.0.36

2 files

0.0.35

2 files

0.0.34

2 files

0.0.33

2 files

0.0.32

2 files

0.0.31

2 files

0.0.30

2 files

0.0.29

2 files

0.0.28

2 files

0.0.27

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.23

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page