Spotctl

A unified command-line interface to manage your Spot resources.

Installation
Getting Started
Documentation
Examples
Frequently Asked Questions
Getting Help
Community
Contributing
License

Installation

For macOS users, the easiest way to install spotctl is to use Homebrew:

$ brew install spotinst/tap/spotctl

Otherwise, please download the latest release from the Releases page.

Getting Started

Before using spotctl, you need to configure your Spot credentials. You can do this in several ways:

Environment variables
Credentials file

The quickest way to get started is to run the spotctl configure command:

$ spotctl configure

To use environment variables, do the following:

$ export SPOTINST_TOKEN=<spotinst_token>
$ export SPOTINST_ACCOUNT=<spotinst_account>

To use the credentials file, run the spotctl configure command or manually create an INI formatted file like this:

[default]
token   = <spotinst_token>
account = <spotinst_account>

and place it in:

Unix/Linux/macOS: ~/.spotinst/credentials
Windows: %UserProfile%\.spotinst/credentials

If you wish to place the credentials file in a different location than the one specified above, you need to tell spotctl where to find it. Do this by setting the following environment variable:

$ export SPOTINST_CREDENTIALS_FILE=/path/to/credentials_file

Documentation

If you're new to Spot and want to get started, please checkout our Getting Started guide, available on the Spot Documentation website.

Examples

Create a new quickstart Kubernetes cluster on AWS using kops with Ocean node instance groups:

$ spotctl ocean quickstart cluster kubernetes aws

Frequently Asked Questions

How do I set up credentials for spotctl
See Getting Started.

Getting Help

We use GitHub issues for tracking bugs and feature requests. Please use these community resources for getting help:

Ask a question on Stack Overflow and tag it with spotctl.
Join our Spot community on Slack.
Open an issue.

Community

Contributing

Please see the contribution guidelines.

License

Code is licensed under the Apache License 2.0. See NOTICE.md for complete details, including software and third-party licenses and permissions.

spotinst/spotctl