bosh-google-cpi/

BOSH Google Compute Engine CPI

This is an external BOSH CPI for Google Compute Engine that is jointly developed by Pivotal and Google.

Usage

Deployment

This is the implementation of the CPI, and is part of the BOSH Google CPI release repository. See the README at the root of this repository for instructions on deploying the release with this CPI.

Installation

The source for this CPI is not intended to be deployed except as a BOSH deployment and is not go getable. To build or install the CPI locally for development or test purposes, you can symlink the repository into your Go workspace.

From the root of the bosh-google-cpi-boshrelease repository:

ln -s $(pwd)/src/bosh-google-cpi $GOPATH/src/

You can now go build or go install the "main" package.

Configuration

Create a configuration file:

{
  "cloud": {
    "plugin": "google",
    "properties": {
      "google": {
        "project": "my-gce-project",
        "json_key": "{\"private_key_id\": \"...\"}",
        "default_root_disk_size_gb": 20,
        "default_root_disk_type": ""
      },
      "agent": {
        "mbus": "https:\/\/mbus:mbus@0.0.0.0:6868",
        "ntp": [
          "169.254.169.254"
        ],
        "blobstore": {
          "provider": "local",
          "options": {
          }
        }
      },
      "registry": {
        "use_gce_metadata": true
      }
    }
  }
}

Run

Run the cpi using the previously created configuration file:

$ echo "{\"method\": \"method_name\", \"arguments\": []}" | cpi -configFile="/path/to/configuration_file.json"

Features

BOSH Network options

The BOSH Google Compute Engine CPI supports these BOSH Networks Types:

These options are specified under cloud_properties at the networks section of a BOSH deployment manifest and are only valid for manual or dynamic networks:

BOSH Resource pool options

These options are specified under cloud_properties at the resource_pools section of a BOSH deployment manifest:

BOSH Persistent Disks options

These options are specified under cloud_properties at the disk_pools section of a BOSH deployment manifest:

Deployment Manifest Example - Dynamic Networking

This is an example of how Google Compute Engine CPI specific properties are used in a BOSH deployment manifest with dynamic networking:

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

# ...

networks:
  - name: private
    type: dynamic
    dns:
      - 8.8.8.8
      - 8.8.4.4
    cloud_properties:
      network_name: default
      subnetwork_name: my-subnetwork
      ephemeral_external_ip: false
      ip_forwarding: false
      target_pool: my-load-balancer
      tags:
        - bosh

  - name: public
    type: vip
    cloud_properties: {}

resource_pools:
  - name: vms
    network: private
    stemcell:
      name: bosh-google-kvm-ubuntu-trusty-go_agent
      version: latest
    cloud_properties:
      instance_type: n1-standard-2
      zone: us-central1-a
      root_disk_size_gb: 20
      root_disk_type: pd-ssd
      automatic_restart: false
      on_host_maintenance: MIGRATE
      service_scopes:
        - compute.readonly
        - devstorage.read_write


disk_pools:
  - name: disks
    disk_size: 32_768
    cloud_properties:
      type: pd-ssd

Deployment Manifest Example - Manual Networking

This is an example of how Google Compute Engine CPI specific properties are used in a BOSH deployment manifest with manual networking. This assumes you've created a networked named custom-network and a subnetwork named custom-subnetwork with a CIDR of 10.0.0.0/24:

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

...

networks:
  - name: private
      type: manual
      subnets:
      - range: 10.0.0.0/24
        gateway: 10.0.0.1
        static: [10.0.0.2-10.0.0.100]
        cloud_properties:
          network_name: custom-network
          subnetwork_name: custom-subnetwork
          ephemeral_external_ip: true
          tags:
            - bosh

  - name: public
    type: vip
    cloud_properties: {}
...

resource_pools:
  - name: vms
    network: private
    stemcell:
      name: bosh-google-kvm-ubuntu-trusty-go_agent
      version: latest
    cloud_properties:
      instance_type: n1-standard-2
      zone: us-central1-a
      root_disk_size_gb: 20
      root_disk_type: pd-ssd
      automatic_restart: false
      on_host_maintenance: MIGRATE
      service_scopes:
        - compute.readonly
        - devstorage.read_write
...

disk_pools:
  - name: disks
    disk_size: 32_768
    cloud_properties:
      type: pd-ssd
...