Installing Pivotal Cloud Foundry on Azure

Page last updated:

This guide describes how to install Pivotal Cloud Foundry (PCF) on Azure.

To view production-level deployment options for PCF on Azure, see the Reference Architecture for Pivotal Cloud Foundry on Azure.

General Requirements

The following are general requirements for deploying and managing a PCF deployment with Ops Manager and Pivotal Application Service (PAS):

  • A wildcard DNS record that points to your router or load balancer. Alternatively, you can use a service such as For example,

    • PAS gives each application its own hostname in your app domain.
    • With a wildcard DNS record, every hostname in your domain resolves to the IP address of your router or load balancer, and you do not need to configure an A record for each app hostname. For example, if you create a DNS record * pointing to your load balancer or router, every application deployed to the domain resolves to the IP address of your router.
  • At least one wildcard TLS certificate that matches the DNS record you set up above, *

  • Sufficient IP allocation:

    • One static IP address for either HAProxy or one of your Gorouters
    • One static IP address for each job in the Ops Manager tile. See the Resource Config pane for each tile for a full list.
    • One static IP address for each job listed below:
      • Consul
      • NATS
      • File Storage
      • MySQL Proxy
      • MySQL Server
      • Backup Restore Node
      • HAProxy
      • Router
      • MySQL Monitor
      • Diego Brain
      • TCP Router
    • One IP for each VM instance created by the service.
    • An additional IP address for each compilation worker. So the formula for total IPs needed is IPs needed = static IPs + VM instances + compilation workers.

      Note: Pivotal recommends that you allocate at least 36 dynamic IP addresses when deploying Ops Manager and PAS. BOSH requires additional dynamic IP addresses during installation to compile and deploy VMs, install PAS, and connect to services.

  • One or more NTP servers if not already provided by your IaaS.

  • (Recommended) A network without DHCP available for deploying the PAS VMs.

    Note: If you have DHCP, refer to the Troubleshooting Guide to avoid issues with your installation.

  • (Optional) External storage. When you deploy PCF, you can select internal file storage or external file storage, either network-accessible or IaaS-provided, as an option in the PAS tile. Pivotal recommends using external storage whenever possible. See Configure File Storage for a discussion of how file storage location affects platform performance and stability during upgrades.

  • (Optional) External databases. When you deploy PCF, you can select internal or external databases for the BOSH Director and for PAS. Pivotal recommends using external databases in production deployments. An external database must be configured to use the UTC timezone.

  • (Optional) External user stores. When you deploy PCF, you can select a SAML user store for Ops Manager or a SAML or LDAP user store for PAS, to integrate existing user accounts.

  • The most recent version of the Cloud Foundry Command Line Interface (cf CLI).


Azure Requirements

The following are the minimum resource requirements for deploying a PCF deployment with Ops Manager and Pivotal Application Service (PAS) on Azure:

  • VMs:

    • PAS: At a minimum, a new Azure deployment requires the following VMs for PAS:
      PAS and Ops Manager VM Type VM Count
      F1s 27
      F2s 4
      F4s 4
      DS11 v2 1
      DS12 v2 1
      By default, PAS deploys the number of VM instances required to run a highly available configuration of PCF. If you are deploying a test or sandbox PCF that does not require HA, then you can scale down the number of instances in your deployment. For information about the number of instances required to run a minimal, non-HA PCF deployment, see Scaling PAS.
    • Small Footprint PAS: To run Small Footprint PAS, an Azure deployment requires:
      Azure Requirements VM Type VM Count Notes
      Small Footprint PAS DS11 v2 1
      DS12 v2 2
      F2s 0 Add 1 to count if using HAProxy
      F1s 5
      Ops Manager DS2 v2 1
      F4s 4

      Note: Specific instance types are only supported in certain regions. See the Azure documentation for a complete list. If you are deploying PCF in a region that does not support the above instance types, see the Ops Manager API documentation for instructions on how to override the default VM sizes. Changing the default VM sizes may increase the cost of your deployment.

  • An OS disk of 120 GB for the Ops Manager VM.

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

  • To deploy PCF on Azure, you must have the Azure CLI v2.0. For instructions on how to install the Azure CLI for your operating system, see Preparing to Deploy Ops Manager on Azure Manually.

Azure Permissions Guidelines

Pivotal recommends following the principle of least privilege by scoping privileges to the most restrictive permissions possible for a given role. See IaaS Permissions Guidelines for recommendations on how to create and scope Azure accounts for PCF.

Azure Security Documents

  • Azure security documentation
    This site has documentation on Azure security tools. It provides a general guide to how to manage IaaS users and credentials.

Install PCF on Azure

Complete the following procedures to install PCF on Azure:

  1. Preparing to Deploy Ops Manager on Azure Manually

  2. You can choose to deploy BOSH Director with Terraform or manually:

  3. Configuring BOSH Director on Azure Manually

  4. Deploying PAS on Azure

Install PCF on Azure Government Cloud

To deploy PCF on Azure Government Cloud, see Configuring BOSH Director on Azure Government Cloud.

Install PCF in Azure Germany

To deploy PCF in Azure Germany, see Configuring BOSH Director on Azure Germany.

Troubleshoot PCF on Azure

To troubleshoot known issues when deploying PCF on Azure, see Troubleshooting PCF on Azure.

Delete PCF on Azure

You can use the Azure Portal console to remove all the components of a PCF on Azure installation.

Upgrade PCF on Azure

Upgrade your BOSH Director as part of the upgrade process documented in the Upgrading Pivotal Cloud Foundry topic.

To upgrade PCF on Azure, see Upgrading BOSH Director on Azure.

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