deploying the installation virtual...

Getting Started with Pivotal CFWelcome 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 at the bottom of this guide, or refer to the Troubleshooting Guide

for more tips. Once you have completed the steps in this guide, explore the documentation on

docs.gopivotal.com to learn more about Pivotal CF and the Pivotal One product suite.

RequirementsBefore you begin, ensure your system meets the following prerequisites:

vSphere 5.0, 5.1, or 5.5

vSphere editions: standard and above

The following vSphere user privileges:

Datastore (Allocate space, Browse datastore, Low-level file operations, Remove file,Update virtual machine files)

Folder (All)

Network (Assign network)

Resource (All)

vApp (All)

Virtual machine (All)

Ability to create a wildcard DNS record to point to your router or load balancer. Alternatively, youcould use a service such as xip.io. (Example: 172.16.64.xip.io)

(Recommended) A network without DHCP available for deploying the Pivotal CF VMs. Note : If youhave DHCP, refer to the Troubleshooting Guide to avoid issues with your installation.

Turn hardware virtualization off if your vSphere hosts do not support VT-X/EPT. If you are unsurewhether the VM hosts support VT-x/EPT, then you may turn this setting off. If you leave this settingon and the VM hosts do not support VT-x/EPT, then each VM will require manual intervention invCenter to continue powering on without the Intel virtualized VT-x/EPT. Refer to the vCenter helptopic at Configuring Virtual Machines > Setting Virtual Processors and Memory > Set AdvancedProcessor Options for more information.

Shared storage input/output operations per second (IOPS) at least 10,000

Twice as many available IPs as instances

The cf command line interface tool version 5.4.3 or higher. Refer to the help topic on installing the

© Copyright 2013, Pivotal 1 of 26

http://docs.gopivotal.com


http://pubs.vmware.com/fusion-5/index.jsp?topic=%2Fcom.vmware.fusion.help.doc%2FGUID-38178690-1234-4843-B135-4063F9AA73E4.html


cf CLI tool for more information.

Capacity for the following virtual machines:

INSTANCES VM RAM (GB) DISK (GB) CPU

1 NATS 1 10 1

1 Health Manager 3 36 1

1 NFS Server 1 100 1

1 Cloud Controller Database 1 4 1

1 Cloud Controller 1 2 1

1 Router 1 2 1

1 Syslog 1 10 1

1 Collector 1 2 1

1 UAA Database 1 10 1

1 UAA 1 3 1

1 SAML Login 1 3 1

1 Console Database 1 3 1

1 DEA 16 11 2

1 Loggregator Server 1 2 1

1 Loggregator Router 1 2 1

6 Compilation 1 4 2

21 TOTALS 33 204 18

Deploying the Installation Virtual MachineGoal: Create a virtual machine to install and manage Pivotal CF on vSphere.

1. Refer to the Known Issues section before getting started.

2. Download the Pivotal CF .ova file.

3. Login to vCenter.

4. Select the VM and Templates view.


5. Right click on your datacenter and select New Folder.

6. Name the folder “pivotal_cf” and select it.

7. Select File > Deploy OVF Template.

8. Select the .ova file and click Next.

9. Review the product details and click Next.

10. Accept the license agreement and click Next.


11. Name the virtual machine and click Next.

Note : The selected folder is the one you created.

12. Select a vSphere cluster and click Next.

13. Select a resource pool and click Next.

14. Select a host and click Next.

Note : Hardware virtualization must be off if your vSphere host does not support VT-X/EPT. Refer to

the Requirements list for more information.

15. Select a storage destination and click Next.

16. Select a disk format and click Next.


17. Select a network and click Next.

18. Enter network information and passwords for the VM admin user and click Next.

Note : The IP Address you enter will be the location of the Pivotal CF Operations Manager interface.


19. Check the Power on after deployment checkbox and click Finish. Once the VM boots, the

interface is available at the IP address you specified.

Note : It is normal to experience a brief delay before the interface is accessible while the web server

and VM start up.

Setting Up Your PaaSGoal: Configure vmware vSphere, Elastic Runtime, and MySQL.

Understanding the Pivotal CF Operations Manager Interface

1. Browse to the interface IP address you specified in the Deploying the Installation VM section

above.


2. Create a User name and Password and log in to access the interface.

Note : Save your password in a backed-up location. If you lose your password, your installation will

be unmanageable.

A—Product Dashboard: Displays product tiles for each installed product in your PaaS.

Add a new product: Navigates to the Add Product view. You can either add a newproduct or import an existing configured product.

B—User account menu: Use this menu to change your password or log out.

C—Actions menu: Includes the following options:

Import installation: Navigates to the Import installation view. Select this option to importan existing Pivotal CF installation with all of its assets. When you import an installation,the prior installation will disappear and be replaced by the newly imported one.

Export activity data: Downloads a directory containing the the config file for theinstallation, the deployment history, and version information.

D—Pending Changes view: Displays queued installations and updates that will install during the


next deploy.

Note : Installs and updates automatically execute in the correct order such that prerequisites install

before the update that depends on them.

Configuring Included Products

1. Under vmware vSphere, click Configure .

2. Enter your vCenter IP and credentials and click Save .

Note : This user must have create and delete privileges for VMs and folders.

3. Select vSphere configuration, specify the installation resources, and click Save .


4. Select Network configuration, enter the Pivotal CF IP ranges, DNS, and gateway settings, and

click Save . The Pivotal CF VMs will use the IP Range you specify. Reserved IP Ranges are

blacklisted from the installation.


5. Select NTP servers, enter a comma-delimited list of time server addresses, and click Save .

6. Select Resource Sizes, accept the defaults or make necessary changes, and click Save .


7. Click Product Dashboard to exit the configuration wizard.

8. Click Add a new product.

9. Under Elastic Runtime , click Add.


10. (Optional) Enter at least one HAProxy IP address. You must point your DNS to this IP unless you

are using your own load balancer. If you decide to use your own load balancer, leave this field blank.

11. (Required) SSL certificates: If you are using a signed certificate from a well-known certificate

authority (CA), input that value in the fields below. Alternatively, complete the following steps marked

Required unless importing certificate to generate self-signed RSA certificates.


12. (Required unless importing certificate) Click Generate Self-Signed RSA Certificate .

13. (Required unless importing certificate) Enter your system and app domains in wildcard format,

as well as optionally any custom domains, and click Save . Refer to Elastic Runtime > CloudController for explanations of these domain values.

14. (Required) The Private Key PEM and Certificate Key PEM fields now contain certificate keys.

Click Save .


15. Enter two domains for your Cloud Controller installation and click Save . The system domain is used

to target and push apps to Elastic Runtime. The application domain is used to serve apps. Set up

wildcard DNS records for these domains as described in the next step.


16. If you are using HAProxy, you may leave the Router IPs field blank. Alternatively, if you are not

using HAProxy and you are using your own load balancer, select Router IPs and enter the static

IP(s) for Pivotal CF that you have registered previously with your load balancer.

17. (Optional–Advanced) If you are using the vmware SSO appliance for integration with Active

Directory, complete this step. Select SAML Login and enter the URL of an SSO appliance to

connect to Active Directory servers in your organization.


18. (Optional) Select Web Console, enter your reply-to and SMTP email information, and click Save .

The console 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 will be required to

create orgs and users using the cf CLI tool. Refer to the section on Creating a New User Account for

more information.


19. Select Resource Sizes, accept the defaults or make necessary changes, and click Save .


20. Click Product Dashboard to exit the configuration wizard.

21. Click Add a new product.


22. Under MySQL Dev, click Add.

23. Configure the MySQL resource sizes or keep the default values, then click Product Dashboard to

exit the configuration wizard.


24. Click Install.

25. Your updated Pivotal CF installation begins deploying.

26. When the deployment is finished, a success message appears.


Note : On the recommended hardware infrastructure, deployment should take less that 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.

Creating a New User AccountOnce you have successfully deployed Pivotal CF, complete one of the following workflows to add users to your

account.

Option 1: Adding new users if you have enabled SMTP

The Developer Console is a self-service tool to help manage organizations, users, applications, and

application spaces. If you have set up SMTP, your users can access the Developer Console to sign up for

accounts and create their own orgs.

Instruct users to complete the following steps to log in and get started using the Developer Console.

1. Browse to console.<your-app-domain>.com . Refer to Elastic Runtime > Cloud Controller to

locate your app domain.

2. Select Create an Account.

3. Enter your email address and click Create an Account. You will receive an email from the

Developer Console when your account is ready.

4. When you receive the new account email, follow the link in the email to complete your registration.


4. When you receive the new account email, follow the link in the email to complete your registration.

5. You will be asked to choose your organization name.

You now have access to the Developer Console. Refer to the Pivotal CF Developer Console documentation at

docs.gopivotal.com for more information about using the Developer Console.

Option 2: Adding new users as admin

If you have not set up SMTP, the admin must create an organization and assign new users. This workflow is

not self-service for users. Complete the following steps to log in and invite new users using the cf CLI tool.

1. If you have not already installed the cf CLI tool, browse to the Developer Console at

console.<your-app-domain>.com and navigate to the Tools page. This page prompts you to select

your operating system and provides the appropriate instructions for installing the cf CLI tool.

2. Log in using the UAA administrator user credentials. Refer to Elastic Runtime > Credentials for

this login information, located about halfway down the page. If you do not supply required options

on the command line, cf will prompt for them.

$ cf target https://api.<your-app-domain>.cf-app.com$ cf login admin...

3. You must create a new org for new users or select an existing org for them to join. To create a new

org, run:

$ cf create-org [org-name]

4. Create a new user and specify the org the user should join.

$ cf create-user [user-email] -o [org-name]

5. cf prompts you for the password for the new user.

6. Give the new user the Developer Console address and their new credentials. The user now has

access to the Developer Console. Refer to the Pivotal CF Developer Console documentation at

docs.gopivotal.com for more information about using the Developer Console.

Target Elastic Runtime




The next step is to use the cf tool to target your Elastic Runtime installation. Make sure you have installed the

cf tool according to the instructions on docs.gopivotal.com.

1. Open a terminal.

2. Login to your Cloud Controller by targeting ‘api’ followed by the system domain. Refer to ElasticRuntime > Configure > Domains if you do not remember this domain.

$ cf target https://api.<your-app-domain>$ cf login adminPassword> ***********

Note : Refer to Elastic Runtime > Credentials for the UAA admin and password. You can also use

the user that you created in the console, or create another user with the create-user command.

3. Switch to the org and space you created in the Developer Console.

cf target -o my-awesome-orgSwitching to organization my-awesome-org... OK1: development2: production3: stagingSpace> 1Switching to space development... OK

Target Information (where apps will be pushed):

CF instance: http://api.<your-app-domain> (API version: 2)user: admintarget app space: development (org: my-awesome-org)

4. Switch to the directory of an app you would like to push to Elastic Runtime.

$ cd someapp

5. Push the app to Elastic Runtime.

$ cf push someapp

Refer to the Pivotal CF documentation for an overview and examples of the cf command line tool.

Adding and Deleting Products

Refer to this section for help adding and deleting additional products, such as Pivotal HD for Pivotal CF,

Pivotal AX, and Pivotal RabbitMQ.



Adding and Importing Products

1. From the Product Dashboard, click the Add a new product tile to navigate to the Add Products

page.

2. The Add Products page displays the Import A Product tile and tiles for bundled and previously

imported products that are available to add.

3. To add an available product, click Add on the associated product tile.

4. To import a product, use the Import A Product tile to choose the .zip file that you downloaded

from Pivotal Network or received from your software distributor, then click Add.

Deleting a Product

1. From the Product Dashboard, click the trash icon on a product tile to remove that product.


Note : You cannot delete the vmware vSphere product.

2. After you delete a product, the product tile is removed from the installation and the Product

Dashboard. However, the product appears as an available product in the Add Products page.

Backing Up and Restoring Your Installation Settings

Refer to this section for help importing and exporting your Pivotal CF installation settings. It is important to

back up your installation settings by exporting frequently. Always export an installation before importing a new

one. Import an installation to restore your settings or to share your settings with another user.

Note : Exporting your installation only backs up your installation settings. It does not back up your VMs.

Exporting an installation

From the Product Dashboard, select Actions > Export installation. This option is only available after you

have deployed at least one time.

Export installation exports the current Pivotal CF installation with all of its assets. When you export an

installation, the exported file contains references to the installation’s IP addresses. It also contains the base

VM images and necessary packages. As a result, an export can be very large (as much as 5 GB or more).

Importing an installation

From the Product Dashboard, select Actions > Import installation.

Import installation imports an existing Pivotal CF installation with all of its assets. When you import an

installation, the prior installation will disappear and be replaced by the newly imported one.

Known Issues and Important Tips for this ReleaseVersion 1.0.0.0 of Pivotal CF includes the following known issues:

vSphere folder names with special characters in the name will cause failures.

You must use the UAAC gem to create additional admin users.

Changing the CF admin user’s password will revert if Elastic Runtime is re-installed.

If vSphere performance data is not available, a deploy will result in a divide by zero error.

Networks, clusters, and datacenters cannot be in folders.

If DHCP is available to the Pivotal CF VM, the IP could be reset from the static IP (reboot to fix).


Admins must create organizations and users if SMTP is not available for inviting users via email.

SMTP settings for the console must be changed manually after the first deploy.

Deleting a service (MySQL, Rabbit, HD) from the Product Dashboard requires manual servicebroker removal.

Logging into the Pivotal CF VM causes browser to complain about self-signed certificates.

You must turn hardware virtualization off if the vSphere host does not support VT-X/EPT.


deploying the installation virtual...

Documents