cliaas

README

cliaas

cliaas wraps multiple IaaS-specific libraries to perform some IaaS-agnostic functions. Presently it only supports upgrading a Pivotal Cloud Foundry Operations Manager VM.

Using master from this repo directly may result in breaking the pipelines that consume it. Tracking master is considered unstable. Please use the official releases, or the pcf-pipelines release on Pivotal Network.

Installing

Download the latest release.

Install from source

Requirements:

• glide
• go

mkdir -p $GOPATH/src/github.com/pivotal-cf
git clone --depth 1 https://github.com/pivotal-cf/cliaas $GOPATH/src/github.com/pivotal-cf/cliaas
cd $GOPATH/src/github.com/pivotal-cf/cliaas
glide install
go install github.com/pivotal-cf/cliaas/cmd/cliaas

Usage

cliaas -c config.yml replace-vm --identifier vm-identifier

Config

The -c, --config= flag is for specifying a YAML file with IaaS-specific configuration options to use when running a command. The config should only contain the configuration for a single IaaS for now.

AWS-specific Config

cat > config.yml <<EOF
  aws:
    access_key_id: example-access-key-id
    secret_access_key: example-secret-access-key
    region: us-east-1
    vpc: vpc-12345678
    ami: ami-019e4617
EOF

• access_key_id: The AWS_ACCESS_KEY_ID to use. Must have the ability to stop VM, start VM, and associate an IP address.
• secret_access_key: The AWS_SECRET_ACCESS_KEY to use. Must have the ability to stop VM, start VM, and associate an IP address.
• region: The AWS region to use.
• vpc: The AWS vpc to use.
• ami: A Pivotal Cloud Foundry Operations Manager AMI, for the new VM in replace-vm.

Notes:

• AWS implementation assumes an Elastic IP is assigned to the Ops Manager VM. If you do not have one allocated to the VM, your replace-vm calls will likely fail on assigning public IP.
• The given identifier will match only if the instance has a state of Running. All other matches with any state other than Running will be ignored.

GCP-specific Config

cat > config.yml <<EOF
  gcp:
    credfile: /tmp/gcp-creds.json
    zone: us-east-1
    project: my-gcp-projectname
    disk_image_url: opsmanager-disk-image-url 
EOF

• credfile: The path of your credentials json file issued by gcp.
• zone: the zone in gcp your deployments are in.
• project: the name of the gcp project you're using.
• disk_image_url:: the url of ops manager image provided by pivotal on pivnet

Azure-specific Config

!!! The replace-vm call on Azure will DELETE the current ops manager vm when standing up the new version. This behavior is different than other IaaS' so be warned !!!

cat > config.yml <<EOF
  azure:
    vhd_image_url: xxxx
    subscription_id: xxxxxx 
    client_id: xxxxx
    client_secret: xxxxx
    tenant_id: xxxxx
    resource_group_name: xxxxx
    resource_manager_endpoint: xxxxx
    storage_account_name: xxxx
    storage_account_key: xxxx
    storage_container_name: xxxx
    storage_url: xxxx
    vm_admin_password: xxxxx
EOF

• vhd_image_url: xxxxxx //$ the url of ops manager vhd provided by Pivotal, which can be found on pivnet
• subscription_id: xxxxxx //$ azure account show | grep "data: ID"
• client_id: xxxxx //this is the appID output of azure ad app create
• client_secret: xxxxx //this is the password given as a param to the $ azure ad sp create
• tenant_id: xxxxx //$ azure account show | grep "Tenant ID"
• resource_group_name: xxxxx /// this is just the resource group name we wish to target
• storage_account_name: xxxx // this is the name of the storage account you wish to use for storing ops manager vhd
• storage_account_key: xxxx // this is the key to access the above storage account
• storage_container_name: xxxx // the name of the storage container you wish to place the ops manager disk image vhd
• //optional values
• resource_manager_endpoint: xxxx /// option value. defaults to https://management.azure.com/
• storage_url: xxxx // optional storage url to overwrite default value (core.windows.net)
• vm_admin_password: xxxx // optional vm admin password ( a random one will be used if none given)

Identifiers

The VM identifier is used to find the VM by name in the IaaS.

Image values in config.yml

• For AWS, the image is an AMI, e.g. ami-019e4617
• For GCP, the image is a disk image url, e.g. https://storage.googleapis.com/ops-manager-us/pcf-gcp-1.9.3.tar.gz
• For Azure, the image is a disk image url, e.g. https://opsmanagereastus.blob.core.windows.net/images/ops-manager-1.10.3.vhd

Developing

go install github.com/onsi/ginkgo/ginkgo
ginkgo -r -p -race -skipPackage integration

Documentation

Index

• Variables
• type AWSConfig
  • func (c *AWSConfig) Complete() bool
  • func (c *AWSConfig) Image() string
  • func (c *AWSConfig) NewClient() (Client, error)
• type AzureConfig
  • func (c *AzureConfig) Complete() bool
  • func (c *AzureConfig) Image() string
  • func (c *AzureConfig) NewClient() (Client, error)
• type Client
  • func NewAWSAPIClient(client aws.AWSClient) Client
• type Config
• type GCPConfig
  • func (c *GCPConfig) Complete() bool
  • func (c *GCPConfig) Image() string
  • func (c *GCPConfig) NewClient() (Client, error)
• type MultiConfig
  • func (c *MultiConfig) CompleteConfigs() []Config
  • func (c *MultiConfig) Configs() []Config

Variables

var Version string

Types

type AWSConfig

type AWSConfig struct {
	AMI             string `yaml:"ami"`
	AccessKeyID     string `yaml:"access_key_id"`
	SecretAccessKey string `yaml:"secret_access_key"`
	Region          string `yaml:"region"`
	VPCID           string `yaml:"vpc"`
}

func (*AWSConfig) Complete

func (c *AWSConfig) Complete() bool

func (*AWSConfig) Image

func (c *AWSConfig) Image() string

func (*AWSConfig) NewClient

func (c *AWSConfig) NewClient() (Client, error)

type AzureConfig

type AzureConfig struct {
	VHDImageURL             string `yaml:"vhd_image_url"`
	SubscriptionID          string `yaml:"subscription_id"`
	ClientID                string `yaml:"client_id"`
	ClientSecret            string `yaml:"client_secret"`
	TenantID                string `yaml:"tenant_id"`
	ResourceGroupName       string `yaml:"resource_group_name"`
	ResourceManagerEndpoint string `yaml:"resource_manager_endpoint"`
	StorageAccountName      string `yaml:"storage_account_name"`
	StorageAccountKey       string `yaml:"storage_account_key"`
	StorageContainerName    string `yaml:"storage_container_name"`
	StorageURL              string `yaml:"storage_url"`
	VMAdminPassword         string `yaml:"vm_admin_password"`
}

func (*AzureConfig) Complete

func (c *AzureConfig) Complete() bool

func (*AzureConfig) Image

func (c *AzureConfig) Image() string

func (*AzureConfig) NewClient

func (c *AzureConfig) NewClient() (Client, error)

type Client

type Client interface {
	Delete(vmIdentifier string) error
	Replace(vmIdentifier string, imageIdentifier string, diskSizeGB int64) error
	GetDisk(vmIdentifier string) (iaas.Disk, error)
}

func NewAWSAPIClient

func NewAWSAPIClient(client aws.AWSClient) Client

type Config

type Config interface {
	Image() string
	Complete() bool
	NewClient() (Client, error)
}

type GCPConfig

type GCPConfig struct {
	CredfilePath string `yaml:"credfile"`
	Zone         string `yaml:"zone"`
	Project      string `yaml:"project"`
	DiskImageURL string `yaml:"disk_image_url"`
}

func (*GCPConfig) Complete

func (c *GCPConfig) Complete() bool

func (*GCPConfig) Image

func (c *GCPConfig) Image() string

func (*GCPConfig) NewClient

func (c *GCPConfig) NewClient() (Client, error)

type MultiConfig

type MultiConfig struct {
	AWS   *AWSConfig   `yaml:"aws"`
	GCP   *GCPConfig   `yaml:"gcp"`
	Azure *AzureConfig `yaml:"azure"`
}

func (*MultiConfig) CompleteConfigs

func (c *MultiConfig) CompleteConfigs() []Config

func (*MultiConfig) Configs

func (c *MultiConfig) Configs() []Config