What is POP?

This project is built with pop, a Python-based implementation of Plugin Oriented Programming (POP). POP seeks to bring together concepts and wisdom from the history of computing in new ways to solve modern computing problems.

For more information:

• Intro to Plugin Oriented Programming (POP)

• pop-awesome

• pop-create

Prerequisites

• Python 3.8+

• git (if installing from source or contributing to the project)

  To contribute to the project and set up your local development environment, see CONTRIBUTING.rst in the source repository for this project.

Installation

You can install idem-spotinst with the Python package installer (PyPI) or from source.

pip install idem-spotinst

# clone repo
git clone git@<your-project-path>/idem-spotinst.git
cd idem-spotinst

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Setup

After installation, idem-spotinst execution and state modules are accessible to the pop hub.

For more information:

• Intro to Plugin Oriented Programming (POP)

• pop hub

To use idem-spotinst execution and state modules to manage spot instance resources, set up a credentials.yaml file for authentication. There are multiple authentication backends for idem-spotinst, where each has its own unique set of parameters. For example:

credentials.yaml:

spotinst:
  default:
    account_id: act-11c833de
    token: b5460afe3c29a30c28abd54d190d1aa923587574321e75925cfc8268b54b4562

For more about Idem credentials files, including recommended steps for encryption and environment variables, see Authenticating with Idem

You are now ready to use idem-spotinst.

States

Idem SLS files use states to ensure that resources are in a desired configuration. An idem-spotinst SLS file supports three state functions: present, absent, and describe.

Accessing States

States can be accessed by their relative location in idem-spotinst/idem_spotinst/states.

For example, a spotinst launch specification state can be created with the present function as shown in the following SLS file.

my_resource_launch_spec_state.sls:

my_resource_launch_spec:
    spotinst.ocean.aws.launch_spec.present:
      - name: my_resource_launch_spec
      - taints:
        - effect: NoSchedule
          key: taint1
          value: taint-value-1
      - tags:
        - tagKey: Env
          tagValue: test
      - subnet_ids:
        - subnet-06747be60363933d9
        - subnet-03b6d0dfc57e1gbd6
      - security_group_ids:
        - sg-08dcdf4874a2f5g04
        - sg-0844f76b69f16b8b8
      - ocean_id: o-b78b1e79
      - labels:
        - key: tag1
          value: value1
        - key: tag2
          value: value2
      - instance_types:
        - t2.micro
      - image_id: ami-0c02fb55956c7d318

The Idem command to create the preceding state is:

idem state $PWD/my_resource_launch_spec_state.sls

Your SLS should follow the resource parameter structure shown in the Spotinst REST API.

• Specify URI parameters in snake case with a leading dash and space “- “.

• Specify all parameters of the API request body exactly as shown in the the Spotinst REST API.

Current Supported Resource States