forked from anynines/docs-a9s-rabbitmq-old
-
Notifications
You must be signed in to change notification settings - Fork 0
/
installing.html.md.erb
177 lines (138 loc) · 8.86 KB
/
installing.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
---
title: Installing and Configuring a9s RabbitMQ for PCF
owner: Partners
---
<style>
.note.warning {
background-color: #fdd;
border-color: #fbb
}
.note.warning:before {
color: #f99;
}
</style>
This topic describes how to install and configure a9s RabbitMQ for Pivotal Cloud Foundry (PCF).
##<a id='prerequisites'></a> Prerequisites
Before installing a9s RabbitMQ for PCF, ensure that you have installed and configured the products and tiles listed in [Requirements](./index.html#reqs).
##<a id='install'></a> Install and Configure a9s RabbitMQ for PCF
To install a9s RabbitMQ for PCF, perform the following steps:
1. Download the product file from [Pivotal Network](https://network.pivotal.io/).
2. Navigate to the Ops Manager Installation Dashboard and click **Import a Product** to upload the product file.
3. Under the **Import a Product** button, click **+** next to the version number of a9s RabbitMQ for PCF.
This adds the tile to your staging area.
4. Click the newly added tile, and then click **Settings** to review the configuration settings.
See the following sections for more information on how to configure the properties on each settings pane:
* [Assign AZs and Networks](#azs)
* [Configure Errands](#errands)
* [Configure Service Plans](#configure-service-instance)
* [Configure Stemcells](#stemcell)
5. Click **Apply Changes** to deploy the service.
After you install a9s RabbitMQ for PCF, developers can access the service in the marketplace. See [Using a9s RabbitMQ for PCF](./using.html).
### <a id="azs"></a>Assign AZs and Networks
Use **Assign AZs and Networks** to configure the location of service instance jobs. Configure your network to balance cluster jobs across as many availability zones (AZs) as possible.
<%= image_tag("az-and-networks.png") %>
### <a id='errands'></a>Configure Errands
Use **Errands** to configure the BOSH errands used by a9s RabbitMQ for PCF. The list below describes each errand. For more information, see [Understanding Lifecycle Errands](https://docs.pivotal.io/tiledev/tile-errands.html).
<%= image_tag("a9s-rabbitmq-for-pcf-errands.png") %>
#### Post-Deployment Errands
* **Run BOSH Configurator**:
This errand configures a9s BOSH for PCF so that it can provision RabbitMQ
service instances. When enabled, this errand uploads the required
stemcells in the BOSH release. Disabling this errand may speed up the
deployment of all tiles.
<p class="note"><strong>Note</strong>: To ensure your configuration remains up-to-date, disable this errand only when necessary.</p>
* **Run Template Uploader**:
This errand is required to configure generic components that are included in a9s RabbitMQ for PCF with RabbitMQ configurations.
Disabling this errand may speed up the deployment of all tiles.
<p class="note"><strong>Note</strong>: To ensure your configuration remains up-to-date, disable this errand only when necessary.</p>
* **Run Broker Registrar**:
This errand registers the a9s RabbitMQ for PCF service broker
with Elastic Runtime. This makes the service available in the Elastic Runtime
marketplace.
* **Run Smoke Tests**:
This errand runs a series of basic tests against your a9s RabbitMQ for PCF
installation to ensure that it is configured properly. The tests can
take over 30 minutes.
#### Pre-Delete Errands
* **Delete all a9s RabbitMQ instances**:
This errand deletes all a9s RabbitMQ instances that were created with the `cf create-service` command by PCF end users.
<p class="note warning"><strong>Warning</strong>: This task cannot be undone. All VMs of the service instances are permanently deleted. If a service instance is bound to an app or service keys are existing, the errand fails.</p>
* **Run Broker Deregistrar**:
This errand unregisters the a9s RabbitMQ for PCF service broker in Elastic Runtime. It also removes the a9s RabbitMQ service from the Elastic Runtime marketplace.
###<a id="configure-service-instance"></a> Configure Service Plans
The sizes and types of VMs used to provision service instances of a given service plan are specified in **IaaS Settings** of the a9s BOSH for PCF tile.
<p class="note"><strong>Note</strong>: For information on cloud properties, see the <em>Cloud Config</em> section of the <a href="http://docs.pivotal.io/partners/a9s-bosh/installing.html">a9s BOSH for PCF installation documentation</a> that corresponds to your IaaS.</p>
See the table below for a summary of available service plans:
| This plan... | Uses these a9s BOSH for PCF settings to determine VM and disk size |
|------|-------|
|rabbitmq-single-small| Cloud properties for the VM Type Small<br /> Cloud properties for the Disk Type Small|
|rabbitmq-cluster-small| Cloud properties for the VM Type Small<br /> Cloud properties for the Disk Type Small|
|rabbitmq-single-big| Cloud properties for the VM Type Large<br /> Cloud properties for the Disk Type Big|
|rabbitmq-cluster-big| Cloud properties for the VM Type Large<br /> Cloud properties for the Disk Type Big|
###<a id="stemcell"></a>Configure Stemcells
If you want to use a stemcell other than the default, click **Stemcell**, and then click **Import Stemcell** to upload the stemcell.
<%= image_tag("stemcell-tab.png") %>
##<a id='deployment_updater'></a>Upgrade Existing Service Instances After a Tile Update
After updating the a9s RabbitMQ for PCF tile, run this errand to update the stemcell and all provisioned service instances to their latest version.
<p class="note"><strong>Note</strong>: anynines recommends running the <a href="./installing.html#errands" target="_blank">smoke tests</a> before running this errand.</p>
<p class="note"><strong>Note</strong>: To run the errand, you must know how to use the Ops Manager Director. For more information, see <a href="http://docs.pivotal.io/pivotalcf/1-9/customizing/trouble-advanced.html#prepare" target="_blank">Advanced Troubleshooting with the BOSH CLI</a>.</p>
1. SSH into Ops Manager:
<pre class="terminal">
$ ssh ubuntu@OPS-MANAGER-FQDN
Password: ***********
</pre>
2. Target the Ops Manager Director:
<pre class="terminal">
$ bosh --ca-cert /var/tempest/workspaces/default/root\_ca\_certificate target OPS-MANAGER-DIRECTOR-IP
Target set to DIRECTOR\_UUID
</pre>
3. Log in to the Ops Manager Director:
<pre class="terminal">
$ bosh login
Your username: director
Enter password: DIRECTOR\_CREDENTIAL
Logged in as 'director'
</pre>
4. Locate the a9s RabbitMQ for PCF deployment name:
<pre class="terminal">
$ bosh deployments
</pre>
The output should look similar to the following:
<pre class="terminal">
Acting as user 'director' on 'p-bosh'
+-------------------------------------------+-------------------------------+-------------
| Name | Release(s) | Stemcell(s)
+-------------------------------------------+-------------------------------+-------------
| a9s-bosh-a40c3b10d101faca4fbc | bosh-aws-cpi/53 | bosh-vsphere
| ...
+-------------------------------------------+-------------------------------+-------------
| a9s-consul-dns-3f3a49fb941f8c0874cb | consul/9 | bosh-vsphere
| ...
+-------------------------------------------+-------------------------------+-------------
| a9s-rabbitmq-service-94443f82b52dcf333bbd | bosh-configurator-rabbitmq/3 | bosh-vsphere
| ...
+-------------------------------------------+-------------------------------+-------------
</pre>
5. All deployment manifests are stored in the `/var/tempest/workspaces/default/deployments/` folder. Choose the `a9s-rabbitmq-service-...` deployment.
<pre class="terminal">
$ bosh deployment /var/tempest/workspaces/default/deployments/a9s-rabbitmq-service-94443f82b52dcf333bbd.yml
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 352 100 352 0 0 12014 0 --:--:-- --:--:-- --:--:-- 12137
Deployment set to '/var/tempest/workspaces/default/deployments/a9s-rabbitmq-service-94443f82b52dcf333bbd.yml'</pre>
6. Run `bosh run errand deployment-updater` to force a service instances update for all existing a9s RabbitMQ for PCF instances.
<pre class="terminal">
$ bosh run errand deployment-updater
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 352 100 352 0 0 26378 0 --:--:-- --:--:-- --:--:-- 27076
Acting as user 'director' on deployment 'a9s-rabbitmq-service-94443f82b52dcf333bbd' on 'p-bosh'
Director task 6533
Started preparing deployment > Preparing deployment. Done (00:00:01)
...
Errand 'deployment-updater' completed successfully (exit code 0)
</pre>
<p class="note"><strong>Note</strong>: Depending on the number of service instances, the Deployment Updater may take a significant amount of time to finish running. While the errand runs, BOSH shows no logging output from the errand.</p>