spotctl

Rackspace Spot CLI (spotctl)

A command-line tool to manage Rackspace Spot resources including cloudspaces, node pools, organizations, and more.

Features

• Complete resource lifecycle management
• Multiple output formats (JSON, YAML, Table)
• OAuth2 authentication
• Interactive command structure
• Cross-platform support
• Easy configuration management

Installation

Prerequisites

• User should have access to Rackspace Spot Organization.
• User should have Refresh Token for the corresponding Organization.

Download the binary from the releases page: https://github.com/rackspace-spot/spotctl/releases

Move the binary to a directory in your PATH, for example:

sudo mv spotctl /usr/local/bin/

Verify installation:

spotctl --version

Configuration

In order to use spotctl, you need to configure your spotctl: You need pass the organization, region and refresh token.

# Run the interactive configuration wizard
spotctl configure

Available Commands

Authentication

• spotctl configure - Configure spotctl

Cloudspaces (Kubernetes Clusters)

• spotctl cloudspaces list - List all cloudspaces
• spotctl cloudspaces get <name> - Get details of a specific cloudspace
• spotctl cloudspaces create - Create a new cloudspace
• spotctl cloudspaces delete <name> - Delete a cloudspace
• spotctl cloudspaces get-config <name> - Get kubeconfig for a cloudspace

Node Pools

• spotctl nodepools spot list - List spot node pools
• spotctl nodepools spot create - Create a spot node pool
• spotctl nodepools ondemand list - List on-demand node pools
• spotctl nodepools ondemand create - Create an on-demand node pool

Server Classes

• spotctl serverclasses list - List available server classes
• spotctl serverclasses get <name> - Get details of a server class

Regions

• spotctl regions list - List available regions
• spotctl regions get <name> - Get details of a region

Organizations

• spotctl organizations list - List organizations
• spotctl organizations get <id> - Get organization details

Pricing

• spotctl pricing get <serverclass> - Get pricing information
• spotctl pricing get-all - Get pricing information for all server classes

Usage Examples

List all cloudspaces

spotctl cloudspaces list

Create a new cloudspace

Quick Create

spotctl cloudspaces create --name my-cluster --region us-east-1 

Config File

spotctl cloudspaces create --config my-cluster-config.yaml

Command Line Arguments (json)

spotctl cloudspaces create \
  --name <name> \
  --region <region> \
  --org <org> \
  --spot-nodepool '{"desired":1,"serverclass":"gp.vs1.medium-ord","bidprice":0.08}' \
  --ondemand-nodepool '{"desired":1,"serverclass":"gp.vs1.medium-ord"}' 

Command Line Arguments (comma separated)

spotctl cloudspaces create \
  --name <name> \
  --region <region> \
  --org <org> \
  --spot-nodepool desired=1,serverclass=gp.vs1.medium-ord,bidprice=0.08 \
  --ondemand-nodepool desired=1,serverclass=gp.vs1.medium-ord

Get kubeconfig for a cloudspace

spotctl cloudspaces get-config my-cluster --file ~/.kube/config-my-cluster

Delete a cloudspace

spotctl cloudspaces delete --name <my-cluster>

Organizations

# List all organizations
spotctl organizations list --output table

# Get organization details
spotctl organizations get org-123 --output json

Node Pools

Spot Node Pools

# Create spot node pool
spotctl nodepools spot create \
  --name spot-workers \
  --namespace org-123 \
  --cloudspace prod-cluster \
  --serverclass gp.vs1.medium-iad \
  --desired 5 \
  --bidprice 0.85

# List spot pools
spotctl nodepools spot list --namespace org-123 --output yaml

On-Demand Node Pools

# Create on-demand node pool
spotctl nodepools ondemand create \
  --name critical-workers \
  --namespace org-123 \
  --cloudspace prod-cluster \
  --serverclass mem.vs1.large-iad \
  --desired 3

# List on-demand pools
spotctl nodepools ondemand list --namespace org-123

Some commands examples

spotctl cloudspaces create \
  --name cli-test-205 \
  --region us-central-ord-1 \
  --org hooli \
  --spot-nodepool "name=d21538b9-8e65-4c09-ba2d-8ab9651d0412,serverclass=gp.vs1.medium-ord,desired=2,bidprice=0.09"

spotctl cloudspaces create \
  --name cli-test-157 \
  --region us-central-ord-1 \
  --org hooli \
  --ondemand-nodepool "name=d21538b9-8e65-4c09-ba2d-8ab9651d0411,serverclass=gp.vs1.medium-ord,desired=2"


spotctl nodepools spot create --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 --cloudspace cli-test-153 --desired 1 --serverclass gp.vs1.medium-ord --bidprice 0.08

spotctl nodepools spot update --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 --cloudspace cli-test-153 --desired 2 --bidprice 0.08

spotctl nodepools spot delete --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 

spotctl nodepools spot get --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 


Ondemand Nodepool Operations

spotctl nodepools ondemand list --cloudspace cli-test-153

spotctl nodepools ondemand get --name b7ea7dd1-f421-4b81-96a5-c28a6400a406

spotctl nodepools ondemand update --name b7ea7dd1-f421-4b81-96a5-c28a6400a406 --cloudspace cli-test-153 --desired 2

spotctl nodepools ondemand create --name b7ea7dd1-f421-4b81-96a5-c28a6400a406 --cloudspace cli-test-153 --desired 1 --serverclass gp.vs1.medium-ord

spotctl nodepools ondemand delete --name b7ea7dd1-f421-4b81-96a5-c28a6400a406

Some commands examples

spotctl cloudspaces create \
  --name cli-test-205 \
  --region us-central-ord-1 \
  --org hooli \
  --spot-nodepool "name=d21538b9-8e65-4c09-ba2d-8ab9651d0412,serverclass=gp.vs1.medium-ord,desired=2,bidprice=0.09"

spotctl cloudspaces create \
  --name cli-test-157 \
  --region us-central-ord-1 \
  --org hooli \
  --ondemand-nodepool "name=d21538b9-8e65-4c09-ba2d-8ab9651d0411,serverclass=gp.vs1.medium-ord,desired=2"


spotctl nodepools spot create --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 --cloudspace cli-test-153 --desired 1 --serverclass gp.vs1.medium-ord --bidprice 0.08

spotctl nodepools spot update --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 --cloudspace cli-test-153 --desired 2 --bidprice 0.08

spotctl nodepools spot delete --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 

spotctl nodepools spot get --name b7ea7dd1-f421-4b81-96a5-c28a6400a420 


Ondemand Nodepool Operations

spotctl nodepools ondemand list --cloudspace cli-test-153

spotctl nodepools ondemand get --name b7ea7dd1-f421-4b81-96a5-c28a6400a406

spotctl nodepools ondemand update --name b7ea7dd1-f421-4b81-96a5-c28a6400a406 --cloudspace cli-test-153 --desired 2

spotctl nodepools ondemand create --name b7ea7dd1-f421-4b81-96a5-c28a6400a406 --cloudspace cli-test-153 --desired 1 --serverclass gp.vs1.medium-ord

spotctl nodepools ondemand delete --name b7ea7dd1-f421-4b81-96a5-c28a6400a406

Output Formats

🧑‍💻 Support

For documentation, please refer to the official Rackspace Spot documentation. For support, ask your questions in the Rackspace community discussions, or drop us an email.

📜 License

Copyright © Rackspace US, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0