

Cloud Provider Interface (Version 3)

For an overview of the sequence of the CPI calls, please have a look at the following resources:

• BOSH components and its example component interaction diagram
• CLI v2 architecture doc and bosh create-env flow where calls to the CPI are marked as cloud.

Examples of API request and response:

• Building a CPI: RPC - Request
• Building a CPI: RPC - Response

If you're looking to get started on building a CPI, this short guide may be helpful. To learn more about the technical implementation, continue reading or refer to the RPC Interface for more details.

Libraries:

• Ruby: bosh-cpi-ruby gem v2.5.0
• GoLang: bosh-cpi-go library

---

Changes (comparing to V2)

• If the "api_version of a cpi release equals or is greater than 3 the bosh director sends an additional parameter with the listed methods.
• The corresponding CPI method must expect an additional parameter of type hash.

Methods

This list of methods to expect an additional parameter:

• Stemcell Management
  • create_stemcell