-
Notifications
You must be signed in to change notification settings - Fork 0
/
get-started-quickly.html
256 lines (256 loc) · 9.16 KB
/
get-started-quickly.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
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="description" content="JobStreamer : JobStreamer site."/>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/semantic-ui/2.1.8/semantic.min.css" type="text/css"/>
<link rel="stylesheet" href="css/basic.css" type="text/css"/>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/prism/1.5.0/themes/prism.css" type="text/css"/>
</head>
<body>
<div class="ui fixed inverted teal menu">
<div class="title item"><a href="./index.html"><b>Job Streamer</b></a></div>
</div>
<div/>
<div id="main_content_wrap" class="main ui grid content">
<div class="four wide column">
<div class="ui vertical fluid tabular menu">
<a class="item" href="get-started-quickly.html">
Getting Started
</a>
<div class="item">
<div class="header">Guide</div>
<div class="menu">
<a class="item" href="auth.html">
Authentication and authorization
</a>
<a class="item" href="deploy-batch-components.html">
Deploy batch components
</a>
<a class="item" href="create-a-job.html">
Create job
</a>
<a class="item" href="execute-the-job.html">
Execute job
</a>
<a class="item" href="schedule-job.html">
Schedule job
</a>
<a class="item" href="job-config.html">
Job config
</a>
<a class="item" href="notificator-config.html">
Notificator config
</a>
<a class="item" href="import-export.html">
Import and export
</a>
<a class="item" href="test-mode.html">
Test mode
</a>
<a class="item" href="healthcheck.html">
Healthcheck
</a>
</div>
</div>
<div class="item">
<div class="header">Components</div>
<div class="menu">
<a class="item" href="control-bus.html">
Control bus
</a>
<a class="item" href="agent.html">
Agent
</a>
<a class="item" href="console.html">
Management console
</a>
<a class="item" href="notificator.html">
Notificator
</a>
</div>
</div>
<div class="item">
<div class=" header">For contributers</div>
<div class="menu">
<a class="item" href="get-started-developer.html">
Getting Started for contributers
</a>
<a class="item" href="developer-guide.html">
Developer guide for contributers
</a>
</div>
</div>
</div> </div>
<div class="twelve wide stretched column">
<h1><a href="#getting-started" name="getting-started">Getting Started</a></h1><h2><a href="#control-bus" name="control-bus">Control bus</a></h2>
<ol>
<li><p>Get <a href="https://my.datomic.com/downloads/free">datomic-free</a></p>
<pre><code>% unzip datomic-free-0.9.5394.zip
% cd datomic-free-0.9.5394
% bin/transactor config/samples/free-transactor-template.properties
</code></pre></li>
<li><p>Get the latest <a href="https://github.com/job-streamer/job-streamer-control-bus/releases/latest">Control-bus</a></p></li>
<li><p>Run the contorl bus</p>
<pre><code>% bin/control_bus
</code></pre></li>
<li><p>Environment settings</p></li>
</ol>
<table>
<thead>
<tr>
<th align="left">Environment variable </th>
<th align="left">Description </th>
<th align="left">Default value </th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">CONTROL_BUS_PORT </td>
<td align="left">Port number </td>
<td align="left">45102 </td>
</tr>
<tr>
<td align="left">DISCOVERY_PORT </td>
<td align="left">Port number to listen agent request </td>
<td align="left">45100 </td>
</tr>
<tr>
<td align="left">DISCOVERY_ADDRESS </td>
<td align="left">Multicast IP to listen agent request </td>
<td align="left">(OPTION) </td>
</tr>
<tr>
<td align="left">NOTIFICATOR_URL </td>
<td align="left">Notificator URL </td>
<td align="left"><a href="http://localhost:2121">http://localhost:2121</a> </td>
</tr>
<tr>
<td align="left">ACCESS_CONTROL_ALLOW_ORIGIN </td>
<td align="left">Console URL used by operators </td>
<td align="left"><a href="http://localhost:3000">http://localhost:3000</a> </td>
</tr>
<tr>
<td align="left">CONTROLE_BUS_RESOURCE_PATH </td>
<td align="left">Resource path </td>
<td align="left">(OPTION) </td>
</tr>
</tbody>
</table><h2><a href="#console" name="console">Console</a></h2>
<ol>
<li><p>Get the latest <a href="https://github.com/job-streamer/job-streamer-console/releases/latest">Console</a></p></li>
<li><p>Run the console</p>
<pre><code>% bin/console
</code></pre></li>
<li><p>Environment settings</p></li>
</ol>
<table>
<thead>
<tr>
<th align="left">Environment variable </th>
<th align="left">Description </th>
<th align="left">Default value </th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">CONSOLE_PORT </td>
<td align="left">Port number </td>
<td align="left">3000 </td>
</tr>
<tr>
<td align="left">CONTROL_BUS_URL </td>
<td align="left">Control-bus URL </td>
<td align="left"><a href="http://localhost:45102">http://localhost:45102</a> </td>
</tr>
</tbody>
</table><h2><a href="#agent" name="agent">Agent</a></h2>
<ol>
<li><p>Get the latest <a href="https://github.com/job-streamer/job-streamer-agent/releases/latest">Agent</a></p></li>
<li><p>Run the agent</p>
<pre><code>% bin/agent
</code></pre></li>
<li><p>Environment settings</p></li>
</ol>
<table>
<thead>
<tr>
<th align="left">Environment variable </th>
<th align="left">Description </th>
<th align="left">Default value </th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">AGENT_PORT </td>
<td align="left">Port number </td>
<td align="left">4510 </td>
</tr>
<tr>
<td align="left">INSTANCE_NAME </td>
<td align="left">Instance name<br> Specify this if you want to fix it between each start-ups. </td>
<td align="left">(OPTION) </td>
</tr>
<tr>
<td align="left">DISCOVERY_PORT </td>
<td align="left">Port number for multicast or broadcast </td>
<td align="left">45100 </td>
</tr>
<tr>
<td align="left">DISCOVERY_ADDRESS </td>
<td align="left">IP address for multicast<br>Specify this if you run multiple control-buses on the same network area. </td>
</tr>
<tr>
<td align="left">AGENT_RESOURCE_PATH </td>
<td align="left">Resource path </td>
<td align="left">(OPTION) </td>
</tr>
</tbody>
</table><h2><a href="#notificator" name="notificator">Notificator</a></h2>
<ol>
<li><p>Get the latest <a href="https://github.com/job-streamer/job-streamer-notificator/releases/latest">Notificator</a></p></li>
<li><p>Run the notificator</p>
<pre><code>% bin/notificator [setting edn file path] [directory path where hbs files exist]
</code></pre></li>
<li><p>Environment settings</p></li>
</ol>
<table>
<thead>
<tr>
<th align="left">Environment variable </th>
<th align="left">Description </th>
<th align="left">Default value </th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">NOTIFICATOR_PORT </td>
<td align="left">Port number </td>
<td align="left">2121 </td>
</tr>
</tbody>
</table>
<blockquote><p>Please refet tr <a href="./notificator-config.html">notificator config</a> about edn/hbs files.</p>
</blockquote><h2><a href="#deploy-batch-components" name="deploy-batch-components">Deploy batch components</a></h2><p>Please refer to <a href="./deploy-batch-components.html">Deploy batch components</a>.</p><h2><a href="#set-logger" name="set-logger">Set logger</a></h2><p>Set environment variables, CONTROL_BUS_RESOURCE_PATH and AGENT_RESOURCE_PATH and place <a href="https://logback.qos.ch/manual/configuration_ja.html">logback.xml</a> in there if you want to set logger.</p>
</div>
</div>
<div class="ui inverted teal footer vertical segment">
<div class="container">
<div class="ui stackable divided relaxed grid">
<div class="sixteen wide column">
<p>Copyright @ 2015-2016 kawasima & contributors.</p>
<p>Released under the EPL license.</p>
</div>
</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/jquery/1.12.3/jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/prism/1.5.0/prism.js"></script>
<script src="https://cdn.jsdelivr.net/prism/1.5.0/components/prism-java.min.js"></script>
<script src="https://cdn.jsdelivr.net/prism/1.5.0/components/prism-bash.min.js"></script>
<script src="https://cdn.jsdelivr.net/prism/1.5.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/semantic-ui/2.1.8/semantic.min.js"> </script>
</body>
</html>