altaire-siren 0.1.0 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -2
  3. data/Gemfile +0 -1
  4. data/Gemfile.lock +7 -1
  5. data/altaire-siren.gemspec +1 -0
  6. data/build-schema.rb +206 -0
  7. data/docs/docs/commands/song.md +3 -0
  8. data/fantasia-export.rb +16 -0
  9. data/lib/siren.rb +2 -0
  10. data/lib/siren/cli.rb +16 -1
  11. data/lib/siren/compose.rb +103 -0
  12. data/lib/siren/compose/service.rb +321 -0
  13. data/lib/siren/compose/types.rb +230 -0
  14. data/lib/siren/schemabuilder.rb +56 -0
  15. data/lib/siren/song.rb +78 -50
  16. data/lib/siren/stack.rb +6 -2
  17. data/lib/siren/version.rb +1 -1
  18. data/schemas/docker-compose.yaml +78 -0
  19. metadata +23 -47
  20. data/docs/site/404.html +0 -313
  21. data/docs/site/assets/fonts/font-awesome.css +0 -4
  22. data/docs/site/assets/fonts/material-icons.css +0 -13
  23. data/docs/site/assets/fonts/specimen/FontAwesome.ttf +0 -0
  24. data/docs/site/assets/fonts/specimen/FontAwesome.woff +0 -0
  25. data/docs/site/assets/fonts/specimen/FontAwesome.woff2 +0 -0
  26. data/docs/site/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
  27. data/docs/site/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
  28. data/docs/site/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
  29. data/docs/site/assets/images/favicon.png +0 -0
  30. data/docs/site/assets/images/icons/bitbucket.1b09e088.svg +0 -1
  31. data/docs/site/assets/images/icons/github.f0b8504a.svg +0 -1
  32. data/docs/site/assets/images/icons/gitlab.6dd19c00.svg +0 -1
  33. data/docs/site/assets/javascripts/application.c648116f.js +0 -6
  34. data/docs/site/assets/javascripts/lunr/lunr.da.js +0 -1
  35. data/docs/site/assets/javascripts/lunr/lunr.de.js +0 -1
  36. data/docs/site/assets/javascripts/lunr/lunr.du.js +0 -1
  37. data/docs/site/assets/javascripts/lunr/lunr.es.js +0 -1
  38. data/docs/site/assets/javascripts/lunr/lunr.fi.js +0 -1
  39. data/docs/site/assets/javascripts/lunr/lunr.fr.js +0 -1
  40. data/docs/site/assets/javascripts/lunr/lunr.hu.js +0 -1
  41. data/docs/site/assets/javascripts/lunr/lunr.it.js +0 -1
  42. data/docs/site/assets/javascripts/lunr/lunr.ja.js +0 -1
  43. data/docs/site/assets/javascripts/lunr/lunr.jp.js +0 -1
  44. data/docs/site/assets/javascripts/lunr/lunr.multi.js +0 -1
  45. data/docs/site/assets/javascripts/lunr/lunr.nl.js +0 -1
  46. data/docs/site/assets/javascripts/lunr/lunr.no.js +0 -1
  47. data/docs/site/assets/javascripts/lunr/lunr.pt.js +0 -1
  48. data/docs/site/assets/javascripts/lunr/lunr.ro.js +0 -1
  49. data/docs/site/assets/javascripts/lunr/lunr.ru.js +0 -1
  50. data/docs/site/assets/javascripts/lunr/lunr.stemmer.support.js +0 -1
  51. data/docs/site/assets/javascripts/lunr/lunr.sv.js +0 -1
  52. data/docs/site/assets/javascripts/lunr/lunr.th.js +0 -1
  53. data/docs/site/assets/javascripts/lunr/lunr.tr.js +0 -1
  54. data/docs/site/assets/javascripts/lunr/tinyseg.js +0 -1
  55. data/docs/site/assets/javascripts/lunr/wordcut.js +0 -1
  56. data/docs/site/assets/javascripts/modernizr.74668098.js +0 -1
  57. data/docs/site/assets/stylesheets/application-palette.a8b3c06d.css +0 -1
  58. data/docs/site/assets/stylesheets/application.30686662.css +0 -1
  59. data/docs/site/commands/crypto/index.html +0 -470
  60. data/docs/site/commands/song/index.html +0 -474
  61. data/docs/site/index.html +0 -348
  62. data/docs/site/search/search_index.json +0 -1
  63. data/docs/site/sitemap.xml +0 -18
  64. data/docs/site/sitemap.xml.gz +0 -0
@@ -1,474 +0,0 @@
1
-
2
-
3
-
4
-
5
- <!doctype html>
6
- <html lang="en" class="no-js">
7
- <head>
8
-
9
- <meta charset="utf-8">
10
- <meta name="viewport" content="width=device-width,initial-scale=1">
11
- <meta http-equiv="x-ua-compatible" content="ie=edge">
12
-
13
-
14
-
15
-
16
- <meta name="lang:clipboard.copy" content="Copy to clipboard">
17
-
18
- <meta name="lang:clipboard.copied" content="Copied to clipboard">
19
-
20
- <meta name="lang:search.language" content="en">
21
-
22
- <meta name="lang:search.pipeline.stopwords" content="True">
23
-
24
- <meta name="lang:search.pipeline.trimmer" content="True">
25
-
26
- <meta name="lang:search.result.none" content="No matching documents">
27
-
28
- <meta name="lang:search.result.one" content="1 matching document">
29
-
30
- <meta name="lang:search.result.other" content="# matching documents">
31
-
32
- <meta name="lang:search.tokenizer" content="[\s\-]+">
33
-
34
- <link rel="shortcut icon" href="../../assets/images/favicon.png">
35
- <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2">
36
-
37
-
38
-
39
- <title>Song - Siren</title>
40
-
41
-
42
-
43
- <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
44
-
45
- <link rel="stylesheet" href="../../assets/stylesheets/application-palette.a8b3c06d.css">
46
-
47
-
48
-
49
-
50
- <meta name="theme-color" content="#ef5350">
51
-
52
-
53
-
54
- <script src="../../assets/javascripts/modernizr.74668098.js"></script>
55
-
56
-
57
-
58
- <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
59
- <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback">
60
- <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
61
-
62
-
63
- <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
64
-
65
-
66
-
67
-
68
-
69
-
70
- </head>
71
-
72
-
73
-
74
- <body dir="ltr" data-md-color-primary="red" data-md-color-accent="black">
75
-
76
- <svg class="md-svg">
77
- <defs>
78
-
79
-
80
- </defs>
81
- </svg>
82
- <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
83
- <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
84
- <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
85
-
86
- <a href="#convert" tabindex="1" class="md-skip">
87
- Skip to content
88
- </a>
89
-
90
-
91
- <header class="md-header" data-md-component="header">
92
- <nav class="md-header-nav md-grid">
93
- <div class="md-flex">
94
- <div class="md-flex__cell md-flex__cell--shrink">
95
- <a href="../.." title="Siren" class="md-header-nav__button md-logo">
96
-
97
- <i class="md-icon"></i>
98
-
99
- </a>
100
- </div>
101
- <div class="md-flex__cell md-flex__cell--shrink">
102
- <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
103
- </div>
104
- <div class="md-flex__cell md-flex__cell--stretch">
105
- <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
106
-
107
- <span class="md-header-nav__topic">
108
- Siren
109
- </span>
110
- <span class="md-header-nav__topic">
111
-
112
- Song
113
-
114
- </span>
115
-
116
- </div>
117
- </div>
118
- <div class="md-flex__cell md-flex__cell--shrink">
119
-
120
- <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
121
-
122
- <div class="md-search" data-md-component="search" role="dialog">
123
- <label class="md-search__overlay" for="__search"></label>
124
- <div class="md-search__inner" role="search">
125
- <form class="md-search__form" name="search">
126
- <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
127
- <label class="md-icon md-search__icon" for="__search"></label>
128
- <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
129
- &#xE5CD;
130
- </button>
131
- </form>
132
- <div class="md-search__output">
133
- <div class="md-search__scrollwrap" data-md-scrollfix>
134
- <div class="md-search-result" data-md-component="result">
135
- <div class="md-search-result__meta">
136
- Type to start searching
137
- </div>
138
- <ol class="md-search-result__list"></ol>
139
- </div>
140
- </div>
141
- </div>
142
- </div>
143
- </div>
144
-
145
- </div>
146
-
147
- </div>
148
- </nav>
149
- </header>
150
-
151
- <div class="md-container">
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
- <nav class="md-tabs md-tabs--active" data-md-component="tabs">
161
- <div class="md-tabs__inner md-grid">
162
- <ul class="md-tabs__list">
163
-
164
-
165
- <li class="md-tabs__item">
166
-
167
- <a href="../.." class="md-tabs__link">
168
- Home
169
- </a>
170
-
171
- </li>
172
-
173
-
174
-
175
-
176
-
177
- <li class="md-tabs__item">
178
-
179
- <a href="../crypto/" class="md-tabs__link md-tabs__link--active">
180
- Commands
181
- </a>
182
-
183
- </li>
184
-
185
-
186
-
187
- </ul>
188
- </div>
189
- </nav>
190
-
191
- <main class="md-main" role="main">
192
- <div class="md-main__inner md-grid" data-md-component="container">
193
-
194
-
195
- <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
196
- <div class="md-sidebar__scrollwrap">
197
- <div class="md-sidebar__inner">
198
- <nav class="md-nav md-nav--primary" data-md-level="0">
199
- <label class="md-nav__title md-nav__title--site" for="__drawer">
200
- <a href="../.." title="Siren" class="md-nav__button md-logo">
201
-
202
- <i class="md-icon"></i>
203
-
204
- </a>
205
- Siren
206
- </label>
207
-
208
- <ul class="md-nav__list" data-md-scrollfix>
209
-
210
-
211
-
212
-
213
-
214
-
215
- <li class="md-nav__item">
216
- <a href="../.." title="Home" class="md-nav__link">
217
- Home
218
- </a>
219
- </li>
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
230
-
231
- <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2" checked>
232
-
233
- <label class="md-nav__link" for="nav-2">
234
- Commands
235
- </label>
236
- <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
237
- <label class="md-nav__title" for="nav-2">
238
- Commands
239
- </label>
240
- <ul class="md-nav__list" data-md-scrollfix>
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
- <li class="md-nav__item">
249
- <a href="../crypto/" title="Crypto" class="md-nav__link">
250
- Crypto
251
- </a>
252
- </li>
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
- <li class="md-nav__item md-nav__item--active">
263
-
264
- <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
265
-
266
-
267
- <label class="md-nav__link md-nav__link--active" for="__toc">
268
- Song
269
- </label>
270
-
271
- <a href="./" title="Song" class="md-nav__link md-nav__link--active">
272
- Song
273
- </a>
274
-
275
-
276
- <nav class="md-nav md-nav--secondary">
277
-
278
-
279
-
280
- <label class="md-nav__title" for="__toc">Table of contents</label>
281
- <ul class="md-nav__list" data-md-scrollfix>
282
-
283
- <li class="md-nav__item">
284
- <a href="#convert" class="md-nav__link">
285
- convert
286
- </a>
287
-
288
- </li>
289
-
290
- <li class="md-nav__item">
291
- <a href="#file-format" class="md-nav__link">
292
- File format
293
- </a>
294
-
295
- </li>
296
-
297
-
298
-
299
-
300
-
301
- </ul>
302
-
303
- </nav>
304
-
305
- </li>
306
-
307
-
308
- </ul>
309
- </nav>
310
- </li>
311
-
312
-
313
- </ul>
314
- </nav>
315
- </div>
316
- </div>
317
- </div>
318
-
319
-
320
- <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
321
- <div class="md-sidebar__scrollwrap">
322
- <div class="md-sidebar__inner">
323
-
324
- <nav class="md-nav md-nav--secondary">
325
-
326
-
327
-
328
- <label class="md-nav__title" for="__toc">Table of contents</label>
329
- <ul class="md-nav__list" data-md-scrollfix>
330
-
331
- <li class="md-nav__item">
332
- <a href="#convert" class="md-nav__link">
333
- convert
334
- </a>
335
-
336
- </li>
337
-
338
- <li class="md-nav__item">
339
- <a href="#file-format" class="md-nav__link">
340
- File format
341
- </a>
342
-
343
- </li>
344
-
345
-
346
-
347
-
348
-
349
- </ul>
350
-
351
- </nav>
352
- </div>
353
- </div>
354
- </div>
355
-
356
-
357
- <div class="md-content">
358
- <article class="md-content__inner md-typeset">
359
-
360
-
361
-
362
- <h1>Song</h1>
363
- <h2 id="convert">convert<a class="headerlink" href="#convert" title="Permanent link">&para;</a></h2>
364
- <div class="codehilite"><pre><span></span>siren song convert FILE
365
- </pre></div>
366
-
367
-
368
- <p>Convert a song to a set of Kubernetes resource descriptions.</p>
369
- <p>Until Kubernetes is fully integrated into the CLI, you could deploy a song on a Kubernetes cluster using the command:</p>
370
- <div class="codehilite"><pre><span></span>siren song convert FILE <span class="p">|</span> kubectl apply -f -
371
- </pre></div>
372
-
373
-
374
- <p>and remove it with</p>
375
- <div class="codehilite"><pre><span></span>siren song convert FILE <span class="p">|</span> kubectl delete -f -
376
- </pre></div>
377
-
378
-
379
- <p>Or, you can save the resources to a file to edit or inspect them before deployment.</p>
380
- <h2 id="file-format">File format<a class="headerlink" href="#file-format" title="Permanent link">&para;</a></h2>
381
- <div class="codehilite"><pre><span></span><span class="c1"># Choff for Kubernetes.</span>
382
- <span class="nt">apiVersion</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">siren.altaire.xyz/v1</span>
383
- <span class="nt">kind</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Song</span>
384
- <span class="nt">metadata</span><span class="p">:</span>
385
- <span class="c1"># A name is required.</span>
386
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">builder</span>
387
- <span class="nt">spec</span><span class="p">:</span>
388
- <span class="c1"># Global environmental variables which apply to all services.</span>
389
- <span class="nt">env</span><span class="p">:</span>
390
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">value</span>
391
- <span class="nt">service</span><span class="p">:</span>
392
- <span class="p p-Indicator">-</span> <span class="c1"># As you can imagine, the image to run.</span>
393
- <span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">altaire/builder-live</span>
394
- <span class="c1"># Optionally, the command to run in the image.</span>
395
- <span class="nt">command</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">command-name</span>
396
- <span class="c1"># Optionally, name this service.</span>
397
- <span class="c1"># If there are multiple services, you _must_ name them.</span>
398
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">service-name</span>
399
- <span class="c1"># Environmental variables which apply to all services.</span>
400
- <span class="c1"># These override the global variables, if there are any.</span>
401
- <span class="nt">env</span><span class="p">:</span>
402
- <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">value</span>
403
- <span class="c1"># Publish the service one or more domains</span>
404
- <span class="nt">publish</span><span class="p">:</span>
405
- <span class="p p-Indicator">-</span> <span class="c1"># The port the service is listening on.</span>
406
- <span class="nt">port</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">8081</span>
407
- <span class="c1"># Domain name to use.</span>
408
- <span class="nt">domain</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">builder.k9.altaire.xyz</span>
409
- <span class="c1"># Use built-in Altaire auth.</span>
410
- <span class="nt">auth</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
411
- <span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">...</span>
412
- </pre></div>
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
- </article>
423
- </div>
424
- </div>
425
- </main>
426
-
427
-
428
- <footer class="md-footer">
429
-
430
- <div class="md-footer-nav">
431
- <nav class="md-footer-nav__inner md-grid">
432
-
433
- <a href="../crypto/" title="Crypto" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
434
- <div class="md-flex__cell md-flex__cell--shrink">
435
- <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
436
- </div>
437
- <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
438
- <span class="md-flex__ellipsis">
439
- <span class="md-footer-nav__direction">
440
- Previous
441
- </span>
442
- Crypto
443
- </span>
444
- </div>
445
- </a>
446
-
447
-
448
- </nav>
449
- </div>
450
-
451
- <div class="md-footer-meta md-typeset">
452
- <div class="md-footer-meta__inner md-grid">
453
- <div class="md-footer-copyright">
454
-
455
- powered by
456
- <a href="https://www.mkdocs.org">MkDocs</a>
457
- and
458
- <a href="https://squidfunk.github.io/mkdocs-material/">
459
- Material for MkDocs</a>
460
- </div>
461
-
462
- </div>
463
- </div>
464
- </footer>
465
-
466
- </div>
467
-
468
- <script src="../../assets/javascripts/application.c648116f.js"></script>
469
-
470
- <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>
471
-
472
-
473
- </body>
474
- </html>