Deploying BOSH and Ops Manager
Page last updated:
This topic explains how to deploy BOSH and Ops Manager, the foundation of a Pivotal Platform platform.
BOSH is an open-source tool that lets you run software systems in the cloud.
- BOSH and its IaaS-specific Cloud Provider Interfaces (CPIs) are what let Pivotal Platform run on multiple IaaSes.
- See Deploying Software with BOSH for a mini overview of how you use BOSH to run software in the cloud.
Ops Manager is a GUI application that streamlines deploying subsequent software to the cloud via BOSH. Ops Manager features are also accessible by API endpoints. For more information, see Using the Ops Manager API.
- For routine tasks, you can use the Ops Manager interface instead of the BOSH command-line interface (CLI), Ops Manager API, or BOSH API.
- Ops Manager represents Pivotal Platform products as tiles with multiple configuration panes that let you input or select configuration values needed for the product.
- Ops Manager generates BOSH manifests containing the user-supplied configuration values, and sends them to the Director.
- After you install Ops Manager and BOSH, you use Ops Manager to deploy almost all Pivotal Platform products.
Deploying Ops Manager deploys both BOSH and Ops Manager with a single procedure.
- You deploy BOSH and Ops Manager by logging into your IaaS and allocating the network addresses, VMs, user accounts, and other resources needed to support Pivotal Platform.
- On AWS, you can deploy Ops Manager manually, or automatically with a Terraform template.
- On Azure, you can deploy Ops Manager manually, or automatically with a Terraform template, except on Azure Government Cloud and Azure Germany. On those two versions of Azure, you can only deploy Ops Manager manually.
For all of the above, the specifics depend on the IaaS on which you are deploying Pivotal Platform. The contents of this documentation are organized by IaaS.
For information on deploying Pivotal Platform to your IaaS, choose one of the following:
Deploying to AWS
Deploying to Azure
Deploying to GCP
Deploying to OpenStack
Deploying to vSphere
The following describes how you can use BOSH to run software in the cloud:
You create one or more BOSH releases, a directory that contains your software and anything that it depends on or needs to run on generic, empty VMs. For more information about using multiple BOSH releases, see Including Multiple BOSH Releases in A Deployment.
You create a manifest
.ymlfile that identifies the component processes in the BOSH release, specifies the VMs they run on, how they communicate, how to start them up and shut them down, and any other configuration specifics that they need.
Using the BOSH command-line interface (CLI) or API, you upload the BOSH release and send the manifest to the Director, BOSH’s executive process.
The Director provisions what it needs from the IaaS, deploys your software to run in the cloud, and heals automatically when VMs go down.
BOSH CLI and API commands let you control BOSH-managed processes and allocate or release IaaS resources.
You can include additional features in the BOSH Director through targeted customization of the manifest.yml. The only software you can include in the BOSH Director is additional BOSH releases. All additional releases must be available at an HTTP address that Ops Manager can reach. You cannot host or store additional BOSH releases on Ops Manager or the BOSH Director.
To include custom BOSH releases in the BOSH Director, create as many BOSH releases as you need and use the Ops Manager API to the location and necessary configuration properties each release.
For more information, see Adding a job to the Director in the Ops Manager API documentation.
WARNING: Customizing the Director manifest incorrectly can cause deployment downtime or failure. Ops Manager does not perform any validations on software introduced to a deployment through manifest customizations. This feature is for advanced Pivotal Platform operators only.
For more information about writing the
manifest.yml file, see the BOSH documentation.