Skip to content

vsphere_cpi job from bosh-vsphere-cpi/97.0.11

Github source: b4e79eb1 or master branch

Properties

agent

mbus

Agent mbus

nats

address

Address of the nats server

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

Address of the nats server

password

Password to connect to nats with

port

Port that the nats server listens on

Default
4222

user

Username to connect to nats with

Default
nats

ntp

List of ntp server IPs. pool.ntp.org attempts to return IPs closest to your location, but you can still specify if needed.

Default
  - 0.pool.ntp.org
  - 1.pool.ntp.org

vcenter

address

Address of vCenter server used by vsphere cpi if not set by vcenter.host

connection_options

ca_cert

All required custom CA certificates

Example
'-----BEGIN CERTIFICATE----- MII... -----END CERTIFICATE-----'

datacenters

Datacenters in vCenter to use (value is an array of Hashes representing datacenters and clusters, See director.yml.erb.erb)

default_disk_type

backing for ephemeral and persistent disks unless overridden by disk_pools.cloud_properties.type; can be thin or preallocated

Default
preallocated

enable_auto_anti_affinity_drs_rules

Creates DRS rule to place VMs on separate hosts.

Default
false

enable_human_readable_name

Enables human readable names for BOSH VMs.

Default
false

ensure_no_ip_conflicts

When creating a VM, ensure that no other VMs exist in the same port group with the same IP address. The creation will fail if there is a conflict. Conflict detection is done by querying the vCenter, so VMs with a conflicting IP address without VMware tools running will not be detected.

Default
true

host

Address of vCenter server used by vsphere cpi

http_logging

Enables HTTP level logging. Each HTTP request to vcenter will be logged

Default
false

memory_reservation_locked_to_max

When enabled, the requested memory for the VMs will be reserved in vCenter. Enabling this will likely lead to wasted memory on the hosts and will prevent vCenter from making the best use of the memory resources.

Default
false

nsx

address

Address of the NSX manager

ca_cert

All required custom CA certificates

Example
'-----BEGIN CERTIFICATE----- MII... -----END CERTIFICATE-----'
password

Password to connect to NSX manager

user

User to connect to NSX manager

nsxt

allow_overwrite

When enabled, the CPI sets the X-Allow-Overwrite header to ‘true’ when making NSX-T API requests. This value currently defaults to true for backwards compatibility.

Default
true
auth_certificate

Certificate used for certificate-based authentication. Certificate-based authentication takes precedence over username/password if both specified

auth_private_key

Private key file used for certificate-based authentication.

ca_cert

All required custom CA certificates to connect to NSX-T manager

Example
'-----BEGIN CERTIFICATE----- MII... -----END CERTIFICATE-----'
default_vif_type

Default vif_type for logical port attachment. Supported types: PARENT.

host

Host of the NSX-T manager

password

Password to connect to NSX-T manager

policy_api_migration_mode

When enabled, the CPI attempts to associate VMs in both the Policy API and the Manager API. The VM is associated with groups and server pools in the Policy API, and with NSGroups and server pools in the Manager API. It will return an error if the Manager API objects do not exist, but not if the Policy API objects do not exist. This option is only intended to be used in conjunction with scripts to help migrate NSX-T entities from the Manager API to the Policy API.

Default
false
remote_auth

Set to true if NSX-T manager is using VMware Identity Manager

Default
false
use_policy_api

Use NSX-T Policy API rather than Management Plane API

Default
false
username

Username to connect to NSX-T manager

password

Password to connect to vCenter server used by vspher cpi

upgrade_hw_version

Upgrades virtual machines to latest virtual hardware version supported on the ESXi host.

Default
false

user

User to connect to vCenter server used by vsphere cpi

vm_storage_policy_name

Name of the storage Policy which is applied to a VM and its ephemeral disk.

vmx_options

disk
enableUUID

Enable usage of Disk UUIDs for partition lookups of the bosh agent. This is required for Kubernetes Clusters deployed by Bosh to use the Kubernetes CPI (e.g. to provision Pod Volumes). Adds labels to scsi disk devices so the disk device path (/dev/sd*) can be discovered via Linux OS. See https://help.ubuntu.com/community/UsingUUID.

Example
1

Templates

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

  • bin/cpi (from cpi.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.