forked from pivotal-cf/docs-pcf-install
-
Notifications
You must be signed in to change notification settings - Fork 0
/
azure-om-config.html.md.erb
216 lines (136 loc) · 12.8 KB
/
azure-om-config.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
---
title: Configuring Ops Manager Director on Azure
owner: Ops Manager
---
<strong><%= modified_date %></strong>
<html class="list-style-none"></html>
This topic describes how to configure the Ops Manager Director for Pivotal Cloud Foundry (PCF) on Azure.
Before you perform the procedures in this topic, you must have completed the procedures in the [Preparing to Deploy PCF on Azure](azure-prepare-env.html) topic, and either the [Launching an Ops Manager Director Instance with an ARM Template](azure-arm-template.html) topic or the [Launching an Ops Manager Director Instance on Azure without an ARM Template](azure-om-deploy.html) topic.
After you complete the procedures in this topic, follow the instructions in the [Deploying Elastic Runtime on Azure](azure-er-config.html) topic.
<p class="note"><strong>Note</strong>: You can also perform the procedures in this topic using the Ops Manager API. For more information, see the <a href="ops-man-api.html">Using the Ops Manager API</a> topic.</p>
## <a id='access-om'></a>Step 1: Access Ops Manager ##
1. In a web browser, navigate to the fully qualified domain name (FQDN) of Ops Manager that you set up in either the [Launching an Ops Manager Director Instance with an ARM Template](azure-arm-template.html) topic or the [Launching an Ops Manager Director Instance on Azure without an ARM Template](azure-om-deploy.html) topic.
1. When Ops Manager starts for the first time, you must choose one of the following:
* [Use an Identity Provider](#idp): If you use an Identity Provider, an external identity server maintains your user database.
* [Internal Authentication](#internal): If you use Internal Authentication, PCF maintains your user database.
<%= image_tag("select-authentication.png") %>
### <a id='idp'></a>Use an Identity Provider (IdP) ###
<%= partial 'using_idp_ops_manager' %>
### <a id='internal'></a>Internal Authentication ###
1. When redirected to the **Internal Authentication** page, you must complete the following steps:
* Enter a **Username**, **Password**, and **Password confirmation** to create an Admin user.
* Enter a **Decryption passphrase** and the **Decryption passphrase confirmation**. This passphrase encrypts the Ops Manager datastore, and is not recoverable if lost.
* If you are using an **HTTP proxy** or **HTTPS proxy**, follow the instructions in the [Configuring Proxy Settings for the BOSH CPI](./pcf-director-proxy-settings.html) topic.
* Read the **End User License Agreement**, and select the checkbox to accept the terms.
* Click **Setup Authentication**.
<%= image_tag("om-login.png") %>
1. Log in to Ops Manager with the Admin username and password that you created in the previous step.
<%= image_tag("cf-login.png") %>
## <a id='azure-config'></a>Step 2: Azure Config Page ##
1. Click the **Ops Manager Director** tile.
<%= image_tag("azure/azure-om-tile.png") %>
1. Select **Azure Config**.
<%= image_tag("azure/azure-config.png") %>
1. Complete the following fields with information you obtained in the [Preparing to Deploy PCF on Azure](./azure-prepare-env.html) topic.
* **Subscription ID**: Enter the ID of your Azure subscription.
* **Tenant ID**: Enter your `TENANT_ID`.
* **Application ID**: Enter the `APPLICATION_ID` that you created in the [Create an Azure Active Directory Application](./azure-prepare-env.html#create-aad) step of the _Preparing to Deploy PCF on Azure_ topic.
* **Client Secret**: Enter your `CLIENT_SECRET`.
1. Complete the following fields:
* **Resource Group Name**: Enter the name of your resource group, which you exported as the `$RESOURCE_GROUP` environment variable.
* **BOSH Storage Account Name**: Enter the name of your storage account, which you exported as the `$STORAGE_NAME` environment variable.
1. For **Cloud Storage Type**, select one of the following options based on your Azure VM storage settings.
* **Use Managed Disks**: Select this option if you use Azure Managed Disks.
See [Azure Managed Disks Overview](https://docs.microsoft.com/en-us/azure/storage/storage-managed-disks-overview) in the
Microsoft documentation for more information. For **Storage Account Type**, select the storage option that corresponds with
your Azure subscription. Select **Standard_LRS** for HDD-based storage or **Premium_LRS** for SSD-based storage.
<%= image_tag("azure/azure-managed-disk.png") %>
* **Use Storage Accounts**: Select this option if you use storage accounts to store your Azure VMs.
Enter the base storage name that you used to create your deployment storage accounts, prepended and appended
with the wildcard character `*`. For example, if you created accounts named `xyzdeploymentstorage1`, `xyzdeploymentstorage2`,
and `xyzdeploymentstorage3`, enter `*deploymentstorage*`. Ops Manager requires
that you specify an asterisk at both the beginning and the end of the base storage account name.
<%= image_tag("azure/storage-accounts.png") %>
1. For **Default Security Group**, enter `pcf-nsg`.
<p class="note"><strong>Note</strong>: The Azure portal sometimes displays the names of resources with incorrect capitalization. Always use the Azure CLI to retrieve the correctly capitalized name of a resource.</p>
1. For **SSH Public Key**, copy and paste the contents of your public key in the `opsman.pub` file. You created this file in either the [Launching an Ops Manager Director Instance with an ARM Template](azure-arm-template.html) topic or the [Launching an Ops Manager Director Instance on Azure without an ARM Template](azure-om-deploy.html) topic.
1. For **SSH Private Key**, copy and paste the contents of your private key in the `opsman` file.
1. Click **Save**.
## <a id='director-config'></a>Step 3: Director Config Page ##
1. Select **Director Config**.
<%= image_tag("azure/director-config.png") %>
1. In the **NTP Servers (comma delimited)** field, enter a comma-separated list of valid NTP servers.
1. (Optional) Enter your **JMX Provider IP Address** if you are [Using JMX Bridge](use-metrics.html).
1. (Optional) Enter your **Bosh HM Forwarder IP Address** if you are using the BOSH HM Forwarder.
1. Select the **Enable VM Resurrector Plugin** checkbox to enable the Ops
Manager Resurrector functionality and increase Elastic Runtime availability.
1. Select **Enable Post Deploy Scripts** to run a post-deploy script after deployment. This script allows the job to execute additional commands against a deployment.
1. Select **Recreate all VMs** to force BOSH to recreate all VMs on the next deploy. This process does not destroy any persistent disk data.
1. Select **Enable bosh deploy retries** if you want Ops Manager to retry failed BOSH operations up to five times.
1. Select **Keep Unreachable Director VMs** if you want to preserve Ops Manager Director VMs after a failed deployment for troubleshooting purposes.
1. (Optional) Select **HM Pager Duty Plugin** to enable Health Monitor integration with PagerDuty.
<%= image_tag("images/director_hm_pager.png") %>
* **Service Key**: Enter your API service key from PagerDuty.
* **HTTP Proxy**: Enter an HTTP proxy for use with PagerDuty.
1. (Optional) Select **HM Email Plugin** to enable Health Monitor integration with email.
<%= image_tag("images/director_hm_email.png") %>
* **Host**: Enter your email hostname.
* **Port**: Enter your email port number.
* **Domain**: Enter your domain.
* **From**: Enter the address for the sender.
* **Recipients**: Enter comma-separated addresses of intended recipients.
* **Username**: Enter the username for your email server.
* **Password**: Enter the password password for your email server.
* **Enable TLS**: Select this checkbox to enable Transport Layer Security.
1. For **Blobstore Location**, Pivotal recommends that you keep **Internal** selected.
<%= image_tag("azure/blobstore.png") %>
1. For **Database Location**, Pivotal recommends that you keep **Internal** selected.
<%= image_tag("azure/database.png") %>
1. (Optional) **Director Workers** sets the number of workers available to execute Director tasks. This field defaults to `5`.
1. (Optional) **Max Threads** sets the maximum number of threads that the Ops Manager Director can run simultaneously. Pivotal recommends that you leave the field blank to use the default value unless doing so results in rate limiting or errors on your IaaS.
1. (Optional) To add a custom URL for your Ops Manager Director, enter a valid hostname in **Director Hostname**. You can also use this field to configure [a load balancer in front of your Ops Manager Director](https://discuss.pivotal.io/hc/en-us/articles/225420588).
<%= image_tag("director_workers.png") %>
1. Click **Save**.
## <a id='create-networks'></a>Step 4: Create Networks Page ##
1. Select **Create Networks**.
<%= image_tag("azure/create-networks.png") %>
1. Click **Add Network**.
1. Select **Enable ICMP checks** if you want to enable ICMP on your networks. Ops Manager uses ICMP checks to confirm that components within your network are reachable.
1. For **Name**, enter `default`.
1. If you want to dynamically provision VMs in this network for use with on-demand services, select the **Service Networks** checkbox. When the checkbox is selected, Ops Manager does not provision VMs within the specified CIDR range.
1. To create a subnet, complete the following fields:
* **Azure Network Name**: Enter `pcf-net/pcf`. You can use either the `NETWORK-NAME/SUBNET-NAME` format or the `RESOURCE-GROUP/NETWORK-NAME/SUBNET-NAME` format. If you specify a resource group, it must exist under the same subscription ID you provided in the [Azure Config](#azure-config) page.
<p class="note"><strong>Note</strong>: The Azure portal sometimes displays the names of resources with incorrect capitalization. Always use the Azure CLI to retrieve the correctly capitalized name of a resource.</p>
* **CIDR**: Enter `10.0.0.0/20`.
* **Reserved IP Ranges**: Enter the first 9 IP addresses of the subnet. For example, `10.0.0.1-10.0.0.9`.
* **DNS**: Enter `168.63.129.16`.
* **Gateway**: Enter the first IP address of the subnet. For example, `10.0.0.1`.
1. Click **Save**. If you do not have **Enable ICMP checks** selected, you may see red warnings which you can safely ignore.
## <a id='create-networks'></a>Step 5: Assign Networks Page ##
1. Select **Assign Networks**.
<%= image_tag("azure/assign-networks.png") %>
1. Under **Network**, select the `default` network you created from the dropdown menu.
1. Click **Save**.
## <a id='security'></a>Step 6: Security Page ##
1. Select **Security**.
<%= image_tag("om-security.png") %>
1. In **Trusted Certificates**, enter a custom Certificate Authority (CA) certificate to insert into your organization's certificate trust chain. This feature enables all BOSH-deployed components in your deployment to trust a custom root certificate. If you want to use Docker Registries for running app instances in Docker containers, use this field to enter the certificate for your private Docker Registry. See the [Using Docker Registries](../opsguide/docker-registry.html) topic for more information.
1. Choose **Generate passwords** or **Use default BOSH password**. Pivotal recommends that you use the **Generate passwords** option for greater security.
1. Click **Save**. To view your saved Director password, click the **Credentials** tab.
## <a id='syslog'></a>Step 7: Syslog Page
<%= partial 'syslog_bosh' %>
## <a id='resource-config'></a>Step 8: Resource Config Page
1. Select **Resource Config**.
<%= image_tag("azure/om-resource-config.png") %>
1. Ensure that the **Internet Connected** checkboxes are deselected for all jobs.
1. Adjust any values as necessary for your deployment. Under the **Instances**, **Persistent Disk Type**, and **VM Type** fields,
choose **Automatic** from the drop-down menu to allocate the recommended resources for the job. If the **Persistent Disk Type** field reads **None**, the job does not require persistent disk space.
<p class="note"><strong>Note</strong>: Ops Manager v1.11 requires a Director VM with at least 8 GB memory.</p>
<p class="note"><strong>Note</strong>: If you set a field to <strong>Automatic</strong> and the recommended resource allocation changes in a future version, Ops Manager automatically uses the updated recommended allocation.</p>
1. Click **Save**.
## <a id='complete-installation'></a>Step 9: Complete the Ops Manager Director Installation
1. Click **Apply Changes**. If a red ICMP error message appears and you have disabled ICMP, click
**Ignore errors and start the install**.
1. Ops Manager Director installs. This may take a few moments. When the installation process successfully completes, the **Changes Applied** window appears.
1. Click the **Installation Dashboard** link to return to the Installation Dashboard.
1. After you complete this procedure, follow the instructions in the [Configuring Elastic Runtime for Azure](azure-er-config.html) topic.