Architecture and Installation Overview

Page last updated:

This guide describes how to design a Pivotal Platform deployment and install it on an IaaS.

For Pivotal Platform Architects and Operators

If you are designing and installing a Pivotal Platform deployment, you have one or both of the following roles:

  • Architects design a Pivotal Platform deployment. They know the IaaS to which they intend to deploy it and what other relevant resources they have. In their design, they consider needs for the platform’s capacity, availability, security, geography, budget, and other factors. If they do not install Pivotal Platform themselves, they provide the architectural specifications to whoever does.

  • Operators run a Pivotal Platform platform, keep it up-to-date, monitor its health and performance, and fix any problems. They may also install the platform, or perform “Day 2” configurations that expand its functionality and integrate it with external systems.

This guide helps people in both roles create a Pivotal Platform deployment that does what they want. The contents of this guide follow the phases of a typical Pivotal Platform planning and installation effort.

Planning and Installation Overview

Pivotal Platform is a suite of products that runs on multiple IaaSes. Planning and installing Pivotal Platform means building layers from the bottom up, starting with the details of your IaaS and ending with “Day 2” configurations that you perform on a installed and running Pivotal Platform deployment.

The typical Pivotal Platform planning and installation process is:

  1. Plan

    • Review the requirements for your IaaS:
    • See the Reference Architecture for your IaaS.
    • Assess your platform needs, including capacity, availability, container support, host OS, resource isolation, and geographical distribution. Discuss with your Pivotal contact.
  2. Deploy BOSH and Ops Manager

    • 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 enable Pivotal Platform to run on multiple IaaSes.
      • See Deploying with BOSH for a description of how BOSH deploys cloud software.
    • Ops Manager is a graphical dashboard that deploys with BOSH. Ops Manager works with the BOSH Director to manage, configure, and upgrade Pivotal Platform products such as Pivotal Application Service (PAS), Enterprise Pivotal Container Service (PKS), and Pivotal Platform services and partner products.
      • 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 BOSH 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.
      • 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. On Azure Government Cloud and Azure Germany, you can only deploy Ops Manager manually.
  3. Deploy BOSH Add-ons (Optional)

    • BOSH add-ons include the IPsec, ClamAV, and File Integrity Monitoring, which enhance Pivotal Platform platform security and security logging.
    • You deploy these add-ons via BOSH rather than installing them with Ops Manager tiles.
  4. Install Runtimes

    • Pivotal Application Service (PAS) lets developers develop and manage cloud-native apps and software services.
      • PAS is based on the Cloud Foundry Foundation’s open-source Application Runtime (formerly Elastic Runtime) project.
    • Enterprise Pivotal Container Service (PKS) uses BOSH to run and manage Kubernetes container clusters.
      • PKS is based on the Cloud Foundry Foundation’s open-source Container Runtime (formerly Kubo) project.
    • Pivotal Isolation Segment lets a single PAS deployment run apps from separate, isolated pools of computing, routing, and logging resources.
      • Operators replicate and configure a Pivotal Isolation Segment tile for each new resource pool they want to create.
      • You must install PAS before you can install Pivotal Isolation Segment.
    • Pivotal Application Service for Windows (PASW) enables PAS to manage Windows Server 2016 (1709) stemcells hosting .NET apps, and can also be replicated to create multiple isolated resource pools.
      • Operators replicate and configure a PASW tile for each new resource pool they want to create.
      • You must install PAS before you can install PASW.
    • Small Footprint PAS is an alternative to PAS that uses far fewer VMs than PAS but has limitations.
  5. Day 2 Configurations

    • Day 2 configurations set up internal operations and external integrations on a running Pivotal Platform platform.
      • Examples include front end configuration, user accounts, logging and monitoring, internal security, and container and stemcell images.
  6. Install Services

    • Install software services for Pivotal Platform developers to use in their apps.
      • Services include the databases, caches, and message brokers that stateless cloud apps rely on to save information.
      • Installing and managing software services on Pivotal Platform is an ongoing process, and is covered in the Pivotal Platform Operator Guide.

Guide Contents

This guide has two parts. The first part explains the Pivotal Platform planning and installation process, and the second describes the main tools that operators use when installing Pivotal Platform.

Pivotal Platform is a suite of products that runs on multiple IaaSes. Planning and installing Pivotal Platform means building layers from the bottom up, starting with the details of your IaaS and ending with “Day 2” configurations that you perform on a installed and running Pivotal Platform deployment.

This guide follows this bottom-up progression:

After installing Pivotal Platform, Operators install the software services that Pivotal Platform developers use in their apps. These Pivotal Platform services include the databases, caches, and message brokers that stateless cloud apps rely on to save information.

Installing and managing software services on Pivotal Platform is an ongoing process, and is covered in the Pivotal Platform Operator Guide.

The Pivotal Platform Operator Guide explains how to maintain a running Pivotal Platform platform, including monitoring, tuning, troubleshooting, and upgrading.

Getting Started with Pivotal Platform gives a high-level overview of how Pivotal Platform works and explains how you can try a simple deployment on your own local machine.

For all Pivotal Platform documentation, see Pivotal Platform Documentation.