-
Notifications
You must be signed in to change notification settings - Fork 4
/
readme.html
49 lines (43 loc) · 2.58 KB
/
readme.html
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
<html>
<head/>
<body>
<div style="font-family:courier;position:fixed;background-color:black;color:white;top:0;left:0;padding:10px 10px 10px 10px;width:100%;">
<table style="color:white;width:100%;padding:0px 50px 0px 0px;text-decoration:none">
<tr>
<td align="right" color="#FFFFCE">
<a href="index.html" target="" style="color:#FFFFCE;text-decoration:none;">Root</a>
|
<a href="http://github.com/nkaviani/cloudfoundry-bluedocs" target="_blank" style="color:#FFFFCE;text-decoration:none;">
IBM BlueDocs v-0.2 <img src="cf-v1/assets/link_ext.gif"/>
</a>
</td>
</tr>
</table>
</div>
<div style="margin:20;padding-top:30px;">
<h1>BlueDocs Documentation for CloudFoundry</h1>
The documentation contains information on two sets of data for CloudFoundry v1.0 and CloudFoundry v2.0 as collected by our BlueDocs message analysis tool:
<ul>
<li> NATS message content / publishers / subscribers to different NATS channels</li>
<li> Sequence of NATS message exchanges for each <i>cf</i> or <i>vmc</i> command as perceived by our analyzer tool</li>
</ul>
<h2> NATS Message Content</h2>
Message contents are captured by instrumenting the NATS client for each of the CloudFoundry components, intercepting in-going and out-going messages for each component, and analyzing the internals of the messages. <br/>
The documentation contains the following information:
<ul>
<li>The list of channels over which CloudFoundry components communicate</li>
<li>Content of messages exchanged over each channel, i.e., the list of keys in the message and their content types</li>
<li>List of publishers to each channel</li>
<li>List of subscribers to each channel</li>
</ul>
<h2> NATS Message Sequences</h2>
NATS message sequences contain informatioin on the set of applicable commands for <i>cf</i> or <i>vmc</i> and the series of messages exchanged during execution of each of those messages. Each sequence diagram captures the following information:
<ul>
<li>The source and the destination of a NATS message captured during execution of the CF command (shown with an arrow -->)</li>
<li>The channel over which the message is sent</li>
<li>The content of the message communicated over the channel</li>
</ul>
For better readability the message content and the source and target of each message exchange are hidden in the initial view of the diagram. In order to get the detailed view, the mouse can be hovered over the (+) sign or the (+) sign can be clicked to see the extended information.
</div>
<a href="index.html">Back</a>
</body>