aws-run-instance summary

Plugin Name: aws-run-instance
Version: 0.0.13
Author: @melezhik
Realease Date: 2017-12-26 19:23:33
Short Description: run aws instance
Category: aws
Plugin web page: https://github.com/melezhik/aws-run-instance
 
Download link: aws-run-instance-v0.000013.tar.gz
Latest version link: https://sparrowhub.org/info/aws-run-instance

# 0.0.10-13

sec_groups option to add one or more security group IDs

# 0.0.9

Key fix

# 0.0.8

Assigning public IP option.

aws-run-instance documentation

SYNOPSIS

Sparrow plugin to run aws instance.

INSTALL

  $ sparrow plg install aws-run-instance

USAGE

To run instance you should set necessary 3 parameters:

  $ sparrow plg run  aws-run-instance --param subnet=$subnet-id --param image=$image-id --param type=$instance-type

The command will return JSON data upon successfull instance creation. You'll grep instance ID for further work with instance.

Run as sparrow task.

It's convenient to run plugin as sparrow task providing sane defaults:

  $ sparrow project create aws
  $ sparrow task add aws run-instance aws-run-instance
  $ sparrow task ini aws/run-instance

  ---
  image: ami-bla-bla-bla
  type: "t2.micro"
  subnet: subnet-bla-bla-bla

Setting tags.

To keep track of your instances you create with sparrow plugin you can use tag:

  $ sparrow plg run aws-run-instance --param tag_key=foo --param tag_value=bar ...

Or by using sparrow task:

  $ sparrow task ini aws/run-instance
  ---
  tag_key: foo
  tag_value: bar
  # ... other parameters 

Setting key name

To set name of the key pair, use key parameter:

  $ sparrow plg run aws-run-instance --param key=SupportUser ...

Or by using sparrow task:

  $ sparrow task ini aws/run-instance
  ---
  key: SupportUser

More about key pair read at the aws doc pages - http://docs.aws.amazon.com/cli/latest/reference/ec2/run-instances.html

Assigning public IP

Set associate_public_ip to "on" if you want a public IP address to be assigned to the new instance in a VPC.

  $ sparrow task ini aws/run-instance
  ---
  associate_public_ip: on

Adding one or more security group names

Set sec_groups

  $ sparrow task ini aws/run-instance
  ---
  sec_groups: sg-12345 sg-6789 sg-121344

Author

Alexey Melezhik

Prerequisites

Aws cli should be installed