cliaas

README

cliaas

a cli tool to help with iaas interactions (this is meant to be a single cli for all iaases, instead of pulling in each individual tool for each iaas)

unit test status:

integration test status:

Configuration

The cliaas tool takes configuration in the form of environment variables. The following must be set depending on which IaaS provider you wish to target:

AWS

• AWS_ACCESS_KEY
• AWS_SECRET_KEY
• AWS_REGION
• AWS_VPC

CLI

aws command options]
          --accesskey=    aws access key [$AWS_ACCESSKEY]
          --secretkey=    aws secret access key [$AWS_SECRETKEY]
          --region=       aws region (default: us-east-1) [$AWS_REGION]
          --vpc=          aws VPC id [$AWS_VPC]
          --name=         aws name tag for vm [$AWS_NAME]
          --ami=          aws ami to provision [$AWS_AMI]
          --instanceType= aws instance type to provision [$AWS_INSTANCE_TYPE]
          --elastic-ip=   aws elastic ip to associate to provisioned VM [$AWS_ELASTIC_IP]

GCP

• GCP_CREDS - String representation of the creds file
• GCP_PROJECT
• GCP_ZONE

CI Pipeline

The integration-tests job can read GCP credentials through a params file or can be passed in via the command line as follows to avoid copying data from the credentials JSON:

fly -t c0 set-pipeline -p cliaas-ci -c ci/pipeline.yml -l ci/params.yml --var
gcp_creds="$(cat /path/to/creds.json)"

Integration Tests

The IAAS environment variable can be used to target a specific providers integration tests when running integration_tests/task.yml.

Documentation

Index

• Variables
• type AWSClient
  • func NewAWSClient(ec2Client EC2Client, vpcName string, options ...OptionFunc) AWSClient
• type Config
• type EC2Client
• type OptionFunc
  • func Clock(clock clock.Clock) OptionFunc
  • func Timeout(timeout time.Duration) OptionFunc
• type VMInfo
• type VMReplacer
  • func NewAWSVMReplacer(accessKeyID string, secretAccessKey string, region string, vpc string, ...) (VMReplacer, error)
  • func NewVMReplacer(config Config) (VMReplacer, error)

Variables

var Version = "0.0.0-dev"

Types

type AWSClient

type AWSClient interface {
	CreateVM(ami, instanceType, name, keyName, subnetID, securityGroupID string) (string, error)
	DeleteVM(instanceID string) error
	GetVMInfo(name string) (VMInfo, error)
	StopVM(instanceID string) error
	AssignPublicIP(instance, ip string) error
	WaitForStatus(instanceID string, status string) error
}

func NewAWSClient

func NewAWSClient(
	ec2Client EC2Client,
	vpcName string,
	options ...OptionFunc,
) AWSClient

type Config

type Config struct {
	AWS struct {
		AccessKeyID     string `yaml:"access_key_id"`
		SecretAccessKey string `yaml:"secret_access_key"`
		Region          string `yaml:"region"`
		VPC             string `yaml:"vpc"`
		AMI             string `yaml:"ami"`
	} `yaml:"aws"`
}

type EC2Client

type EC2Client interface {
	DescribeInstances(*ec2.DescribeInstancesInput) (*ec2.DescribeInstancesOutput, error)
	DescribeInstanceStatus(*ec2.DescribeInstanceStatusInput) (*ec2.DescribeInstanceStatusOutput, error)
	AssociateAddress(*ec2.AssociateAddressInput) (*ec2.AssociateAddressOutput, error)
	TerminateInstances(*ec2.TerminateInstancesInput) (*ec2.TerminateInstancesOutput, error)
	StopInstances(*ec2.StopInstancesInput) (*ec2.StopInstancesOutput, error)
	CreateTags(*ec2.CreateTagsInput) (*ec2.CreateTagsOutput, error)
	RunInstances(*ec2.RunInstancesInput) (*ec2.Reservation, error)
}

type OptionFunc

type OptionFunc func(*client)

func Clock

func Clock(clock clock.Clock) OptionFunc

func Timeout

func Timeout(timeout time.Duration) OptionFunc

type VMInfo

type VMInfo struct {
	InstanceID       string
	InstanceType     string
	KeyName          string
	SubnetID         string
	SecurityGroupIDs []string
	PublicIP         string
}

type VMReplacer

type VMReplacer interface {
	Replace(identifier string) error
}

func NewAWSVMReplacer

func NewAWSVMReplacer(
	accessKeyID string,
	secretAccessKey string,
	region string,
	vpc string,
	ami string,
) (VMReplacer, error)

func NewVMReplacer

func NewVMReplacer(config Config) (VMReplacer, error)