Configuring Multi-Foundation Support in Apps Manager

This topic describes how to configure multi-foundation support in Apps Manager.

Overview

Configuring multi-foundation support in Apps Manager allows you to search, view, and manage orgs, spaces, apps, and service instances across multiple foundations from a single interface.

Configure Multi-Foundation Support

This section describes the procedures for configuring multi-foundation support in Apps Manager.

To configure multi-foundation support in Apps Manager, do the following:

  1. Configure PAS. See Configure PAS.
  2. Add redirects. See Add Redirects in UAA.
  3. Add trusted Certificate Authorities (CAs). See Add Trusted Certificate Authorities.
  4. (Optional) Configure the SAML Identity Provider. See (Optional) Configure the SAML Identity Provider.

Configure PAS

This section describes how to configure Pivotal Application Service (PAS) on a foundation to enable multi-foundation support in Apps Manager.

To configure multi-foundation support in Apps Manager, do the following:

  1. In the PAS tile of one of your foundations, select Apps Manager. The following image shows the Apps Manager pane. There is a heading at the top of the Apps Manager page that says, Configure Apps Manager. There are several fields on the Apps Manager page. The Multi-foundation Configuration field is the last field on the page. A Save button is at the bottom of the page.

  2. For Multi-foundation Configuration (BETA), enter a JSON object for each additional foundation that you want to manage. Use the following format for the JSON object:

    {
      "FOUNDATION_NAME": {
        "ccUrl": "https://api.FOUNDATION_SYSTEM_DOMAIN.com",
        "systemDomain": "FOUNDATION_SYSTEM_DOMAIN.com",
        "usageServiceUrl": "https://app-usage.FOUNDATION_SYSTEM_DOMAIN.com",
        "invitationsServiceUrl": "https://p-invitations.FOUNDATION_SYSTEM_DOMAIN.com",
        "logoutUrl": "https://login.FOUNDATION_SYSTEM_DOMAIN.com/logout.do",
        "metricsUrl": "https://metrics.FOUNDATION_SYSTEM_DOMAIN.com",
        "uaaUrl": "https://login.FOUNDATION_SYSTEM_DOMAIN.com"
      },
    }
    

    Where:

    • FOUNDATION_NAME is a name for the foundation.
    • FOUNDATION_SYSTEM_DOMAIN is the system domain of the foundation. The system domain is listed in the PAS tile Domains pane.
    • metricsUrl is an optional field. If PCF Metrics is installed on the foundation, provide the PCF Metrics URL.

Add Redirects in UAA

The Apps Manager UAA clients on each foundation you want to manage must include a redirect to the foundation on which you enabled multi-foundation support. This allows Apps Manager to redirect to the other foundations and back when authenticating with UAA. For more information about UAA clients and configuring valid redirect URIs, see Client.redirect-uri in UAA Concepts.

To add redirects, do the following:

  1. Install the UAA CLI. See CloudFoundry UAA Command Line Client in GitHub.
  2. Record the UAA admin client credentials password for a foundation you want to manage with Apps Manager:
    1. In the PAS tile Credentials tab, for Admin Client Credentials, click Link to Credentials.
    2. Record the value in the password field.
  3. Use the following command to target UAA on the foundation:

    uaac target uaa.FOUNDATION_SYSTEM_DOMAIN.com
    

    Where FOUNDATION_SYSTEM_DOMAIN is the system domain of the foundation.

  4. Use the following command to generate a token for the UAA admin client:

    uaac token client get admin -s ADMIN_CLIENT_PASSWORD
    

    Where ADMIN_CLIENT_PASSWORD is the Admin Client Credentials password you recorded in step 2.

  5. Record the UAA redirect URIs. Use the following command to view the redirect URIs on the UAA apps_manager_js client:

    uaac client get apps_manager_js
    
  6. Add the URI of the foundation on which you enabled multi-foundation support to the apps_manager_js client:

    uaac client update apps_manager_js --redirect_uri \
        'PREVIOUS_REDIRECT_URIS,https://apps.FOUNDATION_SYSTEM_DOMAIN.com/**'
    

    Where:

    • PREVIOUS_REDIRECT_URIS is one or more redirect URIs that you recorded in the previous step. Include the previous redirect URIs in the command to ensure they are not overwritten.
    • FOUNDATION_SYSTEM_DOMAIN is the system domain of foundation on which you enabled multi-foundation support.
  7. Repeat steps 2 through 6 for each foundation you want to manage with Apps Manager.

Add Trusted Certificate Authorities

Apps Manager must be able to validate the CAs used by all foundations.

If any foundation uses a certificate for TLS termination that is not signed by a globally-trusted CA, add the CA that signed the TLS certificate as a trusted CA on the foundation on which you enabled multi-foundation support.

For more information, see Setting Trusted Certificates.

(Optional) Configure the SAML Identity Provider

Pivotal recommends that all foundations use the same external SAML identity provider. This allows Apps Manager to automatically authenticate with the identity provider.

To configure all foundations to use the same SAML identity provider, do the following for each foundation:

  1. Navigate to the PAS tile UAA pane.
  2. Verify that the foundation uses the correct provider for Provider Name.

For more information on UAA and identity providers, see Identity Providers in UAA.

For more information on how to setup identity providers in UAA, see Adding Existing SAML or LDAP Users to a PCF Deployment.

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