-
Notifications
You must be signed in to change notification settings - Fork 10
/
getting_started.html
331 lines (217 loc) · 14.3 KB
/
getting_started.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Getting started — Digdag 0.10.5 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Architecture" href="architecture.html" />
<link rel="prev" title="What’s Digdag?" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Digdag
</a>
<div class="version">
0.10
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">1. Requirements.</a></li>
<li class="toctree-l2"><a class="reference internal" href="#downloading-the-latest-version">2. Downloading the latest version</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#on-windows">On Windows?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#using-packages">Using packages?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#curl-did-not-work">curl did not work?</a></li>
<li class="toctree-l3"><a class="reference internal" href="#got-error">Got error?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#running-sample-workflow">3. Running sample workflow</a></li>
<li class="toctree-l2"><a class="reference internal" href="#next-steps">Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="workflow_definition.html">Workflow definition</a></li>
<li class="toctree-l1"><a class="reference internal" href="scheduling_workflow.html">Scheduling workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="operators.html">Operators</a></li>
<li class="toctree-l1"><a class="reference internal" href="command_reference.html">Command reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="python_api.html">Language API - Python</a></li>
<li class="toctree-l1"><a class="reference internal" href="ruby_api.html">Language API - Ruby</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest_api.html">REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="command_executor.html">Command Executor</a></li>
<li class="toctree-l1"><a class="reference internal" href="internal.html">Internal architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="metrics.html">Digdag metrics (experimental)</a></li>
<li class="toctree-l1"><a class="reference internal" href="community_contributions.html">Community Contributions</a></li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="logo.html">Logo</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Digdag</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Getting started</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/getting_started.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="getting-started">
<h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
<div class="section" id="requirements">
<h2>1. Requirements.<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>Digdag runs on Java. Make sure Java Runtime is installed.</p>
<table border="1" class="docutils">
<thead>
<tr>
<th>Digdag version</th>
<th>Java Runtime Version</th>
</tr>
</thead>
<tbody>
<tr>
<td>>= 0.10.0</td>
<td>Java 8 or 11</td>
</tr>
<tr>
<td>< 0.10.0</td>
<td>Java 8</td>
</tr>
</tbody>
</table></div>
<div class="section" id="downloading-the-latest-version">
<h2>2. Downloading the latest version<a class="headerlink" href="#downloading-the-latest-version" title="Permalink to this headline">¶</a></h2>
<p>Digdag is a single executable file. You can install the file to <code class="docutils literal notranslate"><span class="pre">~/bin</span></code> using <code class="docutils literal notranslate"><span class="pre">curl</span></code> command as following:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ curl -o ~/bin/digdag --create-dirs -L "https://dl.digdag.io/digdag-latest"
$ chmod +x ~/bin/digdag
$ echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc
</pre></div>
</div>
<p>Please reopen your terminal window or type following command so that the change of PATH takes effect.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ source ~/.bashrc
</pre></div>
</div>
<p>If <code class="docutils literal notranslate"><span class="pre">digdag</span> <span class="pre">--help</span></code> command works, Digdag is installed successfully.</p>
<p>(Note: if you’re using zsh, modify your<code class="docutils literal notranslate"><span class="pre">~/.zshrc</span></code> file instead of <code class="docutils literal notranslate"><span class="pre">~/.bashrc</span></code>).</p>
<div class="section" id="on-windows">
<h3>On Windows?<a class="headerlink" href="#on-windows" title="Permalink to this headline">¶</a></h3>
<p>On Windows, please open cmd.exe or PowerShell.exe and type following command exactly:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">PowerShell</span> <span class="o">-</span><span class="n">Command</span> <span class="s2">"& {[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::TLS12; mkdir -Force $env:USERPROFILE</span><span class="se">\b</span><span class="s2">in; Invoke-WebRequest http://dl.digdag.io/digdag-latest.jar -OutFile $env:USERPROFILE</span><span class="se">\b</span><span class="s2">in\digdag.bat}"</span>
</pre></div>
</div>
<p>Above command downloads a file named <code class="docutils literal notranslate"><span class="pre">digdag.bat</span></code> to a folder named <code class="docutils literal notranslate"><span class="pre">bin</span></code> at your home folder (<code class="docutils literal notranslate"><span class="pre">C:\Users\YOUR_NAME\bin</span></code>).</p>
<p>Then, type following command so that cmd.exe or PowerShell.exe search <code class="docutils literal notranslate"><span class="pre">digdag</span></code> command from the <code class="docutils literal notranslate"><span class="pre">bin</span></code> folder:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">setx</span> <span class="n">PATH</span> <span class="s2">"%PATH%;%USERPROFILE%</span><span class="se">\b</span><span class="s2">in"</span>
</pre></div>
</div>
<p>Please reopen your command window. If <code class="docutils literal notranslate"><span class="pre">digdag</span> <span class="pre">--help</span></code> command shows usage message, Digdag is installed successfully.</p>
</div>
<div class="section" id="using-packages">
<h3>Using packages?<a class="headerlink" href="#using-packages" title="Permalink to this headline">¶</a></h3>
<p>Digdag has already been packaged for multiple platforms.</p>
<p><a class="reference external" href="https://repology.org/project/digdag/versions"><img alt="https://repology.org/badge/vertical-allrepos/digdag.svg" src="https://repology.org/badge/vertical-allrepos/digdag.svg" />Packaging status</a></p>
</div>
<div class="section" id="curl-did-not-work">
<h3>curl did not work?<a class="headerlink" href="#curl-did-not-work" title="Permalink to this headline">¶</a></h3>
<p>Some environments (ex: Ubuntu 16.04) may produce the following error:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>curl: <span class="o">(</span><span class="m">77</span><span class="o">)</span> error setting certificate verify locations:
CAfile: /etc/pki/tls/certs/ca-bundle.crt
CApath: none
</pre></div>
</div>
<p>Most likely, the SSL certificate file is in <code class="docutils literal notranslate"><span class="pre">/etc/ssl/certs/ca-certificates.crt</span></code> while <code class="docutils literal notranslate"><span class="pre">curl</span></code> expects it in <code class="docutils literal notranslate"><span class="pre">/etc/pki/tls/certs/ca-bundle.crt</span></code>. To fix this, run the folllowing:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>$ sudo mkdir -p /etc/pki/tls/certs
$ sudo cp /etc/ssl/certs/ca-certificates.crt /etc/pki/tls/certs/ca-bundle.crt
</pre></div>
</div>
<p>Then, run Step 1 again.</p>
</div>
<div class="section" id="got-error">
<h3>Got error?<a class="headerlink" href="#got-error" title="Permalink to this headline">¶</a></h3>
<p>If you got an error such as <strong>‘Unsupported major.minor version 52.0’</strong>, please download and install the latest <a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html">Java SE Development Kit 8</a> (must be newer than <strong>8u72</strong>).</p>
</div>
</div>
<div class="section" id="running-sample-workflow">
<h2>3. Running sample workflow<a class="headerlink" href="#running-sample-workflow" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">digdag</span> <span class="pre">init</span> <span class="pre"><dir></span></code> command generates sample workflow for you:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ digdag init mydag
$ cd mydag
$ digdag run mydag.dig
</pre></div>
</div>
<p>Did it work? Next step is adding tasks to <code class="docutils literal notranslate"><span class="pre">digdag.dig</span></code> file to automate your jobs.</p>
</div>
<div class="section" id="next-steps">
<h2>Next steps<a class="headerlink" href="#next-steps" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="architecture.html">Architecture</a></p></li>
<li><p><a class="reference external" href="scheduling_workflow.html">Scheduling workflow</a></p></li>
<li><p><a class="reference external" href="workflow_definition.html">Workflow definition</a></p></li>
<li><p><a class="reference external" href="operators.html">More choices of operators</a></p></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="architecture.html" class="btn btn-neutral float-right" title="Architecture" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral float-left" title="What’s Digdag?" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2016-2024, Digdag Project
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<br/>
<br/>
<p><a href="https://digdag.io/">Digdag</a> is an open source project, invented and sponsored by <a href="https://www.treasuredata.com/">Treasure Data, Inc.</a> under the Apache 2.0 Licence.</p>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>