LATEST VERSION: 2.4 - RELEASE NOTES
Ops Manager v2.2

Configuring BOSH Director on OpenStack

This topic describes how to configure BOSH Director after deploying Pivotal Cloud Foundry (PCF) on OpenStack. Use this topic when Installing Pivotal Cloud Foundry on OpenStack.

Note: You can also perform the procedures in this topic using the Ops Manager API. For more information, see Using the Ops Manager API.

Step 1: Access Ops Manager

  1. In a web browser, navigate to the fully qualified domain you created in the Create a DNS Entry step of Provisioning the OpenStack Infrastructure.

  2. When Ops Manager starts for the first time, you must choose one of the following:

    Select authentication

Use an Identity Provider

  1. Log in to your IdP console and download the IdP metadata XML. Optionally, if your IdP supports metadata URL, you can copy the metadata URL instead of the XML.

  2. Copy the IdP metadata XML or URL to the Ops Manager Use an Identity Provider login page. Meta om

    Note: The same IdP metadata URL or XML is applied for the BOSH Director. If you use a separate IdP for BOSH, copy the metadata XML or URL from that IdP and enter it into the BOSH IdP Metadata text box in the Ops Manager login page.

  3. Enter values for the fields listed below. Failure to provide values in these fields results in a 500 error.

    Note: These attributes are case-sensitive.

    • SAML admin group: Enter the name of the SAML group that contains all Ops Manager administrators.
    • SAML groups attribute: Enter the groups attribute tag name with which you configured the SAML server.
  4. Enter your Decryption passphrase. Read the End User License Agreement, and select the checkbox to accept the terms.

  5. Your Ops Manager login page appears. Enter your username and password. Click Login.

  6. Download your SAML Service Provider metadata (SAML Relying Party metadata) by navigating to the following URLs:

    • 6a. Ops Manager SAML service provider metadata: https://OPS-MAN-FQDN:443/uaa/saml/metadata
    • 6b. BOSH Director SAML service provider metadata: https://BOSH-IP-ADDRESS:8443/saml/metadata

      Note: To retrieve your BOSH-IP-ADDRESS, navigate to the BOSH Director tile > Status tab. Record the BOSH Director IP address.

  7. Configure your IdP with your SAML Service Provider metadata. Import the Ops Manager SAML provider metadata from Step 6a above to your IdP. If your IdP does not support importing, provide the values below.

    • Single sign on URL: https://OPS-MAN-FQDN:443/uaa/saml/SSO/alias/OPS-MAN-FQDN
    • Audience URI (SP Entity ID): https://OP-MAN-FQDN:443/uaa
    • Name ID: Email Address
    • SAML authentication requests are always signed
  8. Import the BOSH Director SAML provider metadata from Step 6b to your IdP. If the IdP does not support an import, provide the values below.

    • Single sign on URL: https://BOSH-IP:8443/saml/SSO/alias/BOSH-IP
    • Audience URI (SP Entity ID): https://BOSH-IP:8443
    • Name ID: Email Address
    • SAML authentication requests are always signed
  9. Return to the BOSH Director tile, and continue with the configuration steps below.

Use Internal Authentication

  1. When redirected to the Internal Authentication page, do the following:

    • Enter a Username, Password, and Password confirmation to create an Admin user.
    • Enter a Decryption passphrase and the Decryption passphrase confirmation. This passphrase encrypts the Ops Manager datastore, and is not recoverable.
    • If you are using an HTTP proxy or HTTPS proxy, follow the instructions in Configuring Proxy Settings for the BOSH CPI.
    • Read the End User License Agreement, and select the checkbox to accept the terms.
    • Click Setup Authentication.

    Om login

  2. Log in to Ops Manager with the Admin username and password you created in the previous step.

    Cf login

Step 2: OpenStack Config Page

  1. In the left navigation of your OpenStack dashboard, click Project > Compute > Access & Security. Select the API Access tab.

  2. Record the Service Endpoint for the Identity service. You use this Service Endpoint as the Authentication URL for Ops Manager in a later step.

    Record endpoint

  3. In the PCF Ops Manager Installation Dashboard, click the BOSH Director tile.

    Director tile openstack

  4. Select OpenStack Config.

  5. Complete the OpenStack Management Console Config page with the following information:

    • Authentication URL: Enter the Service Endpoint for the Identity service that you recorded in a previous step.
    • Keystone Version: Choose a Keystone version, either v2 or v3.

      • If you choose v3, enter the OpenStack Keystone domain to authenticate against in the Domain field. For more information about Keystone domains in OpenStack, see Domains in the OpenStack documentation.

      Om config name

    • Username: Enter your OpenStack Horizon username. The PrimaryProject for the user must be the project you are using to deploy PCF. For more information, see Manage projects and users in the OpenStack documentation.

    • Password: Enter your OpenStack Horizon password.

    • Tenant: Enter your OpenStack tenant name.

    • Region: Enter RegionOne, or another region if recommended by your OpenStack administrator.

    • Select OpenStack omNetwork Type: Select either Nova, the legacy OpenStack networking model, or Neutron, the newer networking model.

    • Ignore Server Availability Zone: Do not select the checkbox.

    • Security Group Name: Enter opsmanager. You created this Security Group in the Configure Security step of Provisioning the OpenStack Infrastructure.

    • Key Pair Name: Enter the name of the key pair that you created in the Configure Security step of Provisioning the OpenStack Infrastructure.

    • SSH Private Key: In a text editor, open the key pair file that you downloaded in the Configure Security step of Provisioning the OpenStack Infrastructure. Copy and paste the contents of the key pair file into the field.

    • (Optional) API SSL Certificate: If you configured API SSL termination in your OpenStack Dashboard, enter your API SSL Certificate.

    • Disable DHCP: Do not select the checkbox unless your configuration requires it.

    • Select OpenStack Network Type: Select either Nova, the legacy networking model, or Neutron, the OpenStack networking model. Om openstack config

  6. Click Save.

Step 3: (Optional) Advanced Config Page

Note: This is an advanced option. Most users leave this field blank.

  1. In Ops Manager, select Advanced Infrastructure Config. Om advanced infra

  2. If your OpenStack environment requires specific connection options, enter them in the Connection Options field in JSON format. For example: 'connection_options' => { 'read_timeout' => 200 }

  3. Click Save.

Step 4: Director Config Page

  1. In Ops Manager, select Director Config.

    Director config

  2. Enter one or more NTP servers in the NTP Servers (comma delimited) field. For example, us.pool.ntp.org.

    Note: The NTP server configuration only updates after VM recreation. Ensure that you select the Recreate all VMs checkbox if you modify the value of this field.

  3. Leave the JMX Provider IP Address field blank.

    Note: Starting in PCF v2.0, BOSH-reported component metrics are available in the Loggregator Firehose by default. If you continue to use PCF JMX Bridge to consume these component metrics outside of the Firehose, you may receive duplicate data. To prevent this, leave the JMX Provider IP Address field blank. For additional guidance, see BOSH System Metrics Available in Loggregator Firehose in the PCF v2.0 Release Notes.

  4. Leave the Bosh HM Forwarder IP Address field blank.

    Note: Starting in PCF v2.0, BOSH-reported component metrics are available in the Loggregator Firehose by default. If you continue to use the BOSH HM Forwarder to consume these component metrics, you may receive duplicate data. To prevent this, leave the Bosh HM Forwarder IP Address field blank. For additional guidance, see BOSH System Metrics Available in Loggregator Firehose in the PCF v2.0 Release Notes.

  5. Select the Enable VM Resurrector Plugin checkbox to enable the Ops Manager Resurrector functionality and increase PAS availability.

  6. Select Enable Post Deploy Scripts to run a post-deploy script after deployment. This script allows the job to execute additional commands against a deployment.

  7. Select Recreate all VMs to force BOSH to recreate all VMs on the next deploy. This process does not destroy any persistent disk data.

  8. Select Enable bosh deploy retries to instruct Ops Manager to retry failed BOSH operations up to five times.

  9. (Optional) Disable Allow Legacy Agents if all of your tiles have stemcells v3468 or later. Disabling the field will allow Ops Manager to implement TLS secure communications.

  10. Select Keep Unreachable Director VMs if you want to preserve BOSH Director VMs after a failed deployment for troubleshooting purposes.

  11. Select HM Pager Duty Plugin to enable Health Monitor integration with PagerDuty. Director hm pager

    • Service Key: Enter your API service key from PagerDuty.
    • HTTP Proxy: Enter an HTTP proxy for use with PagerDuty.
  12. Select HM Email Plugin to enable Health Monitor integration with email. Director hm email

    • Host: Enter your email hostname.
    • Port: Enter your email port number.
    • Domain: Enter your domain.
    • From: Enter the address for the sender.
    • Recipients: Enter comma-separated addresses of intended recipients.
    • Username: Enter the username for your email server.
    • Password: Enter the password for your email server.
    • Enable TLS: Select this checkbox to enable Transport Layer Security.
  13. For CredHub Encryption Provider, you can choose whether BOSH CredHub stores its encryption key internally on the BOSH Director and CredHub VM, or in an external hardware security module (HSM). The HSM option is more secure.

    Before configuring an HSM encryption provider in the Director Config pane, you must follow the procedures and collect information described in Preparing CredHub HSMs for Configuration.

    Note: After you deploy Ops Manager with an HSM encryption provider, you cannot change BOSH CredHub to store encryption keys internally.

    CredHub Encryption Provider options in the Director Config pane

    • Internal: Select this option for internal CredHub key storage. This option is selected by default and requires no additional configuration.
    • Luna HSM: Select this option to use a SafeNet Luna HSM as your permanent CredHub encryption provider, and fill in the following fields:
      1. Encryption Key Name: Any name to identify the key that the HSM uses to encrypt and decrypt the CredHub data. Changing this key name after you deploy Ops Manager can cause service downtime.
      2. Provider Partition: The partition that stores your encryption key. Changing this partition after you deploy Ops Manager could cause service downtime. For this value and the ones below, use values gathered in Preparing CredHub HSMs for Configuration.
      3. Provider Partition Password
      4. Provider Client Certificate: The certificate that validates the identity of the HSM when CredHub connects as a client.
      5. Provider Client Certificate Private Key
      6. HSM Host Address
      7. HSM Port Address: If you do not know your port address, enter 1792.
      8. Partition Serial Number
      9. HSM Certificate: The certificate that the HSM presents to CredHub to establish a two-way mTLS connection.

  14. Select a Blobstore Location to either configure the blobstore as an internal server or an external endpoint. Because the internal server is unscalable and less secure, Pivotal recommends that you configure an external blobstore.

    Note: After you deploy Ops Manager, you cannot change the blobstore location.

    Blobstore location options in the Director Config pane

    • Internal: Select this option to use an internal blobstore. Ops Manager creates a new VM for blob storage. No additional configuration is required.
    • S3 Compatible Blobstore: Select this option to use an external S3-compatible endpoint. Follow the procedures in Sign up for Amazon S3 and Creating a Bucket in the AWS documentation. When you have created an S3 bucket, complete the following steps:
      1. S3 Endpoint: Navigate to the Regions and Endpoints topic in the AWS documentation.
        1. Locate the endpoint for your region in the Amazon Simple Storage Service (S3) table and construct a URL using your region’s endpoint. For example, if you are using the us-west-2 region, the URL you create would be https://s3-us-west-2.amazonaws.com. Enter this URL into the S3 Endpoint field.
        2. On a command line, run ssh ubuntu@OPS-MANAGER-FQDN to SSH into the Ops Manager VM. Replace OPS-MANAGER-FQDN with the fully qualified domain name of Ops Manager.
        3. Copy the custom public CA certificate you used to sign the S3 endpoint into /etc/ssl/certs on the Ops Manager VM.
        4. On the Ops Manager VM, run sudo update-ca-certificates -f -v to import the custom CA certificate into the Ops Manager VM truststore.

          Note: You must also add this custom CA certificate into the Trusted Certificates field in the Security page. See Security Page for instructions.

      2. Bucket Name: Enter the name of the S3 bucket.
      3. Access Key and Secret Key: Enter the keys you generated when creating your S3 bucket.
      4. Select V2 Signature or V4 Signature. If you select V4 Signature, enter your Region.

        Note: AWS recommends using Signature Version 4. For more information about AWS S3 Signatures, see Authenticating Requests in the AWS documentation.

    • Enable TLS: Select this checkbox to enable TLS.

      Note: If you are using Linux stemcells, make sure you have configured Linux stemcell v3586.16 or later for all tiles before enabling TLS.

      Note: If you are using PAS for Windows 2016, make sure you have configured Windows stemcell v1709.10 or later for all tiles before enabling TLS.

    • GCS Blobstore: Select this option to use an external GCS endpoint. To create a GCS bucket, you must have a GCS account. Follow the procedures in Creating Storage Buckets in the GCS documentation to create a GCS bucket. When you have created a GCS bucket, complete the following steps:
      1. Bucket Name: Enter the name of your GCS bucket.
      2. Storage Class: Select the storage class for your GCS bucket. See Storage Classes in the GCP documentation for more information.
      3. Service Account Key: Follow the steps in the Set up an IAM Service Account section of Preparing to Deploy Ops Manager on GCP Manually to download a JSON file with a private key. Enter the contents of the JSON file into the field.

  15. Select a Database Location. By default, Ops Manager deploys and manages a database for you. If you choose to use an External MySQL Database, complete the associated fields with information obtained from your external MySQL Database provider. Director database In addition, if you selected the Enable TLS for Director Database checkbox, you can complete the following optional fields:

    • Enable TLS: Select this checkbox to enables TLS communication between the BOSH Director and the database.
    • TLS CA: Enter the Certificate Authority for the TLS Certificate.
    • TLS Certificate: Enter the client certificate for mutual TLS connections to the database.
    • TLS Private Key: Enter the client private key for mutual TLS connections to the database.
    • Advanced DB Connection Options: If you would like to provide additional options for the database, use this field to provide a JSON-formatted options string.
  16. (Optional) Director Workers: Set the number of workers available to execute Director tasks. This field defaults to 5.

  17. (Optional) Max Threads: Enter the number of operations the BOSH Director can perform simultaneously.

  18. (Optional) Director Hostname: Enter a valid hostname to add a custom URL for your BOSH Director. You can also use this field to configure a load balancer in front of your BOSH Director. For more information, see How to Set Up a Load Balancer in Front of Operations Manager Director in the Pivotal Support documentation.

    WARNING: In Ops Manager v2.2.7 and earlier, if you change the Director Hostname after your initial deployment, VMs become unavailable. This causes PCF downtime. To restore VM availability, enable Recreate All VMs and redeploy. This issue is resolved in Ops Manager v2.2.8 and later.

  19. (Optional) Enter your list of comma-separated Excluded Recursors to declare which IP addresses and ports should not be used by the DNS server.

  20. (Optional) To disable BOSH DNS, select the Disable BOSH DNS server for troubleshooting purposes checkbox. For more information about the BOSH DNS service discovery mechanism, see BOSH DNS Enabled by Default in the Ops Manager v2.2 Release Notes.

    Breaking Change: Do not disable BOSH DNS without consulting Pivotal Support.

  21. (Optional) Custom SSH Banner: Enter text to set a custom banner that users see when logging in to the Director using SSH. Disable bosh dns

  22. (Optional) Enter your comma-separated custom Identification Tags. For example, iaas:foundation1, hello:world. You can use the tags to identify your foundation when viewing VMs or disks from your IaaS.

  23. Click Save.

Note: If you select to use an internal database, back up your data frequently. For more information, see Backing Up and Restoring Pivotal Cloud Foundry.

Step 5: Create Availability Zones Page

  1. In Ops Manager, select Create Availability Zones.

    Create az

  2. Enter the name of the availability zone that you selected in the Launch Ops Manager VM step of Provisioning the OpenStack Infrastructure.

  3. Click Save.

Step 6: Create Networks Page

  1. In the left navigation of your OpenStack dashboard, click Project > Network > Networks.

  2. Click the name of the network that contains the private subnet where you deployed the Ops Manager VM. The OpenStack Network Detail page displays your network settings.

    View network info

  3. In Ops Manager, select Create Networks.

    Om create networks config

  4. Select Enable ICMP checks to enable ICMP on your networks. Ops Manager uses ICMP checks to confirm that components within your network are reachable. Review the Configure Security step of Deploying BOSH and Ops Manager to OpenStack to ensure you have configured ICMP in your Security Group.

  5. Use the following steps to create one or more Ops Manager networks using information from your OpenStack network:

    • Click Add Network.
    • Enter a unique Name for the network.
    • Click Add Subnet to create one or more subnets for the network.
    • For Network ID, use the ID from the OpenStack page.
    • For CIDR, use the Network Address from the OpenStack page.
    • For Reserved IP Ranges, use the first 10 IP addresses of the Network Address range, and the private IP address of the Ops Manager instance that you recorded in the Associate a Floating IP Address step of Provisioning the OpenStack Infrastructure.
    • For DNS, enter one or more Domain Name Servers.
    • For Gateway, use the Gateway IP from the OpenStack page.
    • For Availability Zones, select which Availability Zones to use with the network.
  6. Click Save.

    Note: After you deploy Ops Manager, you add subnets with overlapping Availability Zones to expand your network. For more information about configuring additional subnets, see Expanding Your Network with Additional Subnets.

Step 7: Assign AZs and Networks Page

  1. Select Assign Availability Zones.

    Assign az

  2. From the Singleton Availability Zone dropdown, select the availability zone that you created in a previous step. The BOSH Director installs in this Availability Zone.

  3. Use the dropdown to select the Network that you created in a previous step. BOSH Director installs in this network.

  4. Click Save.

Step 8: Security Page

  1. Select Security. Om security

  2. In Trusted Certificates, enter your custom certificate authority (CA) certificates to insert into your organization’s certificate trust chain. This feature enables all BOSH-deployed components in your deployment to trust custom root certificates.

    To enter multiple certificates, paste your certificates one after the other. For example, format your certificates like the following:

    -----BEGIN CERTIFICATE-----
    ABCDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678AB
    EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF
    GH12345678ABCDEFGH12345678ABCDEFGH12345678...
    ------END CERTIFICATE------
    -----BEGIN CERTIFICATE-----
    BCDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABB
    EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF
    GH12345678ABCDEFGH12345678ABCDEFGH12345678...
    ------END CERTIFICATE------
    -----BEGIN CERTIFICATE-----
    CDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABBB
    EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF
    GH12345678ABCDEFGH12345678ABCDEFGH12345678...
    ------END CERTIFICATE------

    Note: If you want to use Docker Registries for running app instances in Docker containers, enter the certificate for your private Docker Registry in this field. See Using Docker Registries for more information on running app instances in PAS using Docker Registries.

  3. Choose Generate passwords or Use default BOSH password. Pivotal recommends that you use the Generate passwords option for greater security.

  4. Click Save. To view your saved Director password, click the Credentials tab.

Step 9: Syslog Page

  1. Select Syslog. Syslog bosh

  2. (Optional) Select Yes to send BOSH Director system logs to a remote server.

  3. In the Address field, enter the IP address or DNS name for the remote server.

  4. In the Port field, enter the port number that the remote server listens on.

  5. In the Transport Protocol dropdown menu, select TCP, UDP, or RELP. This selection determines which transport protocol is used to send the logs to the remote server.

  6. (Optional) Pivotal strongly recommends that you enable TLS encryption when forwarding logs as they may contain sensitive information. For example, these logs may contain cloud provider credentials. To enable TLS, perform the following steps.

    • In the Permitted Peer field, enter either the name or SHA1 fingerprint of the remote peer.
    • In the SSL Certificate field, enter the SSL certificate for the remote server.
  7. Click Save.

Step 10: Resource Config Page

  1. Select Resource Config. Om resource config

  2. Adjust any values as necessary for your deployment, such as increasing the persistent disk size. Select Automatic from the dropdown to provision the amount of persistent disk predefined by the job. If the persistent disk field reads None, the job does not require persistent disk space.

    Note: Ops Manager requires a Director VM with at least 8 GB memory.

    Note: If you set a field to Automatic and the recommended resource allocation changes in a future version, Ops Manager automatically uses the updated recommended allocation.

  3. Click Save.

Step 11: (Optional) Add Custom VM Extensions

Use the Ops Manager API to add custom properties to your VMs such as associated security groups and load balancers. For more information, see Managing Custom VM Extensions.

Step 12: Complete BOSH Director Installation

  1. Click the Installation Dashboard link to return to the Installation Dashboard.

  2. Click Apply Changes. If the following ICMP error message appears, click Ignore errors and start the install.

    Icmp error

  3. BOSH Director installs. The image shows the Changes Applied message that Ops Manager displays when the installation process successfully completes.

    Om installed

  4. After you complete this procedure, follow the instructions in Deploying PAS on OpenStack.


Return to Installing Pivotal Cloud Foundry on OpenStack.

Create a pull request or raise an issue on the source for this page in GitHub