Getting Started with Pivotal CF
Welcome to Pivotal CF!
This guide is intended to walk you through deploying the installation virtual machine, setting up your PaaS, targeting Elastic Runtime, and pushing your first app. If at any time you experience a problem following the steps below, try checking the Known Issues, or refer to the Troubleshooting Guide for more tips. Once you have completed the steps in this guide, explore the documentation on docs.pivotal.io to learn more about Pivotal CF and the Pivotal One product suite.
Before you begin your Pivotal CF deployment, ensure that your system meets the minimum requirements. The requirements include capacity for the virtual machines necessary for the deployment, a supported version of the cf command line interface tool, and certain user privileges. Refer to the Prerequisites to Deploying Operations Manager and Elastic Runtime topic for the complete list.
Download the Pivotal CF .ova file and deploy it. The procedure you follow depends on the IaaS you use:
Goal: Configure and install Ops Manager Director (included), Elastic Runtime, and MySQL for Pivotal CF. Skip the import steps for Elastic Runtime or MySQL for Pivotal CF if you do not want to import these products.
Browse to the interface IP address you specified in Step 2.
Create a User name and Password and log in to access the interface.
Note: On your first login attempt, an error message that the connection is untrusted appears because you are attempting to connect securely to a website with a self-signed certificate. Add Ops Manager as an exception to bypass this message on subsequent logins.
Download Elastic Runtime and MySQL for Pivotal CF at Pivotal Network.
- Elastic Runtime: Click the Pivotal CF banner to access the Pivotal CF product page. Use the dropdown menu to select an Elastic Runtime release.
- MySQL for Pivotal CF: Select the All Products tab to view available products. Search for MySQL for Pivotal CF and select a release.
From the Available Products view, click Import a Product.
Select the Elastic Runtime .pivotal file that you downloaded from Pivotal Network and click Open. After the import completes, Elastic Runtime appears in the Available Products view.
Repeat the previous step for MySQL for Pivotal CF.
In the Available Products view, hover over Elastic Runtime and click Add. Repeat this step for MySQL for Pivotal CF.
Your Ops Manager download includes a tile for the version of Ops Manager Director that corresponds to your IaaS. Refer to one of the following topics for help configuring your Ops Manager Director product tile:
- Configuring Ops Manager Director for VMware vSphere
- Configuring Ops Manager Director for vCloud Air and vCloud
Click the Elastic Runtime tile.
Select Assign Networks. Elastic Runtime runs on the network you select.
(vSphere Only) Select Assign Availability Zones. These are the Availability Zones that you create when configuring Ops Manager Director.
- Select an Availability Zone under Place singleton jobs. Ops Manager runs any job with a single instance in this Availability Zone.
- Select one or more Availability Zones under Balance other jobs. Ops Manager balances instances of jobs with more than one instance across the Availability Zones that you specify.
In the left column, select HAProxy.
The value you enter in the HAProxy IPs field depends on whether you are using your own load balancer or the HAProxy load balancer.
- Your own load balancer: Leave this field blank.
- HAProxy load balancer: Enter at least one HAProxy IP address. Point your DNS to this address.
If you are using a signed SSL Certificate from a known certificate authority (CA), copy and paste its values for Certificate PEM and Private Key PEM into the appropriate text fields. If you have an Intermediate CA paste it in the same box below the Certificate PEM. Alternatively, complete the following two steps to generate self-signed RSA certificates.
- Check the Trust Self-Signed Certificates checkbox, then click Generate Self-Signed RSA Certificate.
- Enter your system and app domains in wildcard format. Optionally, also add any custom domains in wildcard format. Click Generate.
Note: Wildcard DNS records only work for a single domain name component or component fragment. For example,
system.domain.com, but not
The Certificate Key PEM and Private Key PEM fields now contain certificate keys. Click Save.
Select Router IPs. The value you enter in the Router IPs field depends on whether you are using your own load balancer or the HAProxy load balancer.
- Your own load balancer: Enter the IP address(es) for Pivotal CF that you registered with your load balancer. Refer to the Using Your Own Load Balancer topic for help using your own load balancer with Pivotal CF.
- HAProxy load balancer: Leave this field blank.
- The System Domain defines your target when you push apps to Elastic Runtime.
- The Apps Domain defines where Elastic Runtime should serve your apps.
Notes: You configured wildcard DNS records for these domains in an earlier step.
Leave the Cloud Controller DB encryption key field blank unless:
- You deployed Elastic Runtime earlier
- You then stopped Elastic Runtime, or it crashed
- You are re-deploying Elastic Runtime with a backup of your Cloud Controller database
Enter your Cloud Controller database encryption key only if these conditions apply. See Backing Up Pivotal CF for more information.
Enter your intended maximum file upload size.
(Optional) Check the Disable Custom Buildpacks checkbox. By default, the cf command line tool gives developers the option of using a custom buildpack when they deploy apps to Elastic Runtime. To do so, they use the
-boption to provide a custom buildpack URL with the
cf pushcommand. The Disable Custom Buildpacks checkbox disables the
-boption. For more information about custom buildpacks, refer to the buildpacks section of the Pivotal CF documentation.
(Optional - Advanced) If you are forwarding syslog messages via TCP to a RELP syslog server, complete this step. Select External Endpoints, enter the IP address and port of the syslog aggregator host, and click Save.
Note: The host must be reachable from the Elastic Runtime network, accept TCP connections, and use the RELP protocol. Ensure
syslogdlistens on external interfaces.
(Optional - Advanced) If you are using the VMware SSO appliance for integration with Active Directory, complete this step. Select SSO Config, enter the URL of an SSO appliance to connect to Active Directory servers in your organization, and click Save.
(Optional - Advanced) If you are using the LDAP endpoint for UAA, complete this step. Select LDAP Config and enter the following information:
- LDAP server URL
- LDAP credentials
- LDAP search base
- LDAP search filter
- LDAP server SSL certificate
- Alternate name for the LDAP server SSL certificate
(Optional) Select SMTP Config, enter your reply-to and SMTP email information, and click Save. Apps Manager uses these settings to send invitations and confirmations to console users. These SMTP settings are required if you want to enable end-user self-registration.
Note: If you do not configure the SMTP settings using this form, the administrator must create orgs and users using the cf CLI tool. See Creating and Managing Users with the cf CLI for more information.
Select Lifecycle Errands. By default, Ops Manager runs the Run Smoke Tests and Push Console errands after installing Elastic Runtime. See Understanding Lifecycle Errands for more information.
Note: The Push Console errand also deploys the usage service, which provides data on the count of instances and amount of memory that apps consume. When the usage service starts for the first time, it executes an API call to purge all application usage events from the Cloud Controller Database. Subsequent Apps Manager and usage service deploys do not trigger this API call, and do not purge application usage events.
Select Resource Config, accept the defaults or make necessary changes, and click Save.
Click the Installation Dashboard link to return to the Installation Dashboard.
Click the MySQL Dev tile.
Configure the MySQL Service Plan, Lifecycle Errands, and resource sizes. Assign Availability Zones and an Ops Manager network, then click Save.
Click the Installation Dashboard link to return to the Installation Dashboard.
Your updated Pivotal CF installation begins deploying.
When the deployment is finished, a success message appears.
Note: On the recommended hardware infrastructure, deployment should take less than one hour and require no user intervention.
You now have a fully functional installation of Pivotal CF and Pivotal MySQL Service. The following sections will help you start using your PaaS.
Once you have successfully deployed Pivotal CF, add users to your account. Refer to the Creating New Elastic Runtime User Accounts topic for more information.
The next step is to use the cf CLI tool to target your Elastic Runtime installation. Make sure you have installed the cf CLI tool. Refer to the Pivotal CF documentation for more information about using the cf command line tool.
Note: In Pivotal Operations Manager, refer to Elastic Runtime > Credentials for the UAA admin name and password. You can also use the user that you created in Apps Manager, or create another user with the create-user command.