Note: If you plan to install the PCF IPsec add-on, you must do so before installing any other tiles. Pivotal recommends installing IPsec immediately after Ops Manager, and before installing the PAS tile.

Step 1: Download the PAS Tile

If you have not already downloaded PAS, log in to Pivotal Network, and click PAS.

From the Releases drop-down, select the release to install and choose one of the following:

Step 2: Add PAS to Ops Manager

Click Import a Product to add the PAS tile to Ops Manager. This may take a while depending on your connection speed.

Tip: After you import a tile to Ops Manager, you can view the latest available version of that tile in the Installation Dashboard by enabling the Pivotal Network API. For more information, refer to the Adding and Deleting Products topic.

On the left, click the plus icon next to the imported PAS product to add it to the Installation Dashboard.

A TCP load balancer for SSH access to applications named MY-PCF-ssh-proxy

A TCP load balancer for the TCP router named MY-PCF-cf-tcp-lb if you plan on enabling the TCP routing feature

Note: You can locate the static IP address of each load balancer by clicking its name under Networks > Load balancing in the GCP Console.

Log in to the DNS registrar that hosts your domain. Examples of DNS registrars include Network Solutions, GoDaddy, and Register.com.

Create A records with your DNS registrar that map domain names to the public static IP addresses of the load balancers located above:

If your DNS entry is:

Set to the public IP of this load balancer:

Required

Example

*.YOURSYSTEMDOMAIN

MY-PCF-global-pcf

Yes

*.system.example.com

*.YOURAPPSDOMAIN

MY-PCF-global-pcf

Yes

*.apps.example.com

doppler.YOURSYSTEMDOMAIN

MY-PCF-wss-logs

Yes

doppler.system.example.com

loggregator.YOURSYSTEMDOMAIN

MY-PCF-wss-logs

Yes

loggregator.system.example.com

ssh.YOURSYSTEMDOMAIN

MY-PCF-ssh-proxy

Yes, to allow SSH access to apps

ssh.system.example.com

tcp.YOURDOMAIN

MY-PCF-cf-tcp-lb

No, only set up if you have enabled the TCP routing feature

tcp.example.com

Save changes within the web interface of your DNS registrar.

In a terminal window, run the following dig command to confirm that you created your A record successfully:

dig xyz.EXAMPLE.COM

You should see the A record that you just created:

;; ANSWER SECTION:
xyz.EXAMPLE.COM. 1767 IN A 203.0.113.1

Note: You must complete this step before proceeding to Cloud Controller configuration. A difficult-to-resolve problem can occur if the wildcard domain is improperly cached before the A record is registered.

Note: Pivotal recommends that you use the same domain name but different subdomain names for your system and app domains. For example, use system.example.com for your system domain, and apps.example.com for your apps domain.

Click Save.

Step 6: Configure Networking

Select Networking.

Leave the Router IPs, SSH Proxy IPs, HAProxy IPs, and TCP Router IPs fields blank. You do not need to complete these fields when deploying PCF to GCP.

Note: You specify load balancers in the Resource Config section of PAS later on in the installation process. See the Configure Load Balancers section of this topic for more information.

Under Certificates and Private Key for HAProxy and Router, you must provide at least one Certificate and Private Key name and certificate keypair for HAProxy and Gorouter. The HAProxy and Gorouter are enabled to receive TLS communication by default. You can configure multiple certificates for HAProxy and Gorouter.

Click the Add button to add a name for the certificate chain and its private keypair. This certificate is the default used by Gorouter and HAProxy.
You can either provide a certificate signed by a Certificate Authority (CA) or click on the Generate RSA Certificate link to generate a self-signed certificate in Ops Manager.

If you want to configure multiple certificates for HAProxy and Gorouter, click the Add button and fill in the appropriate fields for each additional certificate keypair.

Note: If you configured Ops Manager Front End without a certificate,
you can use this new certificate to complete Ops Manager configuration. To configure your Ops Manager Front End certificate,
see Configure Front End in Preparing to Deploy Ops Manager on GCP Manually.

Note: Ensure that you add any certificates that you generate in this pane to your infrastructure load balancer.

(Optional) When validating client requests using mutual TLS, the Gorouter trusts multiple certificate authorities (CAs) by default. If you want to configure the Gorouter and HAProxy to trust additional CAs, enter your CA certificates under Certificate Authorities Trusted by Router and HAProxy. All CA certificates should be appended together into a single collection of PEM-encoded entries.

In the Minimum version of TLS supported by HAProxy and Router field, select the minimum version of TLS to use in HAProxy and Gorouter communications. HAProxy and Gorouter use TLS v1.2 by default. If you need to accommodate clients that use an older version of TLS, select a lower minimum version. For a list of TLS ciphers supported by the Gorouter, see Securing Traffic into Cloud Foundry.

Configure Logging of Client IPs in CF Router. The Log client IPs option is set by default. To comply with the General Data Protection Regulation (GDPR), select one of the following options to disable logging of client IP addresses:

If your load balancer exposes the source IP of the originating client, disable logging of both the source IP address and the X-Forwarded-For HTTP header.

Under Configure support for the X-Forwarded-Client-Cert header, configure PCF handles x-forwarded-client-cert (XFCC) HTTP headers based on where TLS is terminated for the first time in
your deployment.
The following table indicates which option to choose based on your deployment layout.

If your deployment is configured as follows:

Then select the following option:

Additional notes:

The Load Balancer is terminating TLS, and

Load balancer is configured to put the client certificate from a mutual authentication TLS handshake into the X-Forwarded-Client-Cert HTTP header

TLS terminated for the first time at infrastructure load balancer (default).

Both HAProxy and the Gorouter forward the XFCC header when included in the request.

The Load Balancer is configured to pass through the TLS handshake via TCP to the instances of HAProxy, and

HAProxy instance count is > 0

TLS terminated for the first time at HAProxy.

HAProxy sets the XFCC header with the client certificate received in the TLS handshake. The Gorouter forwards the header.

Breaking Change: In the Router behavior for Client Certificates field, you cannot select the Router does not request client certificates option.

The Load Balancer is configured to pass through the TLS handshake via TCP to instances of the Gorouter

TLS terminated for the first time at the Gorouter.

The Gorouter strips the XFCC header if it is included in the request and forwards the client certificate received in the TLS handshake in a new XFCC header.

If you have deployed instances of HAProxy, app traffic bypasses those instances in this configuration. If you have also configured your load balancer to route requests for ssh directly to the Diego Brain, consider reducing HAProxy instances to 0.

Breaking Change: In the Router behavior for Client Certificates field, you cannot select the Router does not request client certificates option.

To configure HAProxy to handle client certificates, select one of the following options in the HAProxy behavior for Client Certificate Validation field.

HAProxy does not request client certificates. This option requires mutual authentication, which makes it incompatible with XFCC option TLS terminated for the first time at HAProxy. HAProxy does not request client certificates, so the client does not provide them and no validation occurs. This is the default configuration.

HAProxy requests but does not require client certificates. The HAProxy requests client certificates in TLS handshakes, validates them when presented, but does not require them.

WARNING: Upon upgrade, PAS will fail to receive requests if your load balancer is configured to present a client certificate in the TLS handshake with HAProxy but HAProxy has not been configured with the certificate authority used to sign it. To mitigate this issue, select HAProxy does not request client certificates in the Networking pane or configure the HAProxy with the appropriate CA.

To configure Gorouter behavior for handling client certificates, select one of the following options in the Router behavior for Client Certificate Validation field.

Router does not request client certificates. This option is incompatible with the XFCC configuration options TLS terminated for the first time at HAProxy and TLS terminated for the first time at the Router in PAS because these options require mutual authentication. As client certificates are not requested, client will not provide them, and thus validation of client certificates will not occur.

Router requests but does not require client certificates. The Gorouter requests client certificates in TLS handshakes, validates them when presented, but does not require them. This is the default configuration.

Router requires client certificates. The Gorouter validates that the client certificate is signed by a Certificate Authority that the Gorouter trusts. If the Gorouter cannot validate the client certificate, the TLS handshake fails.

WARNING: Requests to the platform will fail upon upgrade if your load balancer is configured with client certificates and the Gorouter does not have the certificate authority. To mitigate this issue, select Router does not request client certificates for Router behavior for Client Certificate Validation in the Networking pane.

In the TLS Cipher Suites for Router field, review the TLS cipher suites for TLS handshakes between Gorouter and front-end clients such as load balancers or HAProxy. The default value for this field is ECDHE-RSA-AES128-GCM-SHA256:TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.
If you want to modify the default configuration,
use an ordered, colon-delimited list of Golang-supported TLS cipher suites in the OpenSSL format.
Operators should verify that the ciphers are supported by any clients or front-end components that will initiate TLS handshakes with Gorouter. For a list of TLS ciphers supported by Gorouter, see Securing Traffic into Cloud Foundry.
Verify that every client participating in TLS handshakes with Gorouter has at least one cipher suite in common with Gorouter.

Note: Specify cipher suites that are supported by the versions configured in the Minimum version of TLS supported by HAProxy and Router field.

In the TLS Cipher Suites for HAProxy field, review the TLS cipher suites for TLS handshakes between HAProxy and its clients such as load balancers and Gorouter. The default value for this field is the following:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384
If you want to modify the default configuration,
use an ordered, colon-delimited list of TLS cipher suites in the OpenSSL format.
Operators should verify that the ciphers are supported by any clients or front-end components that will initiate TLS handshakes with HAProxy.
Verify that every client participating in TLS handshakes with HAProxy has at least one cipher suite in common with HAProxy.

Note: Specify cipher suites that are supported by the versions configured in the Minimum version of TLS supported by HAProxy and Router field.

Under HAProxy forwards requests to Router over TLS, select Enable or Disable based on your deployment layout.

Enable HAProxy forwarding of requests to Router over TLS

If you want to:

Encrypt communication between HAProxy and the Gorouter

Then configure the following:

Leave Enable selected.

In the Certificate Authority for HAProxy Backend field, specify the Certificate Authority (CA) that signed the certificate you configured in the Certificate and Private Key for HAProxy and Router field.

Note: If you used the Generate RSA Certificate link to generate a self-signed certificate, then the CA to specify is the Ops Manager CA, which you can locate at the /api/v0/certificate_authorities endpoint in the Ops Manager API.

Make sure that Gorouter and HAPRoxy have TLS cipher suites in common in the TLS Cipher Suites for Router and TLS Cipher Suites for HAProxy fields.

If you want to force browsers to use HTTPS when making requests to HAProxy, select Enable in the HAProxy support for HSTS field and complete the following optional configuration steps:

(Optional) Enter a Max Age in Seconds for the HSTS request. By default, the age is set to one year. HAProxy will force HTTPS requests from browsers for the duration of this setting.

(Optional) Select the Include Subdomains checkbox to force browsers to use HTTPS requests for all component subdomains.

(Optional) Select the Enable Preload checkbox to force instances of Google Chrome, Firefox, and Safari that access your HAProxy to refer to their built-in lists of known hosts that require HTTPS, of which HAProxy is one. This ensures that the first contact a browser has with your HAProxy is an HTTPS request, even if the browser has not yet received an HSTS header from HAProxy.

If you are not using SSL encryption or if you are using self-signed certificates, select Disable SSL certificate verification for this environment. Selecting this checkbox also disables SSL verification for route services.

Note: For production deployments, Pivotal does not recommend disabling SSL certificate verification.

(Optional) If you want HAProxy or the Gorouter to reject any HTTP (non-encrypted) traffic, select the Disable HTTP on HAProxy and Gorouter checkbox. When selected, HAProxy and Gorouter will not listen on port 80.

(Optional) Select the Disable insecure cookies on the Router checkbox to set the secure flag for cookies generated by the router.

(Optional) To disable the addition of Zipkin tracing headers on the Gorouter, deselect the Enable Zipkin tracing headers on the router checkbox. Zipkin tracing headers are enabled by default. For more information about using Zipkin trace logging headers, see Zipkin Tracing in HTTP Headers.

(Optional) To stop the Router from writing access logs to local disk, deselect the Enable Router to write access logs locally checkbox. You should consider disabling this checkbox for high traffic deployments since logs may not be rotated fast enough and can fill up the disk.

By default, the PAS routers handle traffic for applications deployed to an isolation segment created by the PCF Isolation Segment tile. To configure the PAS routers to reject requests for applications within isolation segments, select the Routers reject requests for Isolation Segments checkbox.
Do not enable this option without deploying routers for each isolation segment. See the following topics for more information:

(Optional) By default, Gorouter support for the PROXY protocol is disabled. To enable the PROXY protocol, select Enable support for PROXY protocol in CF Router. When enabled, client-side load balancers that terminate TLS but do not support HTTP can pass along information from the originating client. Enabling this option may impact Gorouter performance.
For more information about enabling the PROXY protocol in Gorouter, see the HTTP Header Forwarding sections in the Securing Traffic in Cloud Foundry topic.

In the Choose whether to enable route services section, choose either Enable route services or Disable route services.
Route services are a class of marketplace services that perform filtering or content transformation on application requests and responses.
See the Route Services topic for details.

If you enabled route services, you can also configure the Bypass security checks for route service lookup field. Pivotal recommends that you do not enable this field because it has potential security concerns. However, you may need to enable it if your load balancer requires mutual TLS from clients. For more information, see Configuring Route Service Lookup.

(Optional) If you want to limit the number of app connections to the backend, enter a value in the Max Connections Per Backend field. You can use this field to prevent a poorly behaving app from all the connections and impacting other apps.

To choose a value for this field, review the peak concurrent connections received by instances of the most popular apps in your deployment. You can determine the number of concurrent connections for an app from the httpStartStop event metrics emitted for each app request.

If your deployment uses PCF Metrics, you can also obtain this peak concurrent connection information from Network Metrics. The default value is 500.

Under Enable Keepalive Connections for Router, select Enable or Disable. Keepalive connections are enabled by default.
For more information, see Keepalive Connections in HTTP Routing.

(Optional) To accommodate larger uploads over connections with high latency, increase the number of seconds in the Router Timeout to Backends field.

(Optional) Use the Frontend Idle Timeout for Gorouter and HAProxy field to help prevent connections from your load balancer to Gorouter or HAProxy from being closed prematurely. The value you enter sets the duration, in seconds, that Gorouter or HAProxy maintains an idle open connection from a load balancer that supports keep-alive.

In general, set the value higher than your load balancer’s backend idle timeout to avoid the race condition where the load balancer sends a request before it discovers that Gorouter or HAProxy has closed the connection.

See the following table for specific guidance and exceptions to this rule:

IaaS

Guidance

AWS

AWS ELB has a default timeout of 60 seconds, so Pivotal recommends a value greater than 60.

Azure

By default, Azure load balancer times out at 240 seconds without sending a TCP RST to clients, so as an exception, Pivotal recommends a value lower than 240 to force the load balancer to send the TCP RST.

GCP

GCP has a default timeout of 600 seconds. For GCP HTTP load balancers, Pivotal recommends a value greater than 600. For GCP TCP load balancers, pivotal recommends a value less than 600 to force the load balancer to send a TCP RST.

Other

Set the timeout value to be greater than that of the load balancer’s backend idle timeout.

Note: Do not set a frontend idle timeout lower than six seconds.

(Optional) Increase the value of Load Balancer Unhealthy Threshold to specify the amount of time, in seconds, that the router continues to accept connections before shutting down. During this period, healthchecks may report the router as unhealthy, which causes load balancers to failover to other routers. Set this value to an amount greater than or equal to the maximum time it takes your load balancer to consider a router instance unhealthy, given contiguous failed healthchecks.

(Optional) Modify the value of Load Balancer Healthy Threshold. This field specifies the amount of time, in seconds, to wait until declaring the Router instance started. This allows an external load balancer time to register the Router instance as healthy.

(Optional) If app developers in your organization want certain HTTP headers to appear in their app logs with information from the Gorouter, specify them in the HTTP Headers to Log field. For example, to support app developers that deploy Spring apps to PCF, you can enter Spring-specific HTTP headers.

If you expect requests larger than the default maximum of 16 Kbytes, enter a new value (in bytes) for HAProxy Request Max Buffer Size. You may need to do this, for example, to support apps that embed a large cookie or query string values in headers.

If your PCF deployment uses HAProxy and you want it to receive traffic only from specific
sources, use the following fields:

HAProxy Trusted
CIDRs: Optionally, enter a space-separated list of CIDRs to limit which
IP addresses from the Protected Domains can send traffic to PCF.

The Loggregator Port defaults to 443 if left blank. Enter a new value to override the default.

For Container Network Interface Plugin, ensure Silk is selected and review the following fields:

Note: The External option exists to support NSX-T integration for vSphere deployments.

(Optional) You can change the value in the Applications Network Maximum Transmission Unit (MTU) field. Pivotal recommends setting the MTU value for your application network to 1454. Some configurations, such as networks that use GRE tunnels, may require a smaller MTU value.

(Optional) Enter an IP range for the overlay network in the Overlay Subnet box. If you do not set a custom range, Ops Manager uses 10.255.0.0/16.

WARNING: The overlay network IP range must not conflict with any other IP addresses in your network.

Enter a UDP port number in the VXLAN Tunnel Endpoint Port box. If you do not set a custom port, Ops Manager uses 4789.

For Denied logging interval, set the per-second rate limit for packets blocked by either a container-specific networking policy or by Application Security Group rules applied across the space, org, or deployment. This field defaults to 1.

For UDP logging interval, set the per-second rate limit for UDP packets sent and received. This field defaults to 100.

For DNS Servers, enter 8.8.8.8 only if you have BOSH disabled. Otherwise, you cannot use this field to override the DNS servers used in containers.

Note: If you do not want to configure your DNS servers with 8.8.8.8, contact Pivotal Support.

For DNS Search Domains, enter DNS search domains for your containers as a comma-separated list. DNS on your containers appends these names to its host names, to resolve them into full domain names.

For Database Connection Timeout, set the connection timeout for clients of the policy server and silk databases. The default value is 120. You may need to increase this value if your deployment experiences timeout issues related to Container-to-Container Networking.

(Optional) TCP Routing is disabled by default. You should enable this feature if your DNS sends TCP traffic through a load balancer rather than directly to a TCP router. To enable TCP routing:

Select Enable TCP Routing.

For TCP Routing Ports, enter a single port or a range of ports for the load balancer to forward to. These are the same ports that you configured in the Pre-Deployment Steps of the Enabling TCP Routing topic.

For GCP, you also need to specify the name of a GCP TCP load balancer in the LOAD BALANCER column of TCP Router job of the Resource Config screen. You configure this later on in PAS. See Configure Load Balancers section of this topic.

(Optional) To disable TCP routing, click Select this option if you prefer to enable TCP Routing at a later time. For more information, see the Configuring TCP Routing in PAS topic.

Click Save.

Step 7: Configure Application Containers

Select Application Containers.

The Enable Custom Buildpacks checkbox governs the ability to pass a custom buildpack URL to the -b option of the cf push command. By default, this ability is enabled, letting developers use custom buildpacks when deploying apps. Disable this option by disabling the checkbox. For more information about custom buildpacks, refer to the buildpacks section of the PCF documentation.

The Allow SSH access to app containers checkbox controls SSH access to application instances. Enable the checkbox to permit SSH access across your deployment, and disable it to prevent all SSH access. See the Application SSH Overview topic for information about SSH access permissions at the space and app scope.

If you want to enable SSH access for new apps by default in spaces that allow SSH, select Enable SSH when an app is created. If you deselect the checkbox, developers can still enable SSH after pushing their apps by running cf enable-ssh APP-NAME.

If you want to disable the Garden Root filesystem (GrootFS), deselect the Enable the GrootFS container image plugin for Garden RunC checkbox. Pivotal recommends using this plugin, so it is enabled by default. However, some external components are sensitive to dependencies with filesystems such as GrootFS. If you experience issues, such as antivirus or firewall compatibility problems, deselect the checkbox to roll back to the plugin that is built into Garden RunC. For more information about GrootFS, see Component: Garden and Container Mechanics.

Note: If you modify this setting, Pivotal recommends recreating all VMs in the BOSH Director config. You can do this by selecting the Recreate all VMs checkbox in the Director Config pane of the BOSH Director tile before you redeploy.

Verifying app identity using TLS enables encryption between router and app containers and guards against misrouting during control plane failures. For more information about Gorouter route consistency modes, see Preventing Misrouting in HTTP Routing.

Warning: TLS routing requires an additional 32 MB of RAM capacity on Diego cells per app instance. It also requires additional CPU capacity on Diego cells. If the total amount of Diego cell memory available is less than 32 MB times the number of running app instances, scale your Diego cells before configuring the Gorouter with TLS.

Warning: You may see an increase of memory and CPU usage for your Gorouters after enabling TLS routing. If the total amount of memory and CPU usage of the Gorouters in your environment are close to the size limit, scale your Gorouters before enabling TLS routing.

You can configure Pivotal Application Service (PAS) to run app instances in Docker containers by supplying their IP address ranges in the Private Docker Insecure Registry Whitelist textbox. See the Using Docker Registries topic for more information.

Select your preference for Docker Images Disk-Cleanup Scheduling on Cell VMs. If you choose Clean up disk-space once threshold is reached, enter a Threshold of Disk-Used in megabytes. For more information about the configuration options and how to configure a threshold, see Configuring Docker Images Disk-Cleanup Scheduling.

Enter a number in the Max Inflight Container Starts textbox. This number configures the maximum number of started instances across the Diego cells in your deployment. For more information about this feature, see Setting a Maximum Number of Started Containers.

Note: In a clean install, NFSv3 volume services is enabled by default. In an upgrade, NFSv3 volume services is set to the same setting as it was in the previous deployment.

(Optional) To configure LDAP for NFSv3 volume services, do the following:

For LDAP Service Account User, enter the username of the service account in LDAP that will manage volume services.

For LDAP Service Account Password, enter the password for the service account.

For LDAP Server Host, enter the hostname or IP address of the LDAP server.

For LDAP Server Port, enter the LDAP server port number. If you do not specify a port number, Ops Manager uses 389.

For LDAP User Fully-Qualified Domain Name, enter the fully qualified path to the LDAP service account. For example, if you have a service account named volume-services that belongs to organizational units (OU) named service-accounts and my-company, and your domain is named domain, the fully qualified path looks like the following:

CN=volume-services,OU=service-accounts,OU=my-company,DC=domain,DC=com

By default, PAS manages container images using the GrootFS plugin for Garden-runC. If you experience issues with GrootFS, you can disable the plugin and use the image plugin built into Garden-runC.

Select the Format of timestamps in Diego logs, either RFC3339 timestamps or Seconds since the Unix epoch. Fresh PAS v2.2 installations default to RFC3339 timestamps, while upgrades to PAS v2.2 from previous versions default to Seconds since the Unix epoch.

You can optionally modify the Default health check timeout. The value configured for this field is the amount of time allowed to elapse between starting up an app and the first healthy response from the app. If the health check does not receive a healthy response within the configured timeout, then the app is declared unhealthy. The default timeout is 60 seconds and the maximum configurable timeout is 600 seconds.

Click Save.

Step 8: Configure Application Developer Controls

Select Application Developer Controls.

Enter the Maximum File Upload Size (MB). This is the maximum size of an application upload.

Enter the Default App Memory (MB). This is the amount of RAM allocated by default to a newly pushed application if no value is specified with the cf CLI.

Enter the Default App Memory Quota per Org. This is the default memory limit for all applications in an org. The specified limit only applies to the first installation of PAS. After the initial installation, operators can use the cf CLI to change the default value.

Enter the Maximum Disk Quota per App (MB). This is the maximum amount of disk allowed per application.

Note: If you allow developers to push large applications, PAS may have trouble placing them on Cells. Additionally, in the event of a system upgrade or an outage that causes a rolling deploy, larger applications may not successfully re-deploy if there is insufficient disk capacity. Monitor your deployment to ensure your Cells have sufficient disk to run your applications.

Enter the Default Disk Quota per App (MB). This is the amount of disk allocated by default to a newly pushed application if no value is specified with the cf CLI.

Enter the Default Service Instances Quota per Org. The specified limit only applies to the first installation of PAS. After the initial installation, operators can use the cf CLI to change the default value .

Enter the Staging Timeout (Seconds). When you stage an application droplet with the Cloud Controller, the server times out after the number of seconds you specify in this field.

Select the Allow Space Developers to manage network policies checkbox to permit developers to manage their own network policies for their applications.

The Enable Service Discovery for Apps checkbox, which enables service discovery between applications, is enabled by default. To disable this feature, clear this checkbox. For more information about application service discovery, see the App Service Discovery section of the Understanding Container-to-Container Networking topic.

Step 10: Configure UAA

Select UAA.

(Optional) Under JWT Issuer URI, enter the URI that UAA uses as the issuer when generating tokens.

Under SAML Service Provider Credentials, enter a certificate and private key to be used by UAA as a SAML Service Provider for signing outgoing SAML authentication requests. You can provide an existing certificate and private key from your trusted Certificate Authority or generate a self-signed certificate. The following domain must be associated with the certificate: *.login.YOUR-SYSTEM-DOMAIN.

Note: The Pivotal Single Sign-On Service and Pivotal Spring Cloud Services tiles require the *.login.YOUR-SYSTEM-DOMAIN.

If the private key specified under Service Provider Credentials is password-protected, enter the password under SAML Service Provider Key Password.

(Optional) To override the default value, enter a custom SAML Entity ID in the SAML Entity ID Override field. By default, the SAML Entity ID is http://login.YOUR-SYSTEM-DOMAIN where YOUR-SYSTEM-DOMAIN is set in the Domains > System Domain field.

For Signature Algorithm, choose an algorithm from the dropdown menu to use for signed requests and assertions. The default value is SHA256.

(Optional) In the Global Login Session Max Timeout and Global Login Session Idle Timeout fields, change the maximum number of seconds before a global login times out. These fields apply to the following:

Default zone sessions: Sessions in Apps Manager, PCF Metrics, and other web UIs that use the UAA default zones

Identity zone sessions: Sessions in apps that use a UAA identity zone, such as a Single Sign-On service plan

(Optional) The Proxy IPs Regular Expression field contains a pipe-delimited set of regular expressions that UAA considers to be reverse proxy IP addresses. UAA respects the x-forwarded-for and x-forwarded-proto headers coming from IP addresses that match these regular expressions. To configure UAA to respond properly to Router or HAProxy requests coming from a public IP address, append a regular expression or regular expressions to match the public IP address.

Note: If you are performing an upgrade, do not modify your existing internal database configuration or you may lose data. You must migrate your existing data before changing the configuration. See Upgrading Pivotal Cloud Foundry for additional upgrade information, and contact Pivotal Support for help.

Internal Database Configuration

When you configure the UAA to use an internal MySQL database, it uses the type of database selected in the Databases pane, which can be one of two options. See Migrate to Internal Percona MySQL for details.

Select Internal MySQL.

Click Save.

Ensure that you complete the Configure Internal MySQL step later in this topic to configure high availability for your internal MySQL databases.

External Database Configuration

From the UAA section in Pivotal Application Service (PAS), select External.

For User Account and Authentication database username, specify a unique username that can access this specific database on the database server.

For User Account and Authentication database password, specify a password for the provided username.

Click Save.

Step 11: Configure CredHub

Note: Enabling CredHub is not required. However, you cannot leave the fields under Encryption Keys blank. If you do not intend to use CredHub, enter any text in the Name and Key fields as placeholder values.

Select CredHub.

Select Internal for your CredHub database. For GCP environments, Runtime CredHub has the following limitations:

Runtime CredHub only works if both the system databases and the CredHub database are set to Internal.

Under Encryption Keys, specify one or more keys to use for encrypting and decrypting the values stored in the CredHub database.

Name. This is the name of the encryption key.

If you plan to use internal encryption, enter any key name.

If you plan to use an HSM as your encryption provider, enter a key name that already exists on your HSM or a new key name.
For each new key name, CredHub generates a key in HSM Provider Partition that you configure below.

Provider. This is the provider of the encryption key.
If you plan to configure an HSM provider and HSM servers below, select HSM. Otherwise, select Internal.

Key. If you select internal encryption, this key is used for encrypting all data. The key must be at least 20 characters long.

If you selected Internal above, enter a randomly generated value under Key.

If you selected HSM above, enter a placeholder value under Key. CredHub does not use this key for encryption. However, you cannot leave the Key field blank.

Primary. This checkbox is used for marking the key you specified above as the primary encryption key. You must mark one key as Primary. Do not mark more than one key as Primary.

Step 12: Configure Authentication and Enterprise SSO

To authenticate user sign-ons, your deployment can use one of three types of user database: the UAA server’s internal user store, an external SAML identity provider, or an external LDAP server.

To use the internal UAA, select the Internal option and follow the instructions in the Configuring UAA Password Policy topic to configure your password policy.

To connect to an external identity provider through SAML, scroll down to select the SAML Identity Provider option and follow the instructions in the Configuring PCF for SAML section of the Configuring Authentication and Enterprise SSO for Pivotal Application Service (PAS) topic.

To connect to an external LDAP server, scroll down to select the LDAP Server option and follow the instructions in the Configuring LDAP section of the Configuring Authentication and Enterprise SSO for PAS topic.

Click Save.

Step 13: Configure System Databases

You can configure PAS to use Google Cloud SQL for the databases required by PAS.

Note: If you are performing an upgrade, do not modify your existing internal database configuration or you may lose data. You must migrate your existing data first before changing the configuration. Contact Pivotal Support for help. See Upgrading Pivotal Cloud Foundry for additional upgrade information.

Internal Database Configuration

Note: For GCP installations, Pivotal recommends selecting External and using Google Cloud SQL. Only use internal MySQL for non-production or test installations on GCP.

Note: To configure an external database for UAA, see the External Database Configuration section of Configure UAA.

WARNING: Protect whichever database you use in your deployment with a password.

To specify your PAS databases, perform the following steps:

Select the External Databases option.

In the Hostname field, enter the IP address of the Google Cloud SQL instance that you created in Step 6: Create Database Instance and Databases of the Preparing to Deploy Ops Manager on GCP Manually topic. You can obtain this address from the Instances dashboard of the SQL configuration page in the GCP Console.

In the TCP Port field, enter 3306.

Each component that requires a relational database has two corresponding fields: one for the database username and one for the database password. For each set of fields, specify the username that can access this specific database on the database server and a password for the provided username. You created these users in Preparing to Deploy Ops Manager on GCP Manually.

Click Save.

Step 14: (Optional) Configure Internal MySQL

Note: You only need to configure this section if you have selected Internal Databases - MySQL in the Databases section.

Select Internal MySQL.

In the MySQL Proxy IPs field, enter one or more comma-delimited IP addresses that are not in the reserved CIDR range of your network. If a MySQL node fails, these proxies re-route connections to a healthy node. See the MySQL Proxy topic for more information.

For MySQL Service Hostname, enter an IP address or hostname for your load balancer. If a MySQL proxy fails, the load balancer re-routes connections to a healthy proxy. If you leave this field blank, components are configured with the IP address of the first proxy instance entered above.

WARNING: You must configure a load balancer to achieve complete high availability.

In the Replication canary time period field, leave the default of 30 seconds or modify the value based on the needs of your deployment. Lower numbers cause the canary to run more frequently, which means that the canary reacts more quickly to replication failure but adds load to the database.

In the Replication canary read delay field, leave the default of 20 seconds or modify the value based on the needs of your deployment. This field configures how long the canary waits, in seconds, before verifying that data is replicating across each MySQL node. Clusters under heavy load can experience a small replication lag as write-sets are committed across the nodes.

(Required): In the E-mail address field, enter the email address where the MySQL service sends alerts when the cluster experiences a replication issue or when a node is not allowed to auto-rejoin the cluster.

To prohibit the creation of command line history files on the MySQL nodes, deselect the Allow Command History checkbox.

To allow the admin and roadmin to connect from any remote host, enable the Allow Remote Admin Access checkbox. When the checkbox is disabled, admins must bosh ssh into each MySQL VM to connect as the MySQL super user.

Note: Network configuration and Application Security Groups restrictions may still limit a client’s ability to establish a connection with the databases.

For Cluster Probe Timeout, enter the maximum amount of time, in seconds, that a new node will search for existing cluster nodes. If left blank, the default value is 10 seconds.

For Max Connections, enter the maximum number of connections allowed to the database.
If left blank, the default value is 1500.

For the Event types field, you can enter the events you want the MySQL service to log. By default, this field includes connect and query, which tracks who connects to the system and what queries are processed.

Enter values for the following fields:

Load Balancer Healthy Threshold: Specifies the amount of time, in seconds, to wait until declaring the MySQL proxy instance started. This allows an external load balancer time to register the instance as healthy.

Load Balancer Unhealthy Threshold: Specifies the amount of time, in seconds, that the MySQL proxy continues to accept connections before shutting down. During this period, the healthcheck reports as unhealthy to cause load balancers to fail over to other proxies. You must enter a value greater than or equal to the maximum time it takes your load balancer to consider a proxy instance unhealthy, given repeated failed healthchecks.

If you want to enable the MySQL interruptor feature, select the checkbox to Prevent node auto re-join. This feature stops all writes to the MySQL database if it notices an inconsistency in the dataset between the nodes. For more information, see the Interruptor section in the MySQL for PCF documentation.

Other IaaS Storage Options

Step 16: (Optional) Configure System Logging

You can configure system logging in PAS to forward log messages from PAS component VMs to an external service. Pivotal recommends forwarding logs to an external service for use in troubleshooting.

Note: The following instructions explain how to configure system logging for PAS component VMs. To forward logs from PCF tiles to an external service, you must also configure system logging in each tile. See the documentation for the given tiles for information about configuring system logging.

To configure system logging in PAS, do the following:

In the PAS Settings tab, select the System Logging pane. The following image shows the System Logging pane.

For Address, enter the IP address of the syslog server.

For Port, enter the port of the syslog server. The default port for a syslog server is 514.

Note: The host must be reachable from the PAS network and accept UDP or TCP connections. Ensure the syslog server listens on external interfaces.

For Transport Protocol, select a transport protocol for log forwarding.

For Encrypt syslog using TLS?, select Yes to use TLS encryption when forwarding logs to a remote server.

For Permitted Peer, enter either the name or SHA1 fingerprint of the remote peer.

For TLS CA Certificate, enter the TLS CA certificate for the remote server.

For Syslog Drain Buffer Size, enter the number of messages from the Loggregator Agent that the Doppler server can store before it begins to drop messages. See the Loggregator Guide for Cloud Foundry Operators topic for more details.

Disable the Include container metrics in Syslog Drains checkbox to prevent the CF Drain CLI plugin from including app container metrics in syslog drains. This feature is enabled by default.

Enable the Enable Cloud Controller security event logging checkbox to include security events in the log stream. This feature logs all API requests, including the endpoint, user, source IP address, and request result, in the Common Event Format (CEF).

Enable the Use TCP for file forwarding local transport checkbox to transmit logs over TCP. This prevents log truncation, but may cause performance issues.

Disable the Don’t Forward Debug Logs checkbox to forward DEBUG syslog messages to an external service. This checkbox is enabled by default.

Note: Some PAS components generate a high volume of DEBUG syslog messages.
Enabling the Don’t Forward Debug Logs checkbox prevents PAS components from forwarding the DEBUG syslog messages to external services. However, PAS still writes the messages to the local disk.

To configure Ops Manager for system logging, see the Settings section in the Using the Ops Manager Interface topic.

Step 17: (Optional) Customize Apps Manager

This section describes how to configure Custom Branding and Apps Manager to customize the appearance and
functionality of Apps Manager. For more information about the Custom Branding
configuration settings, see Custom Branding Apps
Manager.

Select Custom Branding. Use this section to configure the text, colors, and images of the interface that developers see when they log in, create an account, reset their password, or use Apps Manager.

Click Save to save your settings in this section.

Select Apps Manager.

Select Enable Invitations to enable invitations in Apps Manager. Space Managers can invite new users for a given space, Org Managers can invite new users for a given org, and Admins can invite new users across all orgs and spaces. See the Inviting New Users section of the Managing User Roles with Apps Manager topic for more information.

Select Display Marketplace Service Plan Prices to display the prices for your services plans in the Marketplace.

Enter the Supported currencies as JSON to appear in the Marketplace. Use the format { "CURRENCY-CODE": "SYMBOL" }. This defaults to { "usd": "$", "eur": "€" }.

Use Product Name, Marketplace Name, and Customize Sidebar Links to configure page names and sidebar links in the Apps Manager and Marketplace pages.

The Apps Manager Memory Usage (MB) field sets the memory limit with which to deploy the Apps Manager app. Use this field to increase the memory limit if the app fails to start with an out of memory error.

The Invitations Memory Usage (MB) field sets the memory limit with which to deploy the Invitations app. Use this field to increase the memory limit if the app fails to start with an out of memory error.

The Apps Manager Polling Interval field provides a temporary fix if Apps Manager usage degrades Cloud Controller response times. In this case, you can use this field to reduce the load on the Cloud Controller and ensure Apps Manager remains available while you troubleshoot the Cloud Controller. Pivotal recommends that you do not keep this field modified as a long term fix because it can degrade Apps Manager performance. You can optionally do the following:

Increase the polling interval above the default of 30 seconds.

Note: If you enter a value between 0 and 30, the field is automatically set to 30.

Step 18: (Optional) Configure Email Notifications

PAS uses SMTP to send invitations and confirmations to Apps Manager users. You must complete the Email Notifications page if you want to enable end-user self-registration.

Select Email Notifications.

Enter your reply-to and SMTP email information.

Note: For GCP, you must use port 2525. Ports 25 and 587 are not allowed on GCP Compute Engine.

Verify your authentication requirements with your email administrator and use the SMTP Authentication Mechanism dropdown to select None, Plain, or CRAMMD5. If you have no SMTP authentication requirements, select None.

If you selected CRAMMD5 as your authentication mechanism, enter a secret in the SMTP CRAMMD5 secret field.

Step 19: (Optional) Configure App Autoscaler

To use App Autoscaler, you must create an instance of the service and bind it to an app.
To create an instance of App Autoscaler and bind it to an app,
see Set Up App Autoscaler in the Scaling an Application Using App Autoscaler topic.

Click App Autoscaler.

Review the following settings:

Autoscaler Instance Count: How many instances of the App Autoscaler service you want to deploy.
The default value is 3.
For high availability, set this number to 3 or higher.
You should set the instance count to an odd number to avoid split-brain scenarios during leadership elections.
Larger environments may require more instances than the default number.

Autoscaler API Instance Count: How many instances of the App Autoscaler API you want to deploy.
The default value is 1.
Larger environments may require more instances than the default number.

Metric Collection Interval: How many seconds of data collection you want App Autoscaler to
evaluate when making scaling decisions.
The minimum interval is 60 seconds, and the maximum interval is 3600 seconds.
The default value is 120.
Increase this number if the metrics you use in your scaling rules are emitted less frequently than the existing Metric Collection Interval.

Scaling Interval: How frequently App Autoscaler evaluates an app for scaling.
The minimum interval is 15 seconds, and the maximum interval is 120 seconds.
The default value is 35.

Disable API Connection Pooling: API connection pooling increases performance by reducing the cost associated with establishing new connections. If you do not want to keep connections open for reuse, select this option.

Click Save.

Step 20: Configure Cloud Controller

Click Cloud Controller.

Enter your Cloud Controller DB Encryption Key if all of the following are true:

You deployed Pivotal Application Service (PAS) previously.

You then stopped PAS or it crashed.

You are re-deploying PAS with a backup of your Cloud Controller database.

For General Limit, enter the number of requests a user or client is allowed to make over an hour interval for all endpoints that do not have a custom limit. The default value is 2000.

For Unauthenticated Limit, enter the number of requests an unauthenticated client is allowed to make over an hour interval. The default value is 100.

Click Save.

Step 21: Configure Smoke Tests

The Smoke Tests errand runs basic functionality tests against your Pivotal Application Service (PAS) deployment after an installation or update. In this section, choose where to run smoke tests. In the Errands section, you can choose whether or not to run the Smoke Tests errand.

Select Smoke Tests.

If you have a shared apps domain, select Temporary space within the system organization, which creates a temporary space within the system organization for running smoke tests and deletes the space afterwards. Otherwise, select Specified org and space and complete the fields to specify where you want to run smoke tests.

Click Save.

Step 22: (Optional) Enable Advanced Features

The Advanced Features section of Pivotal Application Service (PAS) includes new functionality that may have certain constraints. Although these features are fully supported, Pivotal recommends caution when using them in production environments.

Diego Cell Memory and Disk Overcommit

If your apps do not use the full allocation of disk space and memory set in the Resource Config tab, you might want use this feature. These fields control the amount to overcommit disk and memory resources to each Diego Cell VM.

For example, you might want to use the overcommit if your apps use a small amount of disk and memory capacity compared to the amounts set in the Resource Config settings for Diego Cell.

Note: Due to the risk of app failure and the deployment-specific nature of disk and memory use, Pivotal has no recommendation about how much, if any, memory or disk space to overcommit.

To enable overcommit, do the following:

Select Advanced Features.

Enter the total desired amount of Diego cell memory value in the Cell Memory Capacity (MB) field. Refer to the Diego Cell row in the Resource Config tab for the current Cell memory capacity settings that this field overrides.

Enter the total desired amount of Diego cell disk capacity value in the Cell Disk Capacity (MB) field. Refer to the Diego Cell row in the Resource Config tab for the current Cell disk capacity settings that this field overrides.

Click Save.

Note: Entries made to each of these two fields set the total amount of resources allocated, not the overage.

Whitelist for Non-RFC-1918 Private Networks

Some private networks require extra configuration so that internal file storage (WebDAV) can communicate with other PCF processes.

The Whitelist for non-RFC-1918 Private Networks field is provided for deployments that use a non-RFC 1918 private network. This is typically a private network other than 10.0.0.0/8, 172.16.0.0/12, or 192.168.0.0/16.

Most PCF deployments do not require any modifications to this field.

To add your private network to the whitelist, do the following:

Select Advanced Features.

Append a new allow rule to the existing contents of the Whitelist for non-RFC-1918 Private Networks field.
Include the word allow, the network CIDR range to allow, and a semi-colon (;) at the end. For example:
allow 172.99.0.0/24;

Click Save.

CF CLI Connection Timeout

The CF CLI Connection Timeout field allows you to override the default five second timeout of the Cloud Foundry Command Line Interface (cf CLI) used within your PCF deployment. This timeout affects the cf CLI command used to push PAS errand apps such as Notifications, Autoscaler, and Apps Manager.

Set the value of this field to a higher value, in seconds, if you are experiencing domain name resolution timeouts when pushing errands in PAS.

To modify the value of the CF CLI Connection Timeout, perform the following steps:

Select Advanced Features.

Add a value, in seconds, to the CF CLI Connection Timeout field.

Click Save.

Log Cache

Log Cache is an in-memory caching layer for logs and metrics.
This Loggregator feature lets users filter and query logs through a CLI or API endpoints. Cached logs are available on demand.
For more information about Log Cache, see Enable Log Cache in the Configuring Logging in PAS topic.

To configure the Enable log-cache checkbox, do the following:

Select Advanced Features.

Select or deselect the Enable log-cache checkbox.

Click Save.

Database Connection Limits

You can configure the maximum number of concurrent database connections that diego and container networking components can have. Use the field beginning with Maximum number of open connections… for a given component. The placeholder values for each field are the default values.

When there are not enough connections available, such as during a time of heavy load, components may experience degraded performance and sometimes failure. To resolve or prevent this, you can increase and fine-tune database connection limits for the component.

WARNING: Decreasing the value of this field for a component may affect the amount of time it takes for it to respond to requests.

Step 23: Configure Errands

Errands are scripts that Ops Manager runs automatically when it installs or uninstalls a product, such as a new version of Pivotal Application Service (PAS). There are two types of errands: post-deploy errands run after the product is installed, and pre-delete errands run before the product in uninstalled.

By default, Ops Manager always runs all errands.

The PAS tile Errands pane lets you change these run rules. For each errand, you can select On to run it always or Off to never run it.

Note: Several errands, such as App Autoscaler and Notifications, deploy apps that provide services for your deployment. When one of these apps is running, selecting Off for the corresponding errand on a subsequent installation does not stop the app.

Apps Manager Errand deploys Apps Manager, a dashboard for managing apps, services, orgs, users, and spaces. Until you deploy Apps Manager, you must perform these functions through the cf CLI. After Apps Manager has been deployed, Pivotal recommends setting this errand to Off for subsequent PAS deployments. For more information about Apps Manager, see the Getting Started with the Apps Manager topic.

App Autoscaler Errand enables you to configure your apps to automatically scale in response to changes in their usage load. See the Scaling an Application Using Autoscaler topic for more information.

NFS Broker Errand enables you to use NFS Volume Services by installing the NFS Broker app in PAS. See the Enabling NFS Volume Services topic for more information.

Step 24: Configure Load Balancers

Navigate to the GCP Console and click Load balancing.

You should see the SSH load balancer, the HTTP(S) load balancer, the TCP WebSockets load balancer, and the TCP router that you created in the Preparing to Deploy Ops Manager on GCP topic.

Record the name of your SSH load balancer and your TCP WebSockets load balancer, MY-PCF-wss-logs and MY-PCF-ssh-proxy.

Click your HTTP(S) load balancer, MY-PCF-global-pcf.

Under Backend services, record the name of the backend service of the HTTP(S) load balancer, MY-PCF-http-lb-backend.

In the PAS tile, click Resource Config.

Under the LOAD BALANCERS column of the Router row, enter a comma-delimited list consisting of the name of your TCP WebSockets load balancer and the name of your HTTP(S) load balancer backend with the protocol prepended. For example, tcp:MY-PCF-wss-logs,http:MY-PCF-http-lb-backend.

Note: Do not add a space between key/value pairs in the LOAD BALANCER field or it will fail.

Note: If you are using HAProxy in your deployment, then enter the above load balancer values in the LOAD BALANCERS field of the HAProxy row instead of the Router row. For a high availability configuration, scale up the HAProxy job to more than one instance.

If you have enabled TCP routing in the Networking pane and set up the TCP Load Balancer in GCP, add the name of your TCP load balancer, prepended with tcp:, to the LOAD BALANCERS column of the TCP Router row. For example, tcp:pcf-tcp-router.

Enter the name of you SSH load balancer depending on which release you are using.

PAS: Under the LOAD BALANCERS column of the Diego Brain row, enter the name of your SSH load balancer prepended with tcp:. For example, tcp:MY-PCF-ssh-proxy.

Small Footprint Runtime: Under the LOAD BALANCERS column of the Control row, enter the name of your SSH load balancer prepended with tcp:.

Verify that the Internet Connected checkbox for every job is unchecked. When preparing your GCP environment, you provisioned a Network Address Translation (NAT) box to provide Internet connectivity to your VMs instead of providing them with public IP addresses to allow the jobs to reach the Internet.

Note: If you want to provision a Network Address Translation (NAT) box to provide Internet connectivity to your VMs instead of providing them with public IP addresses, deselect the Internet Connected checkboxes. For more information about using NAT in GCP, see the GCP documentation.

Click Save.

Step 25: (Optional) Scale Down and Disable Resources

Note: The Small Footprint Runtime does not default to a highly available configuration. It defaults to the minimum configuration. If you want to make the Small Footprint Runtime highly available, scale the Compute, Router, and Database VMs to 3 instances and scale the Control VM to 2 instances.

If you do not want a highly available resource configuration, you must scale down your instances manually by navigating to the Resource Config section and using the dropdowns under Instances for each job.

By default, PAS also uses an internal filestore and internal databases. If you configure PAS to use external resources, you can disable the corresponding system-provided resources in Ops Manager to reduce costs and administrative overhead.

To disable specific VMs in Ops Manager, do the following:

Click Resource Config.

If you configured PAS to use an external S3-compatible filestore, enter 0 in Instances in the File Storage field.

If you selected External when configuring the UAA, System, and CredHub databases, edit the following fields:

MySQL Proxy: Enter 0 in Instances.

MySQL Server: Enter 0 in Instances.

MySQL Monitor: Enter 0 in Instances.

If you disabled TCP routing, enter 0Instances in the TCP Router field.

If you are not using HAProxy, enter 0Instances in the HAProxy field.

Click Save.

Step 26: Download Stemcell

This step is only required if your Ops Manager does not already have the stemcell version required by PAS. For more information about importing stemcells, see Importing and Managing Stemcells.