Deploying PAS on AWS (Terraform)

Page last updated:

This topic describes how to install and configure Pivotal Application Service (PAS) on Amazon Web Services (AWS).

Before beginning this procedure, ensure that you have successfully completed the Configuring Ops Manager Director on AWS (Terraform) topic.

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: Add PAS to Ops Manager

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

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

    1. Click PAS to download the PAS .pivotal file
    2. Click PCF Small Footprint Runtime to download the Small Footprint Runtime .pivotal file. For more information, see Getting Started with Small Footprint Runtime.
  3. Navigate to the Pivotal Cloud Foundry Operations Manager Installation Dashboard.

  4. Click Import a Product to add your tile to Ops Manager. For more information, refer to the Adding and Deleting Products topic.

  5. Click the PAS tile in the Installation Dashboard.

    Er tile

Step 2: Assign Availability Zones and Networks

  1. Select Assign AZ and Networks.

  2. Select an Availability Zone under Place singleton jobs. Ops Manager runs any job with a single instance in this Availability Zone.

  3. Select all three Availability Zones under Balance other jobs. Ops Manager balances instances of jobs with more than one instance across the Availability Zones that you specify.

  4. From the Network drop-down box, choose the pcf-pas-network you created when configuring the Ops Manager Director tile. Er az

  5. Click Save.

    Note: When you save this form, a verification error displays because the PCF security group blocks ICMP. You can ignore this error.

    Er network error

Step 3: Configure Domains

  1. Select Domains.

    Domains

  2. Enter the system and application domains.

    • For System Domain, enter the value of sys_domain from the Terraform output. This defines your target when you push apps to PAS.
    • For Apps Domain, enter the value of apps_domain from the Terraform output. This defines where PAS should serve your apps.

    Note: You configured a wildcard DNS record for these domains in an earlier step.

  3. Click Save.

Step 4: Configure Networking

  1. Select Networking.
  2. 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 AWS with Elastic Load Balancers (ELBs).

    Note: You specify load balancers in the Resource Config section of Pivotal Application Service (PAS) later in the installation process. See the Configure Router to Elastic Load Balancer section of this topic for more information.

  3. 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.

    1. 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. Networking haproxy router cert config
      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.
    2. 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.

      For details about generating certificates in Ops Manager for your wildcard system domains, see the Providing a Certificate for Your SSL/TLS Termination Point topic.

  4. (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. Networking router haproxy ca

  5. In the Minimum version of TLS supported by HAProxy and Router field, select the minimum version of TLS to use in HAProxy and Router communications. HAProxy and Router 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. Networking min tls version

  6. 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. Networking xforwarded client cert xfcc 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.


    For a description of the behavior of each configuration option, see Forward Client Certificate to Applications.

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

    • 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.

  8. In the TLS Cipher Suites for Router field, specify the TLS cipher suites to use for TLS handshakes between the Gorouter and downstream clients like load balancers or HAProxy. Use an ordered, colon-delimited list of Golang-supported TLS cipher suites in the OpenSSL format. The recommended setting is ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384. Operators should verify that the ciphers are supported by any clients or downstream components that will initiate TLS handshakes with the Gorouter. For a list of TLS ciphers supported by the Gorouter, see Securing Traffic into Cloud Foundry. Networking tls router Verify that whatever client is participating in the TLS handshake with the Gorouter has at least one cipher suite in common with the Gorouter.

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

  9. In the TLS Cipher Suites for HAProxy field, specify the TLS cipher suites to use in HAProxy for TLS handshakes between HAProxy and its clients such as load balancers and Gorouter. Use an ordered, colon-delimited list of TLS cipher suites in the OpenSSL format. The recommended setting: DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384
    Operators should verify that the ciphers are supported by any clients or downstream components that will initiate TLS handshakes with the HAProxy. Networking tls haproxy Verify that whatever clients are participating in the TLS handshake with HAProxy have 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.

  10. Under HAProxy forwards requests to Router over TLS, select Enable or Disable based on your deployment layout. Networking haproxy router tls forward

    • Enable HAProxy forwarding of requests to Router over TLS
    If you want to: Encrypt communication between HAProxy and the Gorouter
    Then configure the following:
    1. Leave Enable selected.
    2. 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 CA endpoint in the Ops Manager API.

    3. 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.
    See also:
    • Disable HAProxy forwarding of requests to Router over TLS
    If you want to: Use non-encrypted communication between HAProxy and Gorouter, or you are not using HAProxy
    Then configure the following:
    1. Select Disable.
    2. If you are not using HAProxy, set the number of HAProxy job instances to 0 on the Resource Config page. See Disable Unused Resources.
    See also:

  11. 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.

  12. (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.
    Networking disable http haproxy gorouter

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

  14. (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.

  15. (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.

  16. 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. Isolate network Do not enable this option without deploying routers for each isolation segment. See the following topics for more information:
  17. (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 on enabling the PROXY protocol in Gorouter, see the HTTP Header Forwarding sections in the Securing Traffic in Cloud Foundry topic.

  18. In the Choose whether or not 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.

  19. (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. Networking max connections backend

  20. Enter a value for Router Max Idle Keepalive Connections See Considerations for Configuring max_idle_connections. Keepalive
  21. (Optional) To accommodate larger uploads over connections with high latency, increase the number of seconds in the Router Timeout to Backends field.

  22. (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, so Pivotal recommends a value greater than 600.
    Other Set the timeout value to be greater than that of the load balancer’s backend idle timeout.

  23. (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.

  24. (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.

    Router lb thresholds
  25. (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.

  26. Http Headers to Log
  27. 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.

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

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

  29. For Loggregator Port, you must enter 4443 In AWS deployments, port 4443 forwards SSL traffic that supports WebSockets from the ELB. Do not use the default port of 443
  30. For Container Network Plugin Interface, ensure Silk is selected and review the following fields: Cni silk

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

    1. (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.

    2. (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.

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

    4. 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.
    5. For UDP logging interval, set the per-second rate limit for UDP packets sent and received. This field defaults to 100.
    6. To enable logging for app traffic, select Log traffic for all accepted/denied application packets. See Manage Logging for Container-to-Container Networking for more information.
    7. By default, containers use the same DNS servers as the host. If you want to override the DNS servers to be used in containers, enter a comma-separated list of servers in DNS Servers.

      Note: If your deployment uses BOSH DNS, which is the default, you cannot use this field to override the DNS servers used in containers.

  31. TCP Routing is disabled by default. To enable this feature, perform the following steps:
    1. Select Enable TCP Routing
    2. In TCP Routing Ports enter a range of ports to be allocated for TCP Routes. If you configured AWS for PCF manually, enter 1024-1123 which corresponds to the rules you created for pcf-tcp-elb Configuration of this field is only applied on the first deploy, and update updates to the port range are made using the cf CLI. For details about modifying the port range, see the Router Groups topic. Ert tcp routing enable
    3. For AWS, you also need to specify the name of a TCP ELB in the LOAD BALANCER column of TCP Router job of the Resource Config screen. You configure this later on in PAS. For more information, see the Configure Router to Elastic Load Balancer topic.
  32. (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.

  33. Click Save

Step 5: Configure Application Containers

  1. Select Application Containers.

    Er config app containers

  2. 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.

  3. 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.

  4. If you want 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.

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

  6. 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.

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

  8. Under Enabling NFSv3 volume services, select Enable or Disable. NFS volume services allow application developers to bind existing NFS volumes to their applications for shared file access. For more information, see the Enabling NFS Volume Services topic.

    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.

  9. (Optional) To configure LDAP for NFSv3 volume services, perform the following steps: Er config app vol svc

    • 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 Server Protocol, enter the server protocol. If you do not specify a protocol, Ops Manager uses TCP.
    • 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
  10. 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.

  11. Click Save.

Step 6: Configure Application Developer Controls

  1. Select Application Developer Controls.

    App dev controls

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

  3. 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.

  4. 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.

  5. 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.

  6. 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.

  7. 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 .

  8. 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.

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

  10. Click Save.

Step 7: Review Application Security Groups

Setting appropriate Application Security Groups is critical for a secure deployment. Type X in the box to acknowledge that once the Pivotal Application Service (PAS) deployment completes, you will review and set the appropriate application security groups. See Restricting App Access to Internal PCF Components for instructions.

Asg

Step 8: Configure UAA

  1. Select UAA.

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

    Ert uaa jwt uri

  3. 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.

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

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

  6. (Optional) In the Apps Manager Access Token Lifetime, Apps Manager Refresh Token Lifetime, Cloud Foundry CLI Access Token Lifetime, and Cloud Foundry CLI Refresh Token Lifetime fields, change the lifetimes of tokens granted for Apps Manager and Cloud Foundry Command Line Interface (cf CLI) login access and refresh. Most deployments use the defaults. Authsso uaa bottom

  7. (Optional) Customize the text prompts used for username and password from the cf CLI and Apps Manager login popup by entering values for Customize Username Label (on login page) and Customize Password Label (on login page).

  8. (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 Gorouter or HAProxy requests coming from a public IP address, append a regular expression or regular expressions to match the public IP address.

  9. You can configure UAA to use the internal MySQL database provided with PCF, or you can configure an external database provider. Follow the procedures in either the Internal Database Configuration or the External Database Configuration section below.

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

  1. Select Internal MySQL.

UAA DB Selection

  1. Click Save.

  2. Ensure that you complete the “Configure Internal MySQL” step later in this topic to configure high availability and automatic backups for your internal MySQL databases.

External Database Configuration

Note: The exact procedure to create databases depends upon the database provider you select for your deployment. The following procedure uses AWS RDS as an example, but UAA also supports Azure SQL Server.

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

To create your UAA database, perform the following steps:

  1. Add the ubuntu account key pair from your IaaS deployment to your local SSH profile so you can access the Ops Manager VM. This is the value of the ops_manager_ssh_private_key from the Terraform output.

    $ ssh-add aws-keypair.pem
  2. SSH in to your Ops Manager using the Ops Manager FQDN and the username ubuntu:

    $ ssh ubuntu@OPS-MANAGER-FQDN
  3. Log in to your MySQL database instance using the appropriate hostname and user login values configured in your IaaS account. For example, to log in to your AWS RDS instance, run the following MySQL command:

    $ mysql --host=RDSHOSTNAME --user=RDSUSERNAME --password=RDSPASSWORD

  4. Run the following MySQL commands to create a database for UAA:

    CREATE database uaa;

  5. Type exit to quit the MySQL client, and exit again to close your connection to the Ops Manager VM.

  6. Reboot the RDS instance in the AWS console.

  7. From the UAA section in Pivotal Application Service (PAS), select External. Ert uaa external

  8. For Hostname, enter the hostname of the database server. This is the value from the rds_address key in the Terraform output.

  9. For TCP Port, enter the port of the database server. This is the value from the rds_port key in the Terraform output.

  10. For User Account and Authentication database username, specify the username that can access this database on the database server. This is the value from the rds_username key in the Terraform output.

  11. For User Account and Authentication database password, specify a password for the provided username. This is the value from the rds_password key in the Terraform output.

  12. Click Save.

Step 9: (Optional) Configure CredHub

  1. Select Credhub. Credhub
  2. Choose the location of your CredHub Database. PAS includes this CredHub database for services to store their service instance credentials.
    1. If you chose External, enter the following:
      • Hostname: The IP address of your database server. This is the value from the PcfRdsAddress key in the AWS output.
      • TCP Port: The port of your database server. This is the value from the PcfRdsPort key in the AWS output..
      • Username: The value from the PcfRdsUsername key in the AWS output.
      • Password: The value from the PcfRdsPassword key in the AWS output.
      • Database CA Certificate: Enter a certificate to use for encrypting traffic to and from the database.
  3. Under Encryption Keys, specify a key to use for encrypting and decrypting the values stored in the CredHub database.
    • Name: Enter the name of the key.
    • Key: Enter a key that is at least 20 characters in length.
    • Primary: Select this checkbox to use this key as your primary key.

      Note: Ensure that you only mark one key as Primary. The UI includes an Add button to add more keys to support key rotation. For more information, see the Rotating Runtime CredHub Encryption Keys topic.

  4. If your deployment uses any PCF services that support storing service instance credentials in CredHub and you want to enable this feature, select the Secure Service Instance Credentials checkbox.
  5. Select the Resource Config pane.
  6. Under the Job column of the CredHub row, set the number of instances to 2. This is the minimum instance count required for high availability.

Note: To use the runtime CredHub feature, you must follow the additional steps in Securing Service Instance Credentials with Runtime CredHub.

Step 10: Configure Authentication and Enterprise SSO

  1. Select Authentication and Enterprise SSO.

    Er config auth enterprise sso uaa

  2. 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.
  3. Click Save.

Step 11: Configure System Databases

You can configure PAS to use the internal MySQL database provided with PCF, or you can configure an external database provider 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. See Upgrading Pivotal Cloud Foundry for additional upgrade information.

Internal Database Configuration

If you want to use internal databases for your deployment, perform the following steps:

  1. Select Databases.

  2. Select Internal Databases - MySQL. Sys db

  3. Click Save.

Then proceed to Step 12: (Optional) Configure Internal MySQL to configure high availability and automatic backups for your internal MySQL databases.

Create External System Databases

If you want to use an external database provider for your PAS databases, you must first create the databases on the RDS instance provided by the Terraform templates.

To create the required databases on an AWS RDS instance, perform the following steps.

  1. Add the AWS-provided key pair to your SSH profile so that you can access the Ops Manager VM. This is the value of the ops_manager_ssh_private_key from the Terraform output.

    ssh-add aws-keypair.pem
  2. SSH in to your Ops Manager using the Ops Manager FQDN and the username ubuntu:

    ssh ubuntu@OPS_MANAGER_FQDN
  3. Run the following terminal command to log in to your RDS instance through the MySQL client, using values from the terraform output to fill in the following keys:

    mysql --host=rds_address --user=rds_username --password=rds_password

  4. Run the following MySQL commands to create databases for the seven PAS components that require a relational database:

    CREATE database ccdb;
    CREATE database notifications;
    CREATE database autoscale;
    CREATE database app_usage_service;
    CREATE database routing;
    CREATE database diego;
    CREATE database account;
    CREATE database nfsvolume;
    CREATE database networkpolicyserver;
    CREATE database silk;
    CREATE database locket;
    CREATE database credhub;
    

  5. Type exit to quit the MySQL client, and exit again to close your connection to the Ops Manager VM.

  6. Reboot the RDS instance in the AWS console.

  7. In PAS, select Databases.

  8. Select the External Databases option.

    Sys db

  9. For the Hostname and TCP Port fields, complete the following fields:

    PAS Field terraform output
    Hostname rds_address
    TCP Port rds_port

  10. For each database username and database password field, complete the following fields:

    PAS Field terraform output
    DATABASE-NAME database username rds_username
    DATABASE-NAME database password rds_password

  11. Click Save.

Step 13: (Optional) Configure Internal MySQL

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

  1. Select Internal MySQL.

  2. 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.

    Mysql config

  3. 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.

  4. 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.

  5. 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.

  6. (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.

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

  8. 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.

  9. 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.

    Mysql replication canary

  10. Under Automated Backups Configuration, select Disable automatic backups of MySQL.

    WARNING: Pivotal does not support restoring the internal MySQL database from a full backup because it degrades the Galera MySQL cluster. To backup and restore the internal MySQL database, you must use BOSH Backup and Restore (BBR). For more information on this issue, see the following Pivotal Knowledge Base article: Restore from PAS Automated Database Backup is Not Supported in 1.11 and later.

  11. If you want to log audit events for internal MySQL, select Enable server activity logging under Server Activity Logging.

    1. 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. For more information, see the Logging Events section of the MariaDB documentation.

      Server Activity Logging, Load Balancer Thresholds

  12. 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.
  13. 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.

  14. Click Save.

Step 14: Configure File Storage

To minimize system downtime, Pivotal recommends using highly resilient and redundant external filestores for your Pivotal Application Service (PAS) file storage.

When configuring file storage for the Cloud Controller in PAS, you can select one of the following:

  • Internal WebDAV filestore
  • External S3-compatible or Ceph-compatible filestore
  • External Google Cloud Storage
  • External Azure Cloud Storage

For production-level PCF deployments on AWS, Pivotal recommends selecting the External S3-Compatible File Store. For more information about production-level PCF deployments on AWS, see the Reference Architecture for Pivotal Cloud Foundry on AWS.

For additional factors to consider when selecting file storage, see the Considerations for Selecting File Storage in Pivotal Cloud Foundry topic.

Internal Filestore

Internal file storage is only appropriate for small, non-production deployments.

To use the PCF internal filestore, perform the following steps:

  1. In the Pivotal Application Service (PAS) tile, select File Storage.

  2. Select Internal WebDAV, and click Save.

External S3 or Ceph Filestore

To use an external S3-compatible filestore for your PAS file storage, perform the following steps:

  1. In the PAS tile, select File Storage. External filestore config
  2. Select the External S3-Compatible Filestore option and complete the following fields:

    • For URL Endpoint:
      1. In a browser, open the Amazon Simple Storage Service (Amazon S3) table.
      2. Prepend https:// to the Endpoint for your region and copy it into the Ops Manager URL Endpoint field.
        For example, in the us-west-2 region, use https://s3-us-west-2.amazonaws.com/.
    • For S3 Signature Version and Region, use the V4 Signature values. AWS recommends using Signature Version 4.
    • Select Server-side Encryption (available for AWS S3 only) to encrypt the contents of your S3 filestore. See the AWS S3 documentation for more information.
    • Complete the following fields:
      Ops Manager Field terraform output
      Buildpacks Bucket Name pas_buildpackets_bucket
      Droplets Bucket Name pas_droplets_bucket
      Packages Bucket Name pas_packages_bucket
      Resources Bucket Name pas_resources_bucket
      Access Key ID iam_user_access_key
      AWS Secret Key iam_user_secret_access_key

    Note: For more information regarding AWS S3 Signatures, see the Authenticating Requests documentation.

  3. Click Save.

Other IaaS Storage Options

Google Cloud Storage and Azure Storage are also available as file storage options, but are not recommended for typical PCF on AWS installations.

Step 15: (Optional) Configure System Logging

If you forward logging messages to an external Reliable Event Logging Protocol (RELP) server, complete the following steps:

  1. Select the System Logging section that is located within your PAS Settings tab. Updated system logging
  2. Enter the IP address of your syslog server in Address.
  3. Enter the port of your syslog server in Port. The default port for a syslog server is 514.

    Note: The host must be reachable from the PAS network, accept TCP connections, and use the RELP protocol. Ensure your syslog server listens on external interfaces.

  4. Select a Transport Protocol to use when forwarding logs.
  5. If you plan to use TLS encryption when sending logs to the remote server, select Yes when answering the Encrypt syslog using TLS? question.
    1. In the Permitted Peer field, enter either the name or SHA1 fingerprint of the remote peer.
    2. In the TLS CA Certificate field, enter the TLS CA Certificate for the remote server.
  6. For the Syslog Drain Buffer Size, enter the number of messages the Doppler server can hold from Metron agents before the server starts to drop them. See the Loggregator Guide for Cloud Foundry Operators topic for more details.
  7. If you want to include security events in your log stream, select the Enable Cloud Controller security event logging checkbox. This logs all API requests, including the endpoint, user, source IP address, and request result, in the Common Event Format (CEF).
  8. If you want to transmit logs over TCP, select the Use TCP for file forwarding local transport checkbox. This prevents log truncation, but may cause performance issues.
  9. If you want to specify a custom syslog rule, enter it in the Custom rsyslog Configuration field in RainerScript syntax. For more information about customizing syslog rules, see Customizing Syslog Rules.
  10. Click Save.

Step 16: (Optional) Customize Apps

The Custom Branding and Apps Manager sections customize the appearance and functionality of Apps Manager. Refer to Custom Branding Apps Manager for descriptions of the fields on these pages and for more information about customizing Apps Manager.

  1. 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. Custombranding

  2. Click Save to save your settings in this section.

  3. Select Apps Manager. Config apps man

  4. 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.

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

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

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

  8. Click Save to save your settings in this section.

Step 17: (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.

  1. Select Email Notifications.

    Smtp

  2. Enter your reply-to and SMTP email information.

  3. For SMTP Authentication Mechanism, select none.

  4. Click Save.

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.

Step 18: Configure Cloud Controller

  1. Click Cloud Controller.

    Config cc

  2. 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.

      See Backing Up Pivotal Cloud Foundry for more information.
  3. CF API Rate Limiting prevents API consumers from overwhelming the platform API servers. Limits are imposed on a per-user or per-client basis and reset on an hourly interval.

    To disable CF API Rate Limiting, select Disable under Enable CF API Rate Limiting. To enable CF API Rate Limiting, perform the following steps:

    1. Under Enable CF API Rate Limiting, select Enable.
    2. 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.
    3. For Unauthenticated Limit, enter the number of requests an unauthenticated client is allowed to make over an hour interval. The default value is 100.
  4. Click Save.

Step 19: 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.

  1. Select Smoke Tests.

  2. 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.

    Smoke test er config

  3. Click Save.

Step 20: (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, follow these steps:

  1. Select Advanced Features.

    Disk memory overcommit

  2. 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.

  3. 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.

  4. 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, perform the following steps:

  1. Select Advanced Features.

  2. Append a new allow rule to the existing contents of the Whitelist for non-RFC-1918 Private Networks field. Nonrfc whitelist 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;

  3. 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:

  1. Select Advanced Features.

  2. Add a value, in seconds, to the CF CLI Connection Timeout field. Cf cli connection timeout

  3. Click Save.

Step 21: 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 pre-delete errands, and only runs post-deploy errands when the product has changed since the last time Ops Manager installed something. In PAS, the Smoke Test Errand defaults to always run.

The PAS tile Errands pane lets you change these run rules. For each errand, you can select On to run it always, Off to never run it, or When Changed to run it only when the product has changed since the last install.

For more information about how Ops Manager manages errands, see the Managing Errands in Ops Manager topic.

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

Errands on

  • Smoke Test Errand verifies that your deployment can do the following:

    • Push, scale, and delete apps
    • Create and delete orgs and spaces
  • Usage Service Errand deploys the Pivotal Usage Service application, which Apps Manager depends on.

  • 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 deselecting the checkbox for this errand on subsequent PAS deployments. For more information about Apps Manager, see the Getting Started with the Apps Manager topic.

  • Notifications Errand deploys an API for sending email notifications to your PCF platform users.

    Note: The Notifications app requires that you configure SMTP with a username and password, even if you set the value of SMTP Authentication Mechanism to none.

  • Notifications UI Errand deploys a dashboard for users to manage notification subscriptions.

  • Pivotal Account Errand deploys Pivotal Account, a dashboard that allows users to create and manage their accounts. In the Pivotal Account dashboard, users can launch applications, manage their profiles, manage account security, manage notifications, and manage approvals. See the Enabling Pivotal Account topic for more information.

  • Autoscaling 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.

  • Autoscaling Registration Errand makes the Autoscaling service available to your applications. Without this errand, you cannot bind the Autoscaling app to your apps.

  • 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 22: Configure Router (or HAProxy) to Elastic Load Balancer

  1. In the PAS tile, click Resource Config. Er aws resource config

  2. Enter the name of you SSH load balancer depending on which release you are using. You can specify multiple load balancers by entering the names separated by commas.

    • Pivotal Application Service (PAS): In the ELB Name field of the Diego Brain row, enter the value of ssh_elb_name from the terraform output.
    • Small Footprint Runtime: In the ELB Name field of the Control row, enter the value of ssh_elb_name from the terraform output.
  3. In the ELB Name field of the Router row, enter the value of web_elb_name from the terraform otuput.

    Note: If you are using HAProxy in your deployment, then put the name of the load balancers in the ELB Name 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.

  4. In the ELB Name field of the TCP Router row, enter the value of tcp_elb_name from the terraform output.

  5. Click Save.

Step 23: (Optional) Scale Down and Disable Resources

Note: The Resource Config pane has fewer VMs if you are installing the Small Footprint Runtime.

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.

Pivotal Application Service (PAS) defaults to a highly available resource configuration. However, you may need to perform additional procedures to make your deployment highly available. See the Zero Downtime Deployment and Scaling in CF and the Scaling Instances in PAS topics for more information.

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 drop-down menus 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.

Complete the following procedures to disable specific VMs in Ops Manager:

  1. Click Resource Config.

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

  3. 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.
    • Backup Prepare Node: Enter 0 in Instances.
  4. If you disabled TCP routing, enter 0 Instances in the TCP Router field.

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

  6. Click Save.

Step 24: Download Stemcell

This step is only required if your Ops Manager does not already have the Stemcell version required by PAS.

  1. Select Stemcell.

  2. Log into the Pivotal Network and click on Stemcells.

  3. Download the appropriate stemcell version targeted for your IaaS.

  4. In Ops Manager, import the downloaded stemcell .tgz file.

    Stemcell 18

Step 25: Complete the PAS Installation

  1. Click the Installation Dashboard link to return to the Installation Dashboard.

  2. Click Apply Changes. If the following ICMP error message appears, click Ignore errors and start the install.

    Install error

    The install process generally requires a minimum of 90 minutes to complete. The image shows the Changes Applied window that displays when the installation process successfully completes.

    Ops manager complete

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