Understanding the Ops Manager Interface

Page last updated:

This topic describes key features of the Pivotal Cloud Foundry (PCF) Operations Manager interface.

Installation Dashboard Page

The Installation Dashboard is the central Ops Manager interface for managing your PCF deployment. It displays the BOSH Director configuration for your IaaS and product tiles for your PCF deployment.

The following screenshot shows the Installation Dashboard. Each section is labeled with a red letter. Click the image to see it at full size.

Screenshot of the Ops
                                 Manager Installation
                                 Dashboard. For a description
                                 of each labeled section, see
                                 the list below

The following list describes each labeled section of the Installation Dashboard:

  • AImport a Product: Click this button to add a new product to Ops Manager. You can download PCF-compatible product files from Pivotal Network. * If you have configured a Pivotal Network API token in the Settings section of Ops Manager, a list of the latest versions of already imported products appears automatically.

  • BDelete All Unused Products: Click this link to delete any unused products.

  • CInstallation Dashboard: Click this link to return to the Installation Dashboard page from other Ops Manager pages.

  • DStemcell Library: Click this link to open the Stemcell Library. In the Stemcell Library you can import stemcells, stage stemcells, and review your stemcell version numbers. For more information, see Importing and Managing Stemcells.

  • EChange Log: Click this link to view and search a log of your previous installations. See the Change Log Page section of this topic for details.

  • FUser Account Menu: Click the arrow next to your username to view the menu. Use this menu to navigate to your Settings page, view My Account to change your email and password, or log out of the Installation Dashboard. See My Account of this topic for details on account information. See the Settings Page section of this topic for details on available Ops Manager settings.

  • GRevert: Click the revert button to return to the previous successful installation. Any pending changes you have made to the current installation settings will be lost.

  • HReview Pending Changes: Click the button to go to the Review Pending Changes page, which organizes pending changes by tile. You are able to enable or disable each tile to selectively deploy individual tiles and their dependencies. For more information, see Reviewing Pending Product Changes.

  • IOrange Bar: Indicates that additional configuration for the product tile is required before deployment. Click the product tile to complete its configuration.

  • JMissing Stemcell Link: If an imported product is missing a required stemcell, a Missing Stemcell link appears on the tile. Click this link to open the Stemcell Library. For more information, see Importing and Managing Stemcells.

  • KAPI Docs: Click this link to go to the Ops Manager API documentation, which details how you can manage Ops Manager through the API rather than with the user interface. For more information about the Ops Manager API, see Using the Ops Manager API.

Change Log Page

Navigate to the Change Log page by clicking the corresponding link in the dashboard header. This page lets you view changes between current and past deployments.

The table columns display attributes associated with each deployment:

  • Started—The date and time, in UTC format, when the deployment began.

  • Finished—The date and time, in UTC format, when the deployment ended.

  • User—The user that initiated the deployment.

  • Added—The tiles that were newly added to the build.

  • Updated—The tiles that were changed from the previous build.

  • Deleted—The tiles that were removed from the previous build.

  • Unchanged—The tiles that were not changed between deployments.

  • Logs—A link to the Installation Log for the respective entry.

Using the Change Log Page

Configure the Change Log page by modifying the following fields:

  • Installation Dashboard—Click Installation Dashboard to return to Ops Manager’s Installation Dashboard. Alternatively, click the Back button in your web browser.

  • Show X entries—Click the number displayed in the Show X entries dropdown to choose between 10, 25, 50, and 100 entries.

  • Search—Type in the search box to sort the Change Log page by text or integer matches. As you type, matching entries appear on the screen.

  • Previous / Next—Click Previous, Next, or the number between them to load older or newer entries.

Settings Page

Navigate to the Settings page by clicking on your user name located at the upper right corner of the screen and selecting Settings.

The 'User account menu'
          page is indicated by a drop down arrow next to the logged in user account.
          The user account displays at the upper right corner of the Ops Manager
screen. As the first option of this menu, you can select 'Settings' to access the Settings
Page. Below 'Settings' you can access 'My Account' to view account information or 'Log
out' to log out of the existing user account.

The Settings configuration screen displays.

The 'Settings' page is
          indicated by a header that says 'Settings' in large type at the top of the
page. Below the header, on the left-hand side, there is a tabular layout. From top to
bottom, the tabs are 'Decryption Passphrase,' 'Authentication Method', 'SSL Certificate',
  'External API Access', 'Proxy Settings', 'Custom Banner,' 'Export Installation
Settings,' Syslog', and 'Advanced'. The top tab, 'Decryption Passphrase' is highlighted in
gray to indicate selection. To the right, the body shows fields that correspond to
'Decryption Passphrase.'

The following list describes each configuration pane:

Note: Modifying these settings does not require you to return to the Installation Dashboard and click Apply Changes. These settings apply to the Ops Manager VM. The BOSH Director does not apply them to your PCF deployment.

  • Decryption Passphrase: Reset your decryption passphrase.

  • Change Authentication Method to SAML: To change your Identity Provider (IdP) to SAML, configure the following fields:

    • Current Decryption Passphrase: Enter your decryption passphrase.
    • SAML IDP Metadata: Enter the full URL or XML SAML IdP metadata.
    • (Optional) BOSH IDP Metadata: Enter the full URL or XML BOSH IdP metadata. If left blank, the default is the same metadata as the field above.
    • SAML Admin Group: Enter the name of the SAML group that contains all of the Ops Manager administrators.
    • Groups Attribute: Enter the groups attribute tag name with which you configured the SAML server.
    • Provision an admin client in the Bosh UAA: Enable if you want to provision an admin client in the BOSH UAA. For more information, see Provision Admin Client in the Creating UAA Clients for BOSH Director topic.
  • Change Authentication Method to LDAP: Change your IdP to LDAP.

    For more information about changing your IdP to SAML or LDAP, view the following instructions for your IaaS configuration:

  • SSL Certificate: Configure Ops Manager to use a custom SSL certificate for all Ops Manager traffic both through the UI and API. If you leave the fields blank, Ops Manager uses an auto-generated self-signed certificate rather than your own custom certificate and private key.

    The 'Settings' page shows the 'SSL
      Certificate' pane highlighted on the left-hand tabular layout to
indicate selection. The body shows a header titled 'SSL Certificate' with help text
beneath and two required fields: 'Certificate' and 'Private key'. The 'Save' button is at
the bottom of the body.

  • External API Access: Enter your Pivotal Network API token to connect your Installation Dashboard to the Pivotal Network. To delete your Pivotal Network API token, the Pivotal Network release dashboard, and all tile metadata from Pivotal Network products, click Delete.

    The 'Settings' page shows the
          'External API' pane highlighted on the left-hand tabular layout to
indicate selection. The body shows a header titled 'Pivotal Network Settings' with help
text beneath and one field: 'Change API Token'. Two buttons, 'Save' and 'Delete', are at
the bottom of the body.

  • Proxy Settings: If you are using a proxy to connect to Ops Manager, update your Proxy Settings by providing a HTTP proxy, HTTPS proxy, or No proxy.

  • Custom Banner: Create a custom text banner to communicate important messages to operators. For UI Banner, enter the text you want to be shown on each page of the Ops Manager UI. For SSH Banner, enter the text that appears when an operator shells into Operations Manager.

    A teal banner sits at the top of the
          'Settings' page that says 'Attention: By entering text into the UI
Banner field, your message appears on every page of Ops Manager.' Below, the Settings page
shows the 'Custom Banner' pane highlighted in the tabulated menu to indicate selection. In
the body, from top to bottom, you find the 'Update Custom Banner' header with optional
text fields 'UI Bannner' and 'SSH Banner' beneath. The UI Banner field shows the exact
text shown in the teal banner. A 'Save' button is at the bottom of the body.

  • Export Installation Settings: Exports the current installation with all of its assets. When you export an installation, the exported file contains references to the base VM images, necessary packages, and configuration settings.

  • Syslog: Viewable by administrators only. Configure a custom Syslog server for Ops Manager. When you select Yes and fill the following fields, Ops Manager produces and sends all Ops Manager logs to the configured syslog endpoint.

  • Address - Enter the address or host of the syslog server.

    • Port - Enter the port on which the syslog server listens.
    • Transport Protocol - Select either TCP, UDP, or RELP to specify a transport protocol used to send syslog messages to your server.
    • Enable TLS (Optional) - Enable to send secure logs with TLS encryption. Once you Enable TLS, you must enter your Permitted Peer and SSL Certificate. Your Permitted Peer is either the accepted fingerprint such as a SHA1 or the name of the remote peer. For example, *.example.com.

      Note: Ops Manager does not issue a warning if your credentials are invalid. Instead, Ops Manager continues as if your credentials are correct. Test your syslog server to ensure that it is receiving Ops Manager logs.

    The Syslog pane is selected in the
          'Settings' page. In the body, the header says 'Syslog' with help
          text below and a series of Syslog-related fields and a 'Save'
          button.

  • Advanced:

    • Download activity data - Downloads a directory containing the config file for the installation, the deployment history, and version information.
    • Download Root CA Cert - Use this to download the root CA certificate of your deployment as an alternative to curling the Ops Manager API.
    • View diagnostic report - Displays various types of information about the configuration of your deployment.

My Account Page

To change your email and password, navigate to the My Account page by clicking on your user name located at the upper right corner of the screen and selecting My Account.

This example 'Account Settings' page shows
          two subheadings titled 'Profile' and 'Third Party Access'. Under 'Profile'
is an email 'admin@test.org' and an obscured password using asterisks. The email and
  password have two corresponding links to the right: 'Change Email' and 'Change
Password'. Under 'Third Party Access' is a paragraph that says 'You have not yet
authorized any third party applications.'

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