Skip to content

Latest commit

 

History

History
277 lines (226 loc) · 9.1 KB

README.md

File metadata and controls

277 lines (226 loc) · 9.1 KB
Raw

BOSH Azure Cloud Provider Interface

Options

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

Azure options

  • environment (required) The environment for Azure Management Service: AzureCloud or AzureChinaCloud
  • subscription_id (required) Azure Subscription Id
  • storage_account_name (required) Azure storage account name. Please make sure that those two containers 'bosh' and 'stemcell' are created in it.
  • resource_group_name (required) Resource group name to use when spinning up new vms
  • tenant_id (required) The tenant id for your service principal
  • client_id (required) The client id for your service principal
  • client_secret (required) The client secret for your service principal
  • ssh_user (required) The user to use when spinning up new vms
  • ssh_certificate (required) The content of the default certificate to use when spinning up new vms
  • parallel_upload_thread_num (optional) The number of threads to upload stemcells in parallel. The default value is 16.

Registry options

The registry options are passed to the Azure 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 Azure 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_properties in the resource_pools section of a BOSH deployment manifest.

  • instance_type (required) which type of instance the VMs should belong to

  • storage_account_name (optional) which storage account the VMs should be created in. If this is not set, the VMs will be created in the default storage account. If you use a different storage account which must be in the same resource group, please make sure

    1. the permissions for the container 'stemcell' in the default storage account is set to Public read access for blobs only.
    2. a table 'stemcells' is created in the default storage account.
    3. two containers 'bosh' and 'stemcell' are created in the new storage account. If you use DS-series or GS-series as instance_type, you should set this to a premium storage account. See more information about Azure premium storage See avaliable regions here where you can create premium storage accounts.

  • caching (optional) The caching option of the VMs' OS disks. Can be either 'None', 'ReadOnly' or 'ReadWrite'. Default is 'ReadWrite'

  • availability_set (optional) which availability set the VMs should belong to. If it does exist, it will be created automatically.

  • platform_update_domain_count (optional) The count of update domain in the availability set. Default value is 5.

  • platform_fault_domain_count (optional) The count of fault domain in the availability set. Default value is 3.

  • load_balancer (optional) which load balancer the VMs should belong to. You need to create the load balancer manually before configuring it.

Network options

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

  • type (required) can be either dynamic for a DHCP assigned IP by Azure, or 'manual' to use an assigned IP by BOSH director, or vip to use a reserved public IP (which needs to be already allocated)

Disk options

These options are specified under cloud_properties in the disk_pools section of a BOSH deployment manifest.

  • caching (optional) can be either 'None', 'ReadOnly' or 'ReadWrite'. Default is 'None'. Only 'None' and 'ReadOnly' are supported for premium disks.

Examples

Below is a sample of how Azure specific properties are used in a BOSH deployment manifest:

---
name: bosh

releases:
- name: bosh
  url: https://bosh.io/d/github.com/cloudfoundry/bosh?v=158
  sha1: a97811864b96bee096477961b5b4dadd449224b4
- name: bosh-azure-cpi
  url: file://../dev_releases/bosh-azure-cpi/bosh-azure-cpi-0+dev.21.tgz

networks:
- name: public
  type: vip
  cloud_properties:
    tcp_endpoints:
    - "22:22"
    - "53:53"
    - "4222:4222"
    - "6868:6868"
    - "25250:25250"
    - "25555:25555"
    - "25777:25777"
    udp_endpoints:
    - "68:68"
- name: private
  type: manual
  subnets:
  - range: 10.0.0.0/24
    gateway: 10.0.0.1
    dns: [8.8.8.8]
    cloud_properties:
      virtual_network_name: boshvnet-crp
      subnet_name: bosh

resource_pools:
- name: vms
  network: private
  stemcell:
    # bosh-azure-hyperv-ubuntu-trusty-go_agent
    url: file://~/Downloads/stemcell.tgz
  cloud_properties:
    instance_type: Standard_D1
    caching: ReadWrite
    storage_account_name: <your_storage_account_name>

disk_pools:
- name: disks
  disk_size: 24_576
  cloud_properties:
    caching: None

jobs:
- name: bosh
  templates:
  - {name: powerdns, release: bosh}
  - {name: nats, release: bosh}
  - {name: redis, release: bosh}
  - {name: postgres, release: bosh}
  - {name: blobstore, release: bosh}
  - {name: director, release: bosh}
  - {name: health_monitor, release: bosh}
  - {name: registry, release: bosh}
  - {name: cpi, release: bosh-azure-cpi}

  instances: 1
  resource_pool: vms
  persistent_disk_pool: disks

  networks:
  - {name: private, static_ips: [10.0.0.4]}
  - {name: public, static_ips: [__PUBLIC_IP__]}

  properties:
    nats:
      address: 127.0.0.1
      user: nats
      password: nats-password

    redis:
      listen_addresss: 127.0.0.1
      address: 127.0.0.1
      password: redis-password

    postgres: &db
      host: 127.0.0.1
      user: postgres
      password: postgres-password
      database: bosh
      adapter: postgres

    dns:
      address: 10.0.0.4
     db:
        user: postgres
        password: postgres-password
        host: 127.0.0.1
        listen_address: 127.0.0.1
        database: bosh
      user: powerdns
      password: powerdns
      database:
        name: powerdns
      webserver:
        password: powerdns
      replication:
        basic_auth: replication:zxKDUBeCfKYXk
        user: replication
        password: powerdns
      recursor: 10.0.0.4

    # Tells the Director/agents how to contact registry
    registry:
      address: 10.0.0.4
      host: 10.0.0.4
      db: *db
      http: {user: admin, password: admin, port: 25777}
      username: admin
      password: admin
      port: 25777

    # Tells the Director/agents how to contact blobstore
    blobstore:
      address: 10.0.0.4
      port: 25250
      provider: dav
      director: {user: director, password: director-password}
      agent: {user: agent, password: agent-password}

    director:
      address: 127.0.0.1
      name: bosh
      db: *db
      cpi_job: cpi

    hm:
      http: {user: hm, password: hm-password}
      director_account: {user: admin, password: admin}

    azure: &azure
      environment: AzureCloud
      subscription_id: <your_subscription_id>
      storage_account_name: <your_storage_account_name>
      resource_group_name: <your_resource_group_name>
      tenant_id: <your_tenant_id>
      client_id: <your_client_id>
      client_secret: <your_client_secret>
      ssh_user: vcap
      parallel_upload_thread_num: 16
      ssh_certificate: "-----BEGIN CERTIFICATE-----\n..."

    # Tells agents how to contact nats
    agent: {mbus: "nats://nats:[email protected]:4222"}

    ntp: &ntp [0.north-america.pool.ntp.org]

cloud_provider:
  template: {name: cpi, release: bosh-azure-cpi}

  # Tells bosh-init how to SSH into deployed VM
  ssh_tunnel:
    host: __PUBLIC_IP__
    port: 22
    user: vcap
    private_key: ~/.ssh/bosh

  # Tells bosh-init how to contact remote agent
  mbus: https://mbus-user:mbus-password@__PUBLIC_IP__:6868

  properties:
    azure: *azure

    # Tells CPI how agent should listen for bosh-init requests
    agent: {mbus: "https://mbus-user:[email protected]:6868"}

    blobstore: {provider: local, path: /var/vcap/micro_bosh/data/cache}

    ntp: *ntp