Skip to content

openstack_cpi job from bosh-openstack-cpi/54

Github source: de23ab4 or master branch

Properties

agent

mbus

Message bus endpoint for the agent to start accepting agent requests

Example
https://user:[email protected]:5000

env

http_proxy

Http proxy to connect to cloud API’s

https_proxy

Https proxy to connect to cloud API’s

no_proxy

No proxy environment variable

nats

address

NATS address used by agent to subscribe to agent requests

password

NATS password used by agent to subscribe to agent requests

port

NATS port used by agent to subscribe to agent requests

Default
4222

user

NATS username used by agent to subscribe to agent requests

ntp

List of NTP servers

Example
- 0.us.pool.ntp.org
- 1.us.pool.ntp.org

openstack

api_key

OpenStack API key (required)

auth_url

URL of the OpenStack Identity endpoint to connect to (required)

Example

Keystone V2 endpoint

http://192.168.0.1:5000/v2.0

Keystone V3 endpoint

http://192.168.0.1:5000/v3

boot_from_volume

Boot from volume

Default
false

config_drive

Config drive device (cdrom or disk) to use as metadata service on OpenStack (optional)

Example
cdrom

connection_options

Hash containing additional connection parameters (optional)

Example

Provide all required custom CA certificates

ca_cert: |+
  -----BEGIN CERTIFICATE-----
  MII...
  -----END CERTIFICATE-----

Disable SSL verification for DevStack

ssl_verify_peer: false

Any other excon connection option, e.g. setting the read timeout

read_timeout: 360

default_key_name

Default OpenStack keypair to use when spinning up new VMs (required)

Example
bosh

default_security_groups

Default OpenStack security groups to use when spinning up new VMs (required)

Example
- bosh-grp

default_volume_type

Default OpenStack volume type to use when creating new disks (optional)

Example
SSD

domain

OpenStack domain (required for Keystone API V3)

enable_auto_anti_affinity

No longer supported (see https://www.pivotaltracker.com/story/show/159522260)

endpoint_type

OpenStack endpoint type

Default
publicURL

human_readable_vm_names

When creating a VM, use the job name as VM name if true. Otherwise use a generated UUID as name. If this parameter is set to true, the registry.endpoint parameter has to be set.

Default
false

ignore_server_availability_zone

When creating a disk, do not use the availability zone of the server, fall back to Openstacks default

Default
false

project

OpenStack project name (required for Keystone API V3. Also can be used the project_id property )

project_domain_name

Defines the specific project domain to be used by the connection to the authentication service.

project_id

OpenStack project id (required for Keystone API V3. Also can be used the project property)

region

OpenStack region (optional)

Example
nova

state_timeout

Timeout (in seconds) for OpenStack resources desired state

Default
300

stemcell_public_visibility

Set public visibility for stemcells

Default
false

tenant

OpenStack tenant name (required for Keystone API V2)

use_dhcp

Whether to use DHCP when configuring networking on VM (for both manual and dynamic)

Default
true

use_nova_networking

Use Nova networking APIs instead of Neutron APIs. Note: Nova networking APIs are deprecated with the Newton release, hence this switch will likely not work in future releases.

Default
false

user_domain_name

Defines the specific user domain to be used by the connection to the authentication service.

username

OpenStack user name (required)

wait_resource_poll_interval

Changes the delay (in seconds) between each status check to OpenStack when creating a resource (optional, by default 5)

Default
5

registry

endpoint

Full URL for the registry endpoint that may include basic auth credentials

Example
http://admin:admin-password@some-ip:port

host

Address of the Registry to connect to (required)

password

Password to access the Registry

port

Port of the Registry for CPI and agent to connect to

Default
25777

username

Username to access the Registry

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/openstack_cpi/ directory (learn more).

  • bin/cpi (from cpi.erb)
  • config/cacert.pem (from cacert.pem.erb)
  • config/cpi.json (from cpi.json.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.