forked from jasonkeene/docs-rabbitmq-staging
-
Notifications
You must be signed in to change notification settings - Fork 0
/
troubleshoot-instances.html.md.erb
139 lines (91 loc) · 4.61 KB
/
troubleshoot-instances.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
---
title: Troubleshooting On-Demand Instances
owner: London Services
---
This topic provides basic instructions for app developers troubleshooting on-demand <%= vars.product_full %> instances.
## <a id="errors"></a> Troubleshoot Errors
Start here if you are responding to a specific error or error messages.
### <a id="common-errors"></a> Common Service Errors
The following errors occur in multiple services:
<%# The below partial is in https://github.com/pivotal-cf/docs-partials %>
<%= partial vars.path_to_partials + '/services-tshoot/tshoot-no-metrics' %>
## <a id="techniques"></a> Techniques for Troubleshooting
See the following sections for troubleshooting techniques when using
the Cloud Foundry Command-Line Interface (cf CLI) to perform basic
operations on a <%= vars.product_short %> service instance.
Basic cf CLI operations include `create`, `update`, `bind`, `unbind`, and `delete`.
### <a id="parse-error"></a>Parse a Cloud Foundry (CF) Error Message
<%# The below partial is in https://github.com/pivotal-cf/docs-partials %>
<%= partial vars.path_to_partials + '/services-tshoot/tshoot-tech-parse-error' %>
### <a id="instance"></a> Retrieve Service Instance Information
1. Log into the space containing the instance or failed instance:
```
cf login
```
1. If you do not know the name of the service instance, run `cf services` to see a listing of all service instances in the space.
The service instances are listed in the `name` column, for example:
<pre class="terminal">
$ cf services
Getting services in org my-org / space my-space as user<span>@</span>example.com...
OK
name service plan bound apps last operation
my-instance p.rabbitmq single-node create succeeded
</pre>
1. To retrieve more information about a specific instance, run:
```
cf service SERVICE-INSTANCE-NAME
```
1. To retrieve the GUID of the instance, which is useful for debugging, run:
```
cf service SERVICE-INSTANCE-NAME --guid
```
### <a id="management-ui-credentials"></a> Retrieve <%= vars.product_short %> Service Instance Credentials
To access the RabbitMQ Management UI for troubleshooting,
create a new service-key to retrieve <%= vars.product_short %> service instance credentials.
VMware recommends that you use this key for troubleshooting only, and that you
delete the key after troubleshooting.
<p class="note">
<strong>Note:</strong> If OAuth is enabled, you log in to the RabbitMQ Management UI using your
<%= vars.app_runtime_abbr %> credentials. For more information, see
<a href="./managing.html#ui-with-oa">Access RabbitMQ Management UI with OAuth Enabled</a>.
</p>
To retrieve the credentials, do the following:
1. Create a service-key for your <%= vars.product_short %> service instance by running:
```
cf create-service-key INSTANCE-NAME SERVICE-KEY-NAME
```
1. Retrieve the credentials by running:
```
cf service-key INSTANCE-NAME SERVICE-KEY-NAME
```
1. Navigate to the RabbitMQ Management UI using the URL from the service key.
For example:
<pre class="terminal">
$ cf create-service-key my-rmq-instance my-key
Creating service key my-key for service instance my-rmq-instance as admin...
OK
$ cf service-key my-rmq-instance my-key
Getting key my-key for service instance my-rmq-instance as admin...
{
"dashboard_url": "https<scan>:</scan>//rmq-62e5ab21-7b38-44ac-b139-6aa97af01cd7.your.pcf.example.com",
...
}
</pre>
To gain admin privileges for the RabbitMQ Management UI, create an admin user for a service instance and obtain user credentials that you can share with other app developers.
Both operators and app developers can use this procedure. See [Create an Admin User for a Service Instance](./install-config.html#admin-service-key) for more information.
### <a id="delete_rabbitmq_instance"></a>Delete <%= vars.product_short %> Service Instances
The on-demand broker provides a BOSH command to delete all on-demand broker deployed service instances.
<p class="note warning"><strong>Warning:</strong>
This command deletes deployment instances serially. It is very destructive and cannot be undone.
</p>
To delete all on-demand service instances:
1. Run:
```
bosh run-errand delete-sub-deployments
```
## <a id="kb"></a>Knowledge Base (Community)
<%# The below partial is in https://github.com/pivotal-cf/docs-partials %>
<%= partial vars.path_to_partials + '/services-tshoot/tshoot-kb' %>
## <a id="support"></a>File a Support Ticket
<%# The below partial is in https://github.com/pivotal-cf/docs-partials %>
<%= partial vars.path_to_partials + '/services-tshoot/tshoot-support-dev' %>