forked from ystros/docs-ops-manager
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pcf-interface.html.md.erb
291 lines (218 loc) · 14.8 KB
/
pcf-interface.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
---
title: Using the Ops Manager Interface
owner: Ops Manager
---
This topic describes key features of the Ops Manager interface that is used
to manage [<%= vars.product_name %>](https://network.pivotal.io/products/pivotal-cf).
## <a id="installation-dashboard"></a> Installation Dashboard Page
The Installation Dashboard is the central Ops Manager interface for managing your <%= vars.product_name %>
deployment. It displays the BOSH Director configuration for your IaaS and product tiles
for your <%= vars.product_name %> 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 written in Omnigraffle. Edit in ./images/omnigraffle/interface.graffle %>
<a target="_blank" href="images/interface.png"><%= image_tag("interface.png", :alt =>
"Screenshot of the Ops
Manager Installation
Dashboard. For a description
of each labeled section, see
the list below") %></a>
The following list describes each labeled section of the Installation Dashboard:
- **A**---**Import a Product**: Click this button to add a new product to Ops Manager. You
can download <%= vars.product_name %>-compatible product files from
[VMware Tanzu Network](https://network.pivotal.io).
* If you have configured a [VMware Tanzu Network
API](../customizing/add-delete.html) token in the **Settings** section of Ops Manager, a
list of the latest versions of already imported products appears automatically.
- **B**---**Delete All Unused Products**: Click this link to delete any unused products.
- **C**---**Installation Dashboard**: Click this link to return to the **Installation
Dashboard** page from other Ops Manager pages.
- **D**---**Stemcell 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](../opsguide/managing-stemcells.html).
- **E**---**Change Log**: Click this link to view and search a log of your previous
installations. See the [Change Log Page](#changelog) section of this topic for details.
- **F**---**User 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](#account_settings) of this topic for details on account information. See the
[Settings Page](#settings) section of this topic for details on available Ops Manager
settings.
- **G**---**Revert**: 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.
- **H**---**Review 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](https://docs.pivotal.io/platform/2-7/customizing/review-pending-changes.html).
- **I**---**Orange Bar**: Indicates that additional configuration for the product tile is
required before deployment. Click the product tile to complete its configuration.
- **J**---**Missing 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](../opsguide/managing-stemcells.html).
- **K**---**API 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](https://docs.pivotal.io/platform/2-7/customizing/ops-man-api.html).
## <a id="changelog"></a> Change Log Page
Navigate to the **Change Log** page by clicking the corresponding link in the dashboard
header.
This page shows Ops Manager's deployment history, a record of all of its **Apply Changes** actions.
The table lists the following top-level attributes for each deployment:
<table id='TK-NAME' border="1" class="nice" >
<tr>
<th>Label</th>
<th>Type</th>
<th>Description</th>
</tr><tr>
<th>STATUS</th>
<td>Icon</td>
<td>Whether the deployment succeeded or failed</td>
</tr><tr>
<th>DEPLOYMENT ID</th>
<td>Text</td>
<td>A sequentially-numbered identifier for the deployment</td>
</tr><tr>
<th>USER</th>
<td>Username</td>
<td>The user who initiated the deployment</td>
</tr>
</table>
A **LOGS** button for each deployment opens the deployment's full Installation Log.
Within each deployment listing, a table details for the individual products deployed in or deleted from each installation.
The details listed for each product are as follows:
<table id='TK-NAME' border="1" class="nice" >
<tr>
<th>Label</th>
<th>Type</th>
<th>Description</th>
</tr><tr>
<th>PRODUCT</th>
<td>Text</td>
<td>The name of the product</td>
</tr><tr>
<th>ACTION</th>
<td>One of the following labels: <strong>ADDED</strong>, <strong>UPDATED</strong>, <strong>DELETED</strong>, <strong>NO CHANGES</strong>, <strong>FAILED</strong></td>
<td>The action, if any, that the deployment took with the product</td>
</tr><tr>
<th>STARTED</th>
<td>UTC timestamp</td>
<td>When Ops Manager began deploying the product</td>
</tr><tr>
<th>FINISHED</th>
<td>UTC timestamp</td>
<td>When Ops Manager stopped deploying or attempting to deploy the product</td>
</tr><tr>
<th>DURATION</th>
<td>Time, in minutes</td>
<td>How long Ops Manager took to deploy or attempt to deploy the product</td>
</tr>
</table>
A **Total** row, below the individual product rows, lists all-product totals for the **STARTED**, **FINISHED**, AND **DURATION** fields.
### <a id="changelog-using"></a> 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.
## <a id='settings'></a> 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**.
<%= image_tag("user_account_menu.png", :width => "500", :alt => "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 following section describes each configuration pane:
<p class="note"><strong>Note:</strong> Modifying these settings does not require you to
return to the Installation Dashboard and click <strong>Apply Changes</strong>. These
settings apply to the Ops Manager VM. The BOSH Director does not apply them to your <%= vars.product_name %>
deployment.</p>
### Change Decryption Passphrase
You can use the **Change Decryption Passphrase** pane to reset your decryption passphrase.
<%= image_tag("settings_menu.png", :width => "500", :alt => "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 'Change Decryption Passphrase,' 'SAML Settings', 'LDAP Settings', 'SSL Certificate', 'VMware Tanzu Network Settings,' 'Proxy Settings', 'Custom Banner', 'Export Installation Settings', 'Syslog', and 'Advanced Options'. The top tab, 'Change Decryption Passphrase' is highlighted in gray to indicate that it is selected. To the right, the body shows fields that correspond to 'Change Decryption Passphrase.'") %>
### Internal Authentication Settings
You can use the **Internal Authentication Settings** pane to view and update the settings for your internal authentication method.
This pane includes the following fields:
* **Current Decryption Passphrase**: Update the decryption passphrase for your internal authentication method.
* **Admin Username**: Update the username for the admin user.
* **Admin Password** and **Admin Password Confirmation**: Update the password for the admin user.
### SAML Settings
To change your Identity Provider (IdP) to SAML, configure the following fields:
<ul>
<li><strong>Current Decryption Passphrase</strong>: Enter your decryption passphrase.</li>
<li><strong>SAML IDP Metadata</strong>: Enter the full URL or XML SAML IdP metadata.</li>
<li><strong>BOSH IDP Metadata</strong>: (Optional) Enter the full URL or XML BOSH IdP metadata. If left blank, the default is the same metadata as the field above.</li>
<li><strong>SAML Admin Group</strong>: Enter the name of the SAML group that contains all of the Ops Manager administrators. This field is case-sensitive.</li>
<li><strong>Groups Attribute</strong>: Enter the groups attribute tag name with which you configured the SAML server. This field is case-sensitive.</li>
<li><strong>Provision an admin client in the Bosh UAA</strong>: Enable if you want to provision an admin client in the BOSH UAA. For more information, see <a href="https://docs.pivotal.io/platform/2-7/customizing/opsmanager-create-bosh-client.html#saml">Provision Admin Client</a> in the <em>Creating UAA Clients for BOSH Director</em> topic.</li>
</ul>
### LDAP Settings
Use this pane to change your IdP to LDAP.
For more information about changing your IdP to SAML or LDAP, view the following instructions for your IaaS configuration:
* Amazon Web Services. See [Configuring BOSH Director on AWS](../om/aws/config-manual.html).
* Google Cloud Platform. See [Configuring BOSH Director on GCP Manually](../om/aws/config-manual.html).
* Microsoft Azure. See [Configuring BOSH Director on Azure Manually](../om/azure/config-manual.html).
* OpenStack. See [Configuring BOSH Director on OpenStack](../om/openstack/config.html).
* vSphere. See [Configuring BOSH Director on vSphere](../om/vsphere/config.html).
### SSL Certificate
You can use the **SSL Certificate** pane to configure Ops Manager to use a custom SSL certificate for all Ops Manager traffic both through the UI and API.
This pane includes the following fields:
* **Certificate**: Enter a custom certificate.
* **Private Key**: Enter the private key for the certificate.
If you leave the fields blank, Ops Manager uses an auto-generated self-signed certificate rather than your own custom certificate and private key. If you wish to replace a custom certificate with a self-signed certificate, select **Revert to self-signed certificate**.
<%= image_tag("settings-ssl-cert.png", :alt => "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 an option to 'Revert to self-signed certificate' followed by help text and two required fields: 'Certificate' and 'Private key'. The 'Add Certificate' button is at the bottom of the body.") %>
### VMware Tanzu Network Settings
Enter your [VMware Tanzu Network
API](../customizing/add-delete.html#pivnet-api) token and click **Add Token** to connect your **Installation
Dashboard** to VMware Tanzu Network.
### 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.
### 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 syslog entries from the Ops Manager VM to the configured syslog endpoint. Ops Manager also sends BOSH Director
access events to the syslog endpoint.
<p class="note"><strong>Note:</strong> Ops Manager syslog entries are sent in RFC 3164 format.</p>
To configure a custom syslog endpoint for Ops Manager logs:
<%= partial(:"/common/syslog_bosh", :locals => { :syslog_context => 'Ops Manager' }) %>
### Advanced Options
<ul>
<li><strong>Download Activity Data</strong>: Downloads a directory containing the config
file for the installation, the deployment history, and version information.</li>
<li><strong>Download Root CA Cert</strong>: Use this to download the root CA certificate of your deployment as an alternative to curling the Ops Manager API.</li>
<li><strong>View Diagnostic Report</strong>: Displays various types of information about the configuration of your deployment.</li>
<li><strong>Delete This Installation</strong>: Deletes your Ops Manager installation permanently.</li>
</ul>
## <a id='account_settings'></a> 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**.
<%= image_tag("account_settings.png", :alt=> "This example 'Account Settings' page shows
two subheadings titled 'Profile' and 'Third Party Access'. Under 'Profile'
is an email '[email protected]' 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.'" ) %>
## <a id='support'></a> Support Page
Click **Support** in the footer of any page in Ops Manager to access the **Support** page.
The **Support** page allows you to download a ZIP file that includes Ops Manager logs, deployed manifests and configurations, and BOSH deployment diagnostics.
The contents of the ZIP file help Support more quickly address any issues in your deployment.