API
  • Help
  • Blog
  • News
  • Website
  • Go to Console
  • Getting Started with Spotinst
    • Introduction To Spotinst
    • Connect your Cloud Provider Account
    • Getting Started – Elastigroup
      • Getting Started – Elastigroup (AWS)
        • Create an Elastigroup Cluster from an existing ASG (Auto Scaling Group)
        • Create an Elastigroup Cluster from an existing ELB
    • Getting Started – Spotinst Ocean (AWS & GCP)
  • Spotinst Video Tutorials
    • Elastigroup
      • Account Setup
      • Elastigroup Budgets
      • Elastigroup with ECS
      • Elastigroup with Beanstalk
      • Elastigroup with Load Balancing
      • Elastigroup Dashboard Overview
      • Scaling Policies
    • Ocean
      • Importing K8s Cluster into Ocean
      • Ocean Dashboard Overview
      • Create EKS Cluster
      • Ocean for ECS
      • Workload Migration
    • Managed Instnace
      • Managed Instance Overview
  • Elastigroup For AWS
    • Tutorials
      • Connecting your AWS Account to Spotinst
      • Elastigroup Budgets
        • Introduction
        • Budgets Configuration
        • Budgets Monitoring
      • Stateful Tutorials
        • Create a Stateful Elastigroup from Scratch
      • Elastigroup Actions Menu
        • Deploy/Roll Elastigroup
        • Manage Group Capacity
        • Set Health Checks
        • Suspend Processes
        • Notifications
          • Creating Notifications
          • Elastigroup Notifications for Slack
          • Customizing Email Notifications
      • KMS Encryption And Spotinst
        • Using Cross-Account KMS key to encrypt EBS volumes with Spotinst
      • Create An Elastigroup from Scratch
      • Link an EC2-Classic instance to a VPC
      • Updating the Spotinst Policy
      • Restrict your Spotinst IAM Policy
      • Registering instances to Domain
      • Publish Elastigroup Metrics to CloudWatch
      • WordPress on Spot: Step-By-Step Guide
      • Filtering API responses based on group parameters
    • Concepts
      • General Concepts
        • Spot, Reserved & On Demand Instances
        • Market Scoring & Managing Interruptions
        • Cluster Orientation
        • Equal AZ Instance Distribution Orientation
        • Maintenance Windows
        • Elastigroup Capacity – Instances or Weighted
        • Scheduling
        • Instance Actions
        • Elastigroup Console Configuration Alerts
      • Compute Concepts
        • Auto Healing
        • Preferred Instance Types
        • AMI Auto Backup
        • Shutdown Scripts
        • Using Signals in Elastigroups
        • Termination Policy
        • Placement Groups
        • Block Device Mapping
      • Scaling Concepts
        • Simple Scaling Policies
        • Target Scaling
        • Predictive AutoScaling
        • Advanced Expressions
      • Stateful Concepts
        • Introduction
        • Import a Stateful Instance
        • Maintain Root Volume
        • Maintain Data Volumes
        • Maintain ENI’s & Private IP
        • Stateful Instance Actions
        • Scheduling Stateful Capacity
    • Services & Integrations
      • Elastic Beanstalk
        • Introduction
        • In-ASG
        • Independent Elastigroup Integration
        • Tutorials
          • Import a Beanstalk Environment
          • Roll Configuration Updates
      • Elastic MapReduce
        • Import an EMR Cluster (Clone)
          • Advanced – Using Bootstrap and Configuration files
        • Import Elastic MapReduce task nodes (Wrap)
        • Scaling Policies For EMR
        • Elastigroup Auto-Recover for EMR
        • Create an EMR Cluster
      • CodeDeploy
        • CodeDeploy Setup
        • Codedeploy – Blue/Green Deployment
      • OpsWorks
        • OpsWorks Integration Setup
        • OpsWorks Autohealing
      • Route53
      • AWS Batch
      • Kafka & Spotinst architecture
      • AWS’s Load Balancers – ELB and ALB
      • RightScale
      • Mesosphere
      • Spotinst Custom Health Check Service – HCS
  • Elastigroup For Azure
    • Getting Started With Elastigroup For Azure
    • Creating An Elastigroup in Azure
    • Connect Elastigroup to Application Gateway
    • Shutdown Script In Elastigroup For Azure
    • High Performance Computing – BETA
      • Introduction
      • Getting Started
  • Elastigroup For Google Cloud
    • Concepts
      • General Concepts
        • Preemptible, CUD & On Demand Instances
        • GCP’s Load Balancers – Backend Services
      • Compute Concepts
        • Scaling Policies For GCP Elastigroup
        • Shutdown Scripts
    • Tutorials
      • Connect Spotinst To A GCP Account
      • Create An Elastigroup From Scratch
  • Ocean
    • Concepts
      • Ocean Cloud
        • Introduction
        • Kubernetes Scaling
        • ECS Scaling
        • Health Checks & Auto-Healing
        • Launch Specifications
        • Spotinst Labels & Taints
        • Cost Management
        • Right Sizing
        • Cluster Roll
      • Ocean On-premises
        • Introduction
    • Tutorials
      • Ocean for ECS
        • Create an Ocean Cloud cluster
        • Migrating existing ECS clusters from Elastigroup
      • Ocean for GKE
        • Create an Ocean Cloud cluster
        • Import a GKE Cluster Using Shared VPC
      • Ocean for EKS\Kops
        • Import an EKS Based Ocean Cluster
        • Migrate Existing Elastigroups to Ocean
        • Launch an Ocean Cluster associated with a new EKS Cluster
        • Upgrade Elastigroup To Ocean Using KOPS
        • Workload Migration
        • Custom Labels
        • Right Sizing Usage
        • Run Workloads
      • Spotinst Kubernetes Controller
        • Controller Installation
          • Install with kubectl
          • Install with Terraform
          • Install with Helm
        • Updating Controller
        • Spotinst Kubernetes Controller Permissions
        • Change Log
  • Managed Instances
    • Concepts
      • Introduction
      • How It Works – Stateful Managed Instances
      • Root Volume Persistence
      • Data Volume Persistence
      • Network Persistence
      • Replacement Process
      • Third Party Integrations
      • Managed Instance Actions
    • Tutorials
      • Managed Instance Creation
  • Container Management
    • Kubernetes
      • Introduction
      • Tutorials
        • Spotinst Kubernetes Controller
          • Controller Installation
            • Install with kubectl
            • Install with Helm
            • Install with Terraform
          • Updating Spotinst’s Kubernetes Controller
          • Spotinst Kubernetes Controller Permissions
          • Change Log
        • Create a Kubernetes Bearer Token
        • Configure Auto Healing for Kubernetes
        • Custom Label Selectors
        • OpenShift
      • Concepts
        • Kubernetes Cluster Auto Scaling
        • Persistent Volumes Support
        • Spotinst Labels & Taints
      • Amazon EKS
        • Create Elastigroup-based EKS Cluster
        • Configure kubectl For EKS & Install Spotinst controller
      • Azure AKS Engine
      • Google Kubernetes Engine
      • KOPS (Kubernetes Operations)
        • KOPS 1.14
          • Install
          • Getting Started
          • Instance Groups
          • Create / Import Clusters
        • KOPS 1.13
          • Install
          • Getting Started
          • Instance Groups
          • Create / Import Clusters
        • KOPS 1.12
          • Install
          • Getting Started
          • Instance Groups
          • Create / Import Clusters
        • KOPS 1.11
          • Install
          • Getting Started
          • Instance Groups
          • Create / Import Clusters
        • KOPS 1.10
          • Install
          • Getting Started
          • Instance Groups
          • Prerequisites
    • Amazon ECS
      • Getting Started
      • Integration Overview
      • Tutorials
        • Enable Autoscaling for ECS
        • Custom Autoscaler for ECS
        • Configure Health Checks and Autohealing
        • Configure Attributes for Task Placement Constraints
        • Import Fargate Services to ECS Elastigroup
        • Create Cluster Roll
      • Concepts
        • Automatic Autoscaler for ECS
        • Autoscaler Headroom
        • Autoscaler Tetris Scaling
    • Rancher
      • Rancher Versions 2.0+
      • Rancher Versions < 2.0
    • Docker Swarm
      • Docker Swarm Integration
      • Docker Swarm Auto-Scaler
    • Nomad
      • Setting up Nomad on Elastigroup
      • Nomad Autoscaler Setup
      • Nomad Autoscaling Concepts
  • Spotinst API
    • Administration
      • Create an API Token
      • Whitelist IPs
      • Spotinst AWS Policy
      • Spotinst GCP Policy
      • Notifications Service
        • Subscriptions
          • List All
          • Subscribe
          • Update
          • List Notification
          • Un-subscribe
      • Health Check Service
        • Create
        • Update
        • List all HCS
        • List HCS
        • Delete
      • Insights Service
        • Organization Instance Costs
      • Organization & Accounts
        • Set Cloud Credentials
          • Set Cloud Credentials For AWS
          • Validate Cloud Credentials For GCP
          • Set Cloud Credentials For GCP
          • Set Cloud Credentials For Azure
          • Validate Cloud Credentials For Azure
        • Create Organization
        • Create Account
        • Get Accounts
        • Delete Organization
        • Delete Account
        • Create User
        • Add Existing User
        • Assign Users to Accounts
        • Get User
        • Update User Role
        • Detach User
    • Elastigroup
      • Amazon Web Services
        • List Group
        • List All Groups
        • Create
        • Update
        • Update Group Capacity
        • Delete
        • Status
        • Scale Up
        • Scale Down
        • Detach Instance
        • Deploy
        • Deploy Status
        • Group’s Deployments Status
        • Stop Deployment
        • Deployment Actions
        • Create Instance Signal
        • Get Elastigroup Log Entries from Group
        • Suspend Processes
        • Remove Suspended Processes
        • List Suspended Processes
        • Suspend Scaling Policies
        • List Suspended Scaling Policies
        • Remove Suspended Scaling Policies
        • Instance type by region
        • Lock Instances
        • Unlock Instances
        • Instance Standby
        • Exit Instance Standby
        • Instance Status
        • Costs Per Elastigroup
        • Simulate an Instance Interruption
        • Costs Per Account
        • List All Events
        • Group Detailed Cost
        • Activity Events
        • Instance Healthiness
        • Import ASG
        • AMI Backup
        • Kubernetes Cluster Costs
        • Instances Potential Savings
        • Potential Savings
        • Suggested Instance Type
        • Beanstalk API
          • Create Beanstalk Elastigroup
          • Get Beanstalk configuration
          • Start Beanstalk Maintenance
          • Get Beanstalk maintenance status
          • Finish Beanstalk Maintenance
          • Beanstalk ReImport
        • Stateful API
          • Import Stateful Instance
          • Get Stateful Import Status
          • Delete Stateful Import Status
          • Terminate Stateful Instance During Import Process
          • Pause Stateful Instance
          • Resume Stateful Instance
          • Recycle Stateful Instance
          • List Stateful Instances
          • De-allocate Stateful Instance
        • CodeDeploy API
          • Create CodeDeploy B/G Deployment
          • Get CodeDeploy B/G Deployment
        • EMR API
          • Create
          • Update
          • List All MR Scalers
          • List MR Scaler
          • Delete MR Scaler
          • List Instances
          • MR Scaler Clusters
          • MR Scaler Costs
          • Scale Up
          • Scale Down
        • ECS API
          • Initiate Cluster Roll
          • Update Cluster Roll Status
          • Get Cluster Roll Status By Roll ID
          • Get All Cluster Rolls Per Elastigroup
      • Google-Cloud
        • Create
        • Update
        • Status
        • List Group
        • List All Groups
        • Delete Group
        • Import GKE Cluster
        • Scale Up
        • Scale Down
        • Detach Instances
        • Deploy
        • Deploy Status
        • Group’s Deployments Status
        • Stop Deployment
        • Costs
        • Activity Events
        • Lock Instances
        • Unlock Instances
        • Instance Status
        • Fetch Elastilog
      • Microsoft Azure
        • Create
        • Update
        • List Group
        • List All Groups
        • Delete Group
        • Group Status
        • Detach Instances
        • Roll
        • Roll Status
        • Group’s Rolls Status
        • Stop Roll
        • Get Account Costs
        • Tasks
          • Create
          • Read Task
          • List All Tasks
          • Update
          • Delete
    • Ocean
      • Ocean Cloud
        • Ocean For AWS
          • Create
          • Update
          • Delete
          • Get
          • Get All
          • Get Right-Sizing Recommendations
          • Upgrade Elastigroup To Ocean
          • Launch Specifications
            • Create
            • Update
            • Get
            • Get All
            • Delete
          • Roll Cluster
            • Initiate Cluster Roll
            • Update Cluster Roll
            • Get Cluster Roll
            • Get All Cluster Rolls
        • Ocean For ECS
          • Create
          • Update
          • Get
          • Get All
          • Delete
          • Get Right-Sizing Recommendations
          • Upgrade Elastigroup To Ocean
          • Launch Specifications
            • Create
            • Update
            • Get
            • Get All
            • Delete
          • Roll Cluster
            • Initiate Cluster Roll
            • Update Cluster Roll
            • Get Cluster Roll
            • Get All Cluster Rolls
        • Ocean For GKE
          • Create
          • Update
          • Delete
          • Get
          • Get All
          • Fetch Elastilog
          • Get Right-Sizing Recommendations
          • Launch Specifications
            • Create
            • Update
            • Get
            • Get All
            • Delete
          • Roll Cluster
            • Initiate Cluster Roll
            • Update Cluster Roll
            • Get Cluster Roll
            • Get All Cluster Roll
      • Ocean On-Premises
        • Create
        • Update
        • Delete
        • List
        • List All Ocean On-Prem
    • Managed Instance
      • Create
      • Update
      • Get
      • Get All
      • Recycle
      • Resume
      • Pause
      • Delete
    • Multai Load Balancer
      • Runtime
        • List All
        • Read
        • Deregister
        • Delete
      • Deployment
        • Create
        • Get
        • List All
        • Delete
      • Balancer
        • List All
        • Create
        • Update
        • Read
        • Delete
      • Target Set
        • List All
        • Create
        • Update
        • Read
        • Register Targets
        • Deregister Targets
        • Delete
      • Target
        • List All
        • Create
        • Update
        • Get
        • Delete
      • Listener
        • List All
        • Create
        • Update
        • Read
        • Delete
      • Routing Rule
        • Update
        • Read
        • Delete
        • List All
        • Create
      • Middleware
        • List All
        • Create
        • Delete
        • Read
        • Update
  • Provisioning, CI/CD & SDK
    • Provisioning Tools
      • Terraform
        • Introduction
        • Installation
          • Installation Manual
          • Installation Links
        • Configuration
        • Resources
          • V3 (v0.12)
            • AWS: Elastigroup
            • AWS: Elastic Beanstalk
            • AWS: Ocean
            • AWS: Ocean Launch Spec
            • AWS: Ocean ECS
            • AWS: Ocean ECS Launch Spec
            • Azure: Elastigroup
            • GCP: Elastigroup
            • GKE: Elastigroup
            • GKE: Ocean
            • GKE: Ocean Launch Spec
            • Subscription
          • V2 (v0.10-v0.11)
            • AWS: Elastigroup
            • AWS: Elastic Beanstalk
            • AWS: Ocean
            • AWS: Ocean Launch Spec
            • Azure: Elastigroup
            • GCP: Elastigroup
            • GKE: Elastigroup
            • Subscription
          • V1 (v0.8-v0.9)
            • Elastigroup EMR
            • Elastic Beanstalk
            • Elastigroup
            • Multai Load Balancer
            • Health Check Service
            • Subscription
          • Migrating to Spotinst Official Provider
          • Upgrading to Terraform v0.12
      • CloudFormation
        • Introduction
          • Overview
          • Set Up
          • Resources Types
        • Template Structure
          • Parameters
          • Resources
          • Output
          • References
        • Examples
          • Elastigroup
            • Create Elastigroup – Generic
            • Create Elastigroup – Stateful
            • Create Elastigroup – YML based
            • Create Elastigroup for ECS – YML based
          • Ocean
            • Kubernetes Ocean Cluster
            • Kubernetes Ocean Launch Spec
            • ECS Ocean Cluster
            • ECS Ocean Launch Spec
          • Notification
          • Import ASG
          • Beanstalk
            • Use Existing Environment
            • Create New Environment
          • EMR
            • Clone Cluster
            • Wrap Cluster
          • HCS
            • Create
          • Multai Load Balancer
          • Spectrum
            • Spectrum Action
            • Spectrum Alert
        • Troposphere
        • CFN Helper Scripts
      • Ansible
      • CloudFoundry BOSH
    • CI/CD
      • Jenkins
      • Chef
      • GitLab
    • Python SDK
  • Multai Load Balancer
    • Introduction
    • Installation
      • Install on AWS
      • General Cloud Deployment
    • Attaching MLB to Elastigroup
    • Routing Rules & Aliases
    • SSL Certificate
  • Account & User Management
    • Users Management
      • User roles
      • Add Users to Accounts
      • Generate and Reset User Password
      • Programmatic Users
      • SSO Access Control
        • Set SSO
        • Organization Level SSO
        • Account Level SSO
        • Identity Providers
          • Okta SAML Authentication
          • OneLogin SAML Authentication
          • ADFS SAML Authentication
          • Bitium SAML Authentication
          • Custom SAML Idp Configuration
          • Spotinst Azure Active Directory Integration
    • Organizations Management
      • Organizations And Accounts
      • How to switch between organizations
      • Audit Events
    • Configure Payment Details
  • Eco
    • Eco – Overview
    • Eco – Link Account
    • Eco – Reservation Analysis
    • Eco – Overview Dashboard
  • Cloud Analyzer
    • Cloud Analyzer – Onboarding
    • Cloud Analyzer – Cost Analysis
    • Cloud Analyzer – Trends & Notifications
    • Cloud Analyzer – Optimization

Spotinst Documentation

 

Welcome to the heart and soul of Spotinst: our Documentation, here you can find user guides, developer guides, API references, tutorials, and more.

 

Getting Started

  • Introduction to Spotinst
  • Connect a Cloud Provider Account 
  • Getting Started with Elastigroup 
  • Getting Started with Ocean 

Elastigroup For AWS

  • Tutorials
  • Concepts
  • Services & Integrations

Elastigroup for Azure

  • Getting Started with Elastigroup for Azure
  • Creating an Elastigroup in Azure
  • Connecting Elastigroup to Azure Application Gateway
  • Shutdown script In Elastigroup for Azure
  • High performance computing

Elastigroup for Google Cloud

  • Elastigroup for GCE
  • Concepts
  • Tutorials

Ocean

  • Concepts
    • Ocean Cloud
    • Ocean On-premises
  • Ocean for GKE
  • Ocean for AWS

Container Management

  • Kubernetes
  • Amazon ECS
  • Rancher
  • Docker Swarm
  • Nomad

Spotinst API

  • Administration
  • Elastigroup for AWS
  • Elastigroup for Google Cloud
  • Elastigroup for Azure
  • Ocean API
  • Multai Load Balancer
  • Spectrum

Provisioning Tools, CI/CD & SDK

  • Provisioning Tools
  • CI/CD
  • Python SDK

Multai Load Balancer

  • Spotinst Multai Load Balancer (MLB)

Account & User Management

  • Users Management
  • Organizations Management
  • Configure Payment Details