@ossy/deployment-tools 0.0.52 → 0.0.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/jsdoc/AwsCredentialsService.html +166 -0
  2. package/jsdoc/AwsProfile.html +166 -0
  3. package/jsdoc/CaddyService.html +293 -0
  4. package/jsdoc/ContainerServer.html +265 -0
  5. package/jsdoc/DeploymentQueueService.html +166 -0
  6. package/jsdoc/DeploymentToolsService.html +166 -0
  7. package/jsdoc/DockerService.html +166 -0
  8. package/jsdoc/EstablishTrustStack.html +268 -0
  9. package/jsdoc/PlatformConfigService.html +166 -0
  10. package/jsdoc/PlatformDeploymentService.html +166 -0
  11. package/jsdoc/PlatformServerService.html +166 -0
  12. package/jsdoc/PlatformStack.html +166 -0
  13. package/jsdoc/PlatformTemplateService.html +502 -0
  14. package/jsdoc/RestApiService.html +166 -0
  15. package/jsdoc/aws-credentials_aws-credentials.js.html +138 -0
  16. package/jsdoc/config_platform-config.js.html +113 -0
  17. package/jsdoc/deploy_platform-deployment.js.html +155 -0
  18. package/jsdoc/deployment-queue_deployment-queue.js.html +132 -0
  19. package/jsdoc/fonts/OpenSans-Bold-webfont.eot +0 -0
  20. package/jsdoc/fonts/OpenSans-Bold-webfont.svg +1830 -0
  21. package/jsdoc/fonts/OpenSans-Bold-webfont.woff +0 -0
  22. package/jsdoc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  23. package/jsdoc/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  24. package/jsdoc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  25. package/jsdoc/fonts/OpenSans-Italic-webfont.eot +0 -0
  26. package/jsdoc/fonts/OpenSans-Italic-webfont.svg +1830 -0
  27. package/jsdoc/fonts/OpenSans-Italic-webfont.woff +0 -0
  28. package/jsdoc/fonts/OpenSans-Light-webfont.eot +0 -0
  29. package/jsdoc/fonts/OpenSans-Light-webfont.svg +1831 -0
  30. package/jsdoc/fonts/OpenSans-Light-webfont.woff +0 -0
  31. package/jsdoc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  32. package/jsdoc/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  33. package/jsdoc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  34. package/jsdoc/fonts/OpenSans-Regular-webfont.eot +0 -0
  35. package/jsdoc/fonts/OpenSans-Regular-webfont.svg +1831 -0
  36. package/jsdoc/fonts/OpenSans-Regular-webfont.woff +0 -0
  37. package/jsdoc/global.html +800 -0
  38. package/jsdoc/index.html +65 -0
  39. package/jsdoc/infrastructure_container-server_aws-profile.js.html +76 -0
  40. package/jsdoc/infrastructure_container-server_caddy.service.js.html +123 -0
  41. package/jsdoc/infrastructure_container-server_container-server.js.html +229 -0
  42. package/jsdoc/infrastructure_container-server_deployment-tools.service.js.html +91 -0
  43. package/jsdoc/infrastructure_establish-trust-stack.js.html +119 -0
  44. package/jsdoc/infrastructure_platform-stack.js.html +107 -0
  45. package/jsdoc/scripts/linenumber.js +25 -0
  46. package/jsdoc/scripts/prettify/Apache-License-2.0.txt +202 -0
  47. package/jsdoc/scripts/prettify/lang-css.js +2 -0
  48. package/jsdoc/scripts/prettify/prettify.js +28 -0
  49. package/jsdoc/server_caddy.js.html +165 -0
  50. package/{src/server/docker.js → jsdoc/server_docker.js.html} +55 -1
  51. package/jsdoc/server_platform-server.js.html +91 -0
  52. package/jsdoc/server_rest-api.js.html +82 -0
  53. package/jsdoc/styles/jsdoc-default.css +358 -0
  54. package/jsdoc/styles/prettify-jsdoc.css +111 -0
  55. package/jsdoc/styles/prettify-tomorrow.css +132 -0
  56. package/jsdoc/template_platform-template.js.html +134 -0
  57. package/jsdoc.config.js +8 -12
  58. package/package.json +8 -7
  59. package/src/aws-credentials/aws-credentials.js +3 -0
  60. package/src/config/platform-config.js +9 -0
  61. package/src/deploy/platform-deployment.js +30 -0
  62. package/src/deployment-queue/deployment-queue.js +3 -0
  63. package/src/docker/docker-service.js +91 -0
  64. package/src/docker/docker-service.playground.js +17 -0
  65. package/src/docker/index.js +1 -0
  66. package/src/infrastructure/container-server/aws-profile.js +3 -0
  67. package/src/infrastructure/container-server/caddy.service.js +3 -0
  68. package/src/infrastructure/container-server/container-server.js +4 -0
  69. package/src/infrastructure/container-server/deployment-tools.service.js +3 -0
  70. package/src/infrastructure/establish-trust-stack.js +3 -0
  71. package/src/infrastructure/platform-stack.js +6 -2
  72. package/src/server/caddy.js +3 -0
  73. package/src/server/platform-server.js +6 -3
  74. package/src/server/rest-api.js +3 -0
  75. package/src/template/platform-template.js +24 -9
  76. package/src/types.js +0 -32
@@ -0,0 +1,502 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: PlatformTemplateService</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: PlatformTemplateService</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>PlatformTemplateService<span class="signature">()</span><span class="type-signature"></span></h2>
32
+
33
+ <div class="class-description">Utility class that helps you read and validate platfor templates from file system</div>
34
+
35
+
36
+ </header>
37
+
38
+ <article>
39
+ <div class="container-overview">
40
+
41
+
42
+
43
+
44
+ <h2>Constructor</h2>
45
+
46
+
47
+
48
+ <h4 class="name" id="PlatformTemplateService"><span class="type-signature"></span>new PlatformTemplateService<span class="signature">()</span><span class="type-signature"></span></h4>
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+
64
+
65
+
66
+
67
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
95
+ <dd class="tag-source"><ul class="dummy"><li>
96
+ <a href="template_platform-template.js.html">template/platform-template.js</a>, <a href="template_platform-template.js.html#line30">line 30</a>
97
+ </li></ul></dd>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+ </dl>
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+ </div>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <h3 class="subsection-title">Methods</h3>
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ <h4 class="name" id=".fakeValidateTemplate"><span class="type-signature">(static) </span>fakeValidateTemplate<span class="signature">(platformTemplate)</span><span class="type-signature"> &rarr; {<a href="global.html#PlatformTemplate">PlatformTemplate</a>}</span></h4>
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <div class="description">
160
+ Validates the template
161
+ </div>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <h5>Parameters:</h5>
172
+
173
+
174
+ <table class="params">
175
+ <thead>
176
+ <tr>
177
+
178
+ <th>Name</th>
179
+
180
+
181
+ <th>Type</th>
182
+
183
+
184
+
185
+
186
+
187
+ <th class="last">Description</th>
188
+ </tr>
189
+ </thead>
190
+
191
+ <tbody>
192
+
193
+
194
+ <tr>
195
+
196
+ <td class="name"><code>platformTemplate</code></td>
197
+
198
+
199
+ <td class="type">
200
+
201
+
202
+ <span class="param-type"><a href="global.html#PlatformTemplate">PlatformTemplate</a></span>
203
+
204
+
205
+
206
+ </td>
207
+
208
+
209
+
210
+
211
+
212
+ <td class="description last">File path to platform templates json</td>
213
+ </tr>
214
+
215
+
216
+ </tbody>
217
+ </table>
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
252
+ <dd class="tag-source"><ul class="dummy"><li>
253
+ <a href="template_platform-template.js.html">template/platform-template.js</a>, <a href="template_platform-template.js.html#line75">line 75</a>
254
+ </li></ul></dd>
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ </dl>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <h5>Returns:</h5>
279
+
280
+
281
+ <div class="param-desc">
282
+ @Async - List of platform templates
283
+ </div>
284
+
285
+
286
+
287
+ <dl>
288
+ <dt>
289
+ Type
290
+ </dt>
291
+ <dd>
292
+
293
+ <span class="param-type"><a href="global.html#PlatformTemplate">PlatformTemplate</a></span>
294
+
295
+
296
+ </dd>
297
+ </dl>
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <h5>Example</h5>
305
+
306
+ <pre class="prettyprint"><code>const platformTemplate = PlatformTemplateService.readFromFile('./platforms.json')</code></pre>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <h4 class="name" id=".readFromFile"><span class="type-signature">(static) </span>readFromFile<span class="signature">(path)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="global.html#PlatformTemplate">PlatformTemplate</a>>}</span></h4>
317
+
318
+
319
+
320
+
321
+
322
+
323
+ <div class="description">
324
+ Read and validat platform template(s) from file system
325
+ </div>
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+ <h5>Parameters:</h5>
336
+
337
+
338
+ <table class="params">
339
+ <thead>
340
+ <tr>
341
+
342
+ <th>Name</th>
343
+
344
+
345
+ <th>Type</th>
346
+
347
+
348
+
349
+
350
+
351
+ <th class="last">Description</th>
352
+ </tr>
353
+ </thead>
354
+
355
+ <tbody>
356
+
357
+
358
+ <tr>
359
+
360
+ <td class="name"><code>path</code></td>
361
+
362
+
363
+ <td class="type">
364
+
365
+
366
+ <span class="param-type">string</span>
367
+
368
+
369
+
370
+ </td>
371
+
372
+
373
+
374
+
375
+
376
+ <td class="description last">File path to platform templates json</td>
377
+ </tr>
378
+
379
+
380
+ </tbody>
381
+ </table>
382
+
383
+
384
+
385
+
386
+
387
+
388
+ <dl class="details">
389
+
390
+
391
+
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+
415
+ <dt class="tag-source">Source:</dt>
416
+ <dd class="tag-source"><ul class="dummy"><li>
417
+ <a href="template_platform-template.js.html">template/platform-template.js</a>, <a href="template_platform-template.js.html#line41">line 41</a>
418
+ </li></ul></dd>
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+ </dl>
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+ <h5>Returns:</h5>
443
+
444
+
445
+ <div class="param-desc">
446
+ @Async - List of platform templates
447
+ </div>
448
+
449
+
450
+
451
+ <dl>
452
+ <dt>
453
+ Type
454
+ </dt>
455
+ <dd>
456
+
457
+ <span class="param-type">Array.&lt;<a href="global.html#PlatformTemplate">PlatformTemplate</a>></span>
458
+
459
+
460
+ </dd>
461
+ </dl>
462
+
463
+
464
+
465
+
466
+
467
+
468
+ <h5>Example</h5>
469
+
470
+ <pre class="prettyprint"><code>const platformTemplate = PlatformTemplateService.readFromFile('./platforms.json')</code></pre>
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+ </article>
481
+
482
+ </section>
483
+
484
+
485
+
486
+
487
+ </div>
488
+
489
+ <nav>
490
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AwsCredentialsService.html">AwsCredentialsService</a></li><li><a href="AwsProfile.html">AwsProfile</a></li><li><a href="CaddyService.html">CaddyService</a></li><li><a href="ContainerServer.html">ContainerServer</a></li><li><a href="DeploymentQueueService.html">DeploymentQueueService</a></li><li><a href="DeploymentToolsService.html">DeploymentToolsService</a></li><li><a href="DockerService.html">DockerService</a></li><li><a href="EstablishTrustStack.html">EstablishTrustStack</a></li><li><a href="PlatformConfigService.html">PlatformConfigService</a></li><li><a href="PlatformDeploymentService.html">PlatformDeploymentService</a></li><li><a href="PlatformServerService.html">PlatformServerService</a></li><li><a href="PlatformStack.html">PlatformStack</a></li><li><a href="PlatformTemplateService.html">PlatformTemplateService</a></li><li><a href="RestApiService.html">RestApiService</a></li></ul><h3><a href="global.html">Global</a></h3>
491
+ </nav>
492
+
493
+ <br class="clear">
494
+
495
+ <footer>
496
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Oct 23 2022 22:23:31 GMT+0200 (Central European Summer Time)
497
+ </footer>
498
+
499
+ <script> prettyPrint(); </script>
500
+ <script src="scripts/linenumber.js"> </script>
501
+ </body>
502
+ </html>
@@ -0,0 +1,166 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Class: RestApiService</title>
6
+
7
+ <script src="scripts/prettify/prettify.js"> </script>
8
+ <script src="scripts/prettify/lang-css.js"> </script>
9
+ <!--[if lt IE 9]>
10
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11
+ <![endif]-->
12
+ <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14
+ </head>
15
+
16
+ <body>
17
+
18
+ <div id="main">
19
+
20
+ <h1 class="page-title">Class: RestApiService</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2><span class="attribs"><span class="type-signature"></span></span>RestApiService<span class="signature">()</span><span class="type-signature"></span></h2>
32
+
33
+
34
+ </header>
35
+
36
+ <article>
37
+ <div class="container-overview">
38
+
39
+
40
+
41
+
42
+
43
+
44
+ <h4 class="name" id="RestApiService"><span class="type-signature"></span>new RestApiService<span class="signature">()</span><span class="type-signature"></span></h4>
45
+
46
+
47
+
48
+
49
+
50
+
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
91
+ <dd class="tag-source"><ul class="dummy"><li>
92
+ <a href="server_rest-api.js.html">server/rest-api.js</a>, <a href="server_rest-api.js.html#line7">line 7</a>
93
+ </li></ul></dd>
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+ </dl>
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ </div>
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ </article>
145
+
146
+ </section>
147
+
148
+
149
+
150
+
151
+ </div>
152
+
153
+ <nav>
154
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AwsCredentialsService.html">AwsCredentialsService</a></li><li><a href="AwsProfile.html">AwsProfile</a></li><li><a href="CaddyService.html">CaddyService</a></li><li><a href="ContainerServer.html">ContainerServer</a></li><li><a href="DeploymentQueueService.html">DeploymentQueueService</a></li><li><a href="DeploymentToolsService.html">DeploymentToolsService</a></li><li><a href="DockerService.html">DockerService</a></li><li><a href="EstablishTrustStack.html">EstablishTrustStack</a></li><li><a href="PlatformConfigService.html">PlatformConfigService</a></li><li><a href="PlatformDeploymentService.html">PlatformDeploymentService</a></li><li><a href="PlatformServerService.html">PlatformServerService</a></li><li><a href="PlatformStack.html">PlatformStack</a></li><li><a href="PlatformTemplateService.html">PlatformTemplateService</a></li><li><a href="RestApiService.html">RestApiService</a></li></ul><h3><a href="global.html">Global</a></h3>
155
+ </nav>
156
+
157
+ <br class="clear">
158
+
159
+ <footer>
160
+ Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sun Oct 23 2022 22:23:31 GMT+0200 (Central European Summer Time)
161
+ </footer>
162
+
163
+ <script> prettyPrint(); </script>
164
+ <script src="scripts/linenumber.js"> </script>
165
+ </body>
166
+ </html>