Using 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 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:

  • A— Displays a list of products you have imported that are ready for installation.

    • Click the Import a Product link to add a new product to Ops Manager.
    • If an upgrade is available, an active Upgrade button appears when you hover over the name of the product. If you are using the Pivotal Network API, the latest version of an existing product appears automatically.
    • Click Delete All Unused Products to delete any unused products.
  • BInstallation Dashboard: Displays a product tile for each installed product.

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

  • DSettings: This menu option opens a page with several configuration panes. See the Settings Page section of this topic for details.

  • EPending Changes view: Displays queued products and updates that will install during the next deploy. Click on a product to expand its list of errands and change the errand run rules for the next deploy. For more information, see Managing Errands in Ops Manager.

  • FApply Changes button: Click the button to apply pending changes, as listed, to your deployment. Click Change Log to view the logs of past installation updates.

  • GOrange bar: Indicates that additional configuration for the product tile is required before deployment. Click on the product tile to complete its configuration. In addition, the Apply Changes button is low lit to indicate that changes cannot be applied without additional product configuration.

  • HStemcell Library: Click the 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.

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

  • JReview Pending Changes BETA: 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. For more information, see Reviewing Pending Product Changes.

  • KAPI Docs: Click the 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 'Change Log' page is indicated by a header that says 'Change Log' at the top of the page. Directly below the header, on the left-hand side, there is a dropdown menu for selecting the number of entries in the current view. Directly below the header, on the right-hand side, there is a text field labeled 'Search' for searching the log for entries. Below the dropdown menu and Search field, there is a table. Each entry in the log is represented by a row in the table. The attributes of the each entry is represented by the columns. The columns are labeled, from left to right, as 'Started', 'Finished', 'User', 'Added', 'Updated', 'Deleted', 'Unchanged', and 'Logs'

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 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 following:

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', 
'External API Access', 'Proxy Settings', 'Export Installation
Settings,' 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 sections describe 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 by entering your current one and a new one.

The 'Decryption Passphrase' is
selected and highlighted in the tabular layout. This pane shows three text fields: Current decryption passphrase, New decryption passphrase, and New decryption passphrase confirmation'.
The fields are followed by an update button.

Authentication Method

You can switch Identity Providers by entering your Current Decryption Passphrase, SAML IDP Metadata, SAML Admin Group, Groups Attribute, and optionally, your BOSH IDP Metadata. For more information about setting up your SAML Identity Provider, view the following instructions for your configuration:

The 'Authentication Settings' is selected and highlighted in the tabular layout.
The pane shows five text fields, a checkbox, and a button that says 'Setup SAML'

External API Access

Enter your Pivotal Network API token to connect your Installation Dashboard to the Pivotal Network.

'External API Access' is selected and highlighted in the tabular layout. The pane shows a single
text field called 'Set API token' and a 'Save' button.

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.

'Proxy Settings' is selected and highlighed in the tabular layout. The pane shows
three text fields: 'Http proxy,' 'Https proxy', and 'No proxy.' At the bottom of the pane is an 'Update' button.

Custom Banner

Create a custom text banner to convey your identity or 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 Ops 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. 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.

'Export Installation Settings' are selected and highlighted in the tabular layout. 
The pane shows a warning icon with description text and an 'Export Instalation Settings' button. The warning says 'Upgrading Ops Manager
may block the upgrad epath for certain products.'

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.

  1. Select Syslog. Syslog bosh

  2. (Optional) Select Yes to send BOSH Director system logs to a remote server.

  3. In the Address field, enter the IP address or DNS name for the remote server.

  4. In the Port field, enter the port number that the remote server listens on.

  5. In the Transport Protocol dropdown menu, select TCP, UDP, or RELP. This selection determines which transport protocol is used to send the logs to the remote server.

  6. (Optional) Pivotal strongly recommends that you enable TLS encryption when forwarding logs as they may contain sensitive information. For example, these logs may contain cloud provider credentials. To enable TLS, perform the following steps.

    • In the Permitted Peer field, enter either the name or SHA1 fingerprint of the remote peer.
    • In the SSL Certificate field, enter the SSL certificate for the remote server.
  7. Click Save.

Advanced

The Advanced settings pane has the following buttons:

  • Download Activity Data - Downloads a directory containing the config file for the installation, the deployment history, and version information.

  • Download Root CA Cert - Downloads the root CA certificate of your deployment as an alternative to curling the Ops Manager API.

  • View diagnostic report - Displays information about your deployment configuration.

  • Delete this Installation

'Advanced' is selected and highlighted
in the tabular layout. The pane shows four blue buttons and one red button.
The four buttons are 'Download Activity Data', 'Download Root CA Cert', and
'View diagnostic report.' The red button is 'Delete this Installation'.

My Account Page

To change your email and password, navigate to the My Account page by clicking 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