Configuring the BOSH Director with the Ops Manager API

Overview

This topic describes how to configure the BOSH Director for their IaaS using the Ops Manager API. This method is intended for advanced PCF operators and administrators.

Pivotal recommends that beginning users configure the BOSH Director through the Ops Manager UI, which provides context and explanations for each option. For information about configuring the BOSH Director tile in the Ops Manager UI, see one of the following:

Prerequisites

Before you configure the BOSH Director with the Ops Manager API, you must have the following components downloaded or accessible on your local host:

  • A current version of Ops Manager downloaded from Pivotal Network.
  • Access to the Ops Manager API. For more information about the Ops Manager API, see Using the Ops Manager API.
  • An external SAML or LDAP client.
  • An IaaS provider configured for use with Ops Manager. For more information about configuring an IaaS, see Planning Your PCF Deployment.

Setting Up the BOSH Director

To configure the BOSH Director with the Ops Manager API, do the following:

  1. Access the Ops Manager API by following the procedure in Using the Ops Manager API.
  2. Enter the following HTTP request to perform intial setup: POST /api/v0/setup.
    Include metadata in your request to specify configuration details for your deployment. For example, specify the deployment’s decryption passphrase, EULA status, and proxy information, if applicable.

    For more information about configuring this request, see Setting up with an internal usersotre.

    Note: You do not need to specify UAA or other authentication details on a first-time deploy. Making the setup request automatically creates a UAA client when it completes successfully. If you specify a UAA client for a first-time deployment, the deployment will fail.

  3. A 200 OK response appears.

    After the successful response, a UAA client with the metadata you specified is created and launched. Ops Manager users can authenticate with UAAC, and if they have a pre-created client they can target UAAC with the client name and password.

    For more information on pre-created clients, see Creating and Managing Ops Manager User and Client Accounts.
  4. Enter the following HTTP request to perform configure your IaaS and BOSH Director: PUT api/v0/staged/director/properties.

    There are many configuration parameters available to customize your BOSH Director. All the commands are IaaS-agnostic except the IaaS configuration key. Missing required fields should cause an error.

    For more information about configuring the BOSH Director, see Fetching Director, IaaS, and Security Properties.
  5. Enter the following HTTP request to create Availability Zones (AZs) for your product: POST api/v0/staged/director/availability_zones.

    For more information about creating AZs, see Creating availability zones.

    Note: The create-azs endpoint is optional for Azure-based deployments, because you cannot manually configure Azure AZs.

  6. Enter the following HTTP request to create networking rules for the deployment: PUT api/v0/staged/director/networks.

    Specify whether or not to use ICMP checks by setting the icmp_checks_enabled parameter to true or false.

    For more information about networking rules, see Updating networks (Experimental).
  7. Enter the following HTTP request to assign a singleton AZ and a network where your BOSH Director will be located: PUT api/v0/staged/director/network_and_az.

    For more information about configuring AZs and networks, see Updating network and availability zone assignments.
  8. You must update the BOSH Director’s resource configuration settings before deploying Ops Manager. Resource configuration is highly variable depending on the requirements of your deployment.

    For more information about updating the resource configuration, see Configuring resources for a job (Experimental).

    To update the resource configuration, do the following:
    1. Use the following HTTP request to find your Director’s GUID: GET api/v0/staged/products.
    2. Use the following HTTP request to list all jobs on the Director: GET api/v0/staged/products/:BOSH-DIRECTOR-GUID/jobs.
    3. Use the following HTTP request to update the resource config of each job on the BOSH Director: PUT api/v0/staged/products/:BOSH-DIRECTOR-GUID/jobs/:JOB-GUID/resource_config.

  9. BOSH Director configuration is now complete. You can deploy Ops Manager now, or continue with further configuration.

    Use the following HTTP request to “Apply Changes” and deploy the BOSH Director: POST /api/v0/installations.

Next Steps

After you have configured the BOSH Director, you can continue configuring Ops Manager with other API endpoints.