Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: a31f650cd9

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
bin
lib
scripts
spec
.rspec
CHANGELOG
Guardfile
README.md
bosh_aws_cpi.gemspec

README.md

BOSH AWS Cloud Provider Interface

Copyright (c) 2009-2012 VMware, Inc.

For online documentation see: http://rubydoc.info/gems/bosh_aws_cpi/

Options

These options are passed to the AWS CPI when it is instantiated.

AWS options

  • access_key_id (required)
    AWS IAM user access key
  • secret_access_key (required)
    AWS IAM secret access key
  • default_key_name (required)
    default AWS ssh key name to assign to created virtual machines
  • default_security_group (required)
    default AWS security group to assign to created virtual machines
  • ec2_private_key (required)
    local path to the ssh private key, must match default_key_name
  • region (optional)
    EC2 region, defaults to us-east-1
  • ec2_endpoint (optional)
    URL of the EC2 endpoint to connect to, defaults to the endpoint corresponding to the selected region, or DEFAULT_EC2_ENDPOINT if no region has been selected
  • max_retries (optional)
    maximum number of time to retry an AWS API call, defaults to DEFAULT_MAX_RETRIES

Registry options

The registry options are passed to the AWS CPI by the BOSH director based on the settings in director.yml, but can be overridden if needed.

  • endpoint (required)
    registry URL
  • user (required)
    registry user
  • password (required)
    registry password

Agent options

Agent options are passed to the AWS CPI by the BOSH director based on the settings in director.yml, but can be overridden if needed.

Resource pool options

These options are specified under cloud_options in the resource_pools section of a BOSH deployment manifest.

  • availability_zone (optional)
    the EC2 availability zone the VMs should be created in
  • instance_type (required)
    which type of instance the VMs should belong to

Network options

These options are specified under cloud_options in the networks section of a BOSH deployment manifest.

  • type (required)
    can be either dynamic for a DHCP assigned IP by AWS, or vip to use an Elastic IP (which needs to be already allocated)

Example

This is a sample of how AWS specific properties are used in a BOSH deployment manifest:

---
name: sample
director_uuid: 38ce80c3-e9e9-4aac-ba61-97c676631b91

...

networks:
  - name: nginx_network
    type: vip
    cloud_properties: {}
  - name: default
    type: dynamic
    cloud_properties:
      security_groups:
      - default

...

resource_pools:
  - name: common
    network: default
    size: 3
    stemcell:
      name: bosh-stemcell
      version: 0.6.7
    cloud_properties:
      instance_type: m1.small

...

properties:
  aws:
    access_key_id: AKIAIYJWVDUP4KRWBESQ
    secret_access_key: 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
    default_key_name: bosh
    default_security_groups: ["bosh"]
    ec2_private_key: /home/bosh/.ssh/bosh
Something went wrong with that request. Please try again.