@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,800 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>JSDoc: Global</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">Global</h1>
21
+
22
+
23
+
24
+
25
+
26
+
27
+ <section>
28
+
29
+ <header>
30
+
31
+ <h2></h2>
32
+
33
+
34
+ </header>
35
+
36
+ <article>
37
+ <div class="container-overview">
38
+
39
+
40
+
41
+
42
+
43
+
44
+ <dl class="details">
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
+ </dl>
78
+
79
+
80
+
81
+
82
+ </div>
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+ <h3 class="subsection-title">Type Definitions</h3>
102
+
103
+
104
+
105
+ <h4 class="name" id="ContainerServerProps">ContainerServerProps</h4>
106
+
107
+
108
+
109
+
110
+ <div class="description">
111
+ Platform template definition
112
+ </div>
113
+
114
+
115
+
116
+ <h5>Type:</h5>
117
+ <ul>
118
+ <li>
119
+
120
+ <span class="param-type">Object</span>
121
+
122
+
123
+ </li>
124
+ </ul>
125
+
126
+
127
+
128
+
129
+
130
+ <h5 class="subsection-title">Properties:</h5>
131
+
132
+
133
+
134
+ <table class="props">
135
+ <thead>
136
+ <tr>
137
+
138
+ <th>Name</th>
139
+
140
+
141
+ <th>Type</th>
142
+
143
+
144
+
145
+
146
+
147
+ <th class="last">Description</th>
148
+ </tr>
149
+ </thead>
150
+
151
+ <tbody>
152
+
153
+
154
+ <tr>
155
+
156
+ <td class="name"><code>platformConfig</code></td>
157
+
158
+
159
+ <td class="type">
160
+
161
+
162
+ <span class="param-type">PlatformConfig</span>
163
+
164
+
165
+
166
+ </td>
167
+
168
+
169
+
170
+
171
+
172
+ <td class="description last">platform config</td>
173
+ </tr>
174
+
175
+
176
+
177
+ <tr>
178
+
179
+ <td class="name"><code>platformConfigBucket</code></td>
180
+
181
+
182
+ <td class="type">
183
+
184
+
185
+ <span class="param-type">Bucket</span>
186
+
187
+
188
+
189
+ </td>
190
+
191
+
192
+
193
+
194
+
195
+ <td class="description last">aws bucket</td>
196
+ </tr>
197
+
198
+
199
+ </tbody>
200
+ </table>
201
+
202
+
203
+
204
+
205
+ <dl class="details">
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
+ <dt class="tag-source">Source:</dt>
233
+ <dd class="tag-source"><ul class="dummy"><li>
234
+ <a href="infrastructure_container-server_container-server.js.html">infrastructure/container-server/container-server.js</a>, <a href="infrastructure_container-server_container-server.js.html#line27">line 27</a>
235
+ </li></ul></dd>
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+ </dl>
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <h4 class="name" id="PlatformTemplate">PlatformTemplate</h4>
253
+
254
+
255
+
256
+
257
+ <div class="description">
258
+ Platform template definition
259
+ </div>
260
+
261
+
262
+
263
+ <h5>Type:</h5>
264
+ <ul>
265
+ <li>
266
+
267
+ <span class="param-type">Object</span>
268
+
269
+
270
+ </li>
271
+ </ul>
272
+
273
+
274
+
275
+
276
+
277
+ <h5 class="subsection-title">Properties:</h5>
278
+
279
+
280
+
281
+ <table class="props">
282
+ <thead>
283
+ <tr>
284
+
285
+ <th>Name</th>
286
+
287
+
288
+ <th>Type</th>
289
+
290
+
291
+ <th>Attributes</th>
292
+
293
+
294
+
295
+
296
+ <th class="last">Description</th>
297
+ </tr>
298
+ </thead>
299
+
300
+ <tbody>
301
+
302
+
303
+ <tr>
304
+
305
+ <td class="name"><code>platformName</code></td>
306
+
307
+
308
+ <td class="type">
309
+
310
+
311
+ <span class="param-type">string</span>
312
+
313
+
314
+
315
+ </td>
316
+
317
+
318
+ <td class="attributes">
319
+
320
+
321
+
322
+ </td>
323
+
324
+
325
+
326
+
327
+ <td class="description last">Name of platform</td>
328
+ </tr>
329
+
330
+
331
+
332
+ <tr>
333
+
334
+ <td class="name"><code>domain</code></td>
335
+
336
+
337
+ <td class="type">
338
+
339
+
340
+ <span class="param-type">string</span>
341
+
342
+
343
+
344
+ </td>
345
+
346
+
347
+ <td class="attributes">
348
+
349
+
350
+
351
+ </td>
352
+
353
+
354
+
355
+
356
+ <td class="description last">example.com</td>
357
+ </tr>
358
+
359
+
360
+
361
+ <tr>
362
+
363
+ <td class="name"><code>supportedDeploymentTypes</code></td>
364
+
365
+
366
+ <td class="type">
367
+
368
+
369
+ <span class="param-type">Array.&lt;string></span>
370
+
371
+
372
+
373
+ </td>
374
+
375
+
376
+ <td class="attributes">
377
+
378
+
379
+
380
+ </td>
381
+
382
+
383
+
384
+
385
+ <td class="description last">container</td>
386
+ </tr>
387
+
388
+
389
+
390
+ <tr>
391
+
392
+ <td class="name"><code>supportedEnvironments</code></td>
393
+
394
+
395
+ <td class="type">
396
+
397
+
398
+ <span class="param-type">Array.&lt;string></span>
399
+
400
+
401
+
402
+ </td>
403
+
404
+
405
+ <td class="attributes">
406
+
407
+
408
+
409
+ </td>
410
+
411
+
412
+
413
+
414
+ <td class="description last">qa</td>
415
+ </tr>
416
+
417
+
418
+
419
+ <tr>
420
+
421
+ <td class="name"><code>awsAccountId</code></td>
422
+
423
+
424
+ <td class="type">
425
+
426
+
427
+ <span class="param-type">string</span>
428
+
429
+
430
+
431
+ </td>
432
+
433
+
434
+ <td class="attributes">
435
+
436
+
437
+
438
+ </td>
439
+
440
+
441
+
442
+
443
+ <td class="description last">Aws account id</td>
444
+ </tr>
445
+
446
+
447
+
448
+ <tr>
449
+
450
+ <td class="name"><code>awsRegion</code></td>
451
+
452
+
453
+ <td class="type">
454
+
455
+
456
+ <span class="param-type">string</span>
457
+
458
+
459
+
460
+ </td>
461
+
462
+
463
+ <td class="attributes">
464
+
465
+ &lt;optional><br>
466
+
467
+
468
+
469
+ </td>
470
+
471
+
472
+
473
+
474
+ <td class="description last">?</td>
475
+ </tr>
476
+
477
+
478
+
479
+ <tr>
480
+
481
+ <td class="name"><code>awsKeyPairName</code></td>
482
+
483
+
484
+ <td class="type">
485
+
486
+
487
+ <span class="param-type">string</span>
488
+
489
+
490
+
491
+ </td>
492
+
493
+
494
+ <td class="attributes">
495
+
496
+ &lt;optional><br>
497
+
498
+
499
+
500
+ </td>
501
+
502
+
503
+
504
+
505
+ <td class="description last">?</td>
506
+ </tr>
507
+
508
+
509
+
510
+ <tr>
511
+
512
+ <td class="name"><code>awsRoleToAssume</code></td>
513
+
514
+
515
+ <td class="type">
516
+
517
+
518
+ <span class="param-type">string</span>
519
+
520
+
521
+
522
+ </td>
523
+
524
+
525
+ <td class="attributes">
526
+
527
+
528
+
529
+ </td>
530
+
531
+
532
+
533
+
534
+ <td class="description last">?</td>
535
+ </tr>
536
+
537
+
538
+
539
+ <tr>
540
+
541
+ <td class="name"><code>awsDeploymentSqsArn</code></td>
542
+
543
+
544
+ <td class="type">
545
+
546
+
547
+ <span class="param-type">string</span>
548
+
549
+
550
+
551
+ </td>
552
+
553
+
554
+ <td class="attributes">
555
+
556
+ &lt;optional><br>
557
+
558
+
559
+
560
+ </td>
561
+
562
+
563
+
564
+
565
+ <td class="description last">?</td>
566
+ </tr>
567
+
568
+
569
+
570
+ <tr>
571
+
572
+ <td class="name"><code>ciSubDomain</code></td>
573
+
574
+
575
+ <td class="type">
576
+
577
+
578
+ <span class="param-type">string</span>
579
+
580
+
581
+
582
+ </td>
583
+
584
+
585
+ <td class="attributes">
586
+
587
+ &lt;optional><br>
588
+
589
+
590
+
591
+ </td>
592
+
593
+
594
+
595
+
596
+ <td class="description last">?</td>
597
+ </tr>
598
+
599
+
600
+
601
+ <tr>
602
+
603
+ <td class="name"><code>ciInternalServerPort</code></td>
604
+
605
+
606
+ <td class="type">
607
+
608
+
609
+ <span class="param-type">string</span>
610
+ |
611
+
612
+ <span class="param-type">mumber</span>
613
+
614
+
615
+
616
+ </td>
617
+
618
+
619
+ <td class="attributes">
620
+
621
+
622
+
623
+ </td>
624
+
625
+
626
+
627
+
628
+ <td class="description last">? | number;</td>
629
+ </tr>
630
+
631
+
632
+
633
+ <tr>
634
+
635
+ <td class="name"><code>ciServerName</code></td>
636
+
637
+
638
+ <td class="type">
639
+
640
+
641
+ <span class="param-type">string</span>
642
+
643
+
644
+
645
+ </td>
646
+
647
+
648
+ <td class="attributes">
649
+
650
+ &lt;optional><br>
651
+
652
+
653
+
654
+ </td>
655
+
656
+
657
+
658
+
659
+ <td class="description last">?</td>
660
+ </tr>
661
+
662
+
663
+
664
+ <tr>
665
+
666
+ <td class="name"><code>ciDockerNetworkName</code></td>
667
+
668
+
669
+ <td class="type">
670
+
671
+
672
+ <span class="param-type">string</span>
673
+
674
+
675
+
676
+ </td>
677
+
678
+
679
+ <td class="attributes">
680
+
681
+ &lt;optional><br>
682
+
683
+
684
+
685
+ </td>
686
+
687
+
688
+
689
+
690
+ <td class="description last">?</td>
691
+ </tr>
692
+
693
+
694
+
695
+ <tr>
696
+
697
+ <td class="name"><code>ciGithubActionsRepo</code></td>
698
+
699
+
700
+ <td class="type">
701
+
702
+
703
+ <span class="param-type">string</span>
704
+
705
+
706
+
707
+ </td>
708
+
709
+
710
+ <td class="attributes">
711
+
712
+
713
+
714
+ </td>
715
+
716
+
717
+
718
+
719
+ <td class="description last">organisation/repoName</td>
720
+ </tr>
721
+
722
+
723
+ </tbody>
724
+ </table>
725
+
726
+
727
+
728
+
729
+ <dl class="details">
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+
755
+
756
+ <dt class="tag-source">Source:</dt>
757
+ <dd class="tag-source"><ul class="dummy"><li>
758
+ <a href="template_platform-template.js.html">template/platform-template.js</a>, <a href="template_platform-template.js.html#line5">line 5</a>
759
+ </li></ul></dd>
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+ </dl>
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+ </article>
779
+
780
+ </section>
781
+
782
+
783
+
784
+
785
+ </div>
786
+
787
+ <nav>
788
+ <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>
789
+ </nav>
790
+
791
+ <br class="clear">
792
+
793
+ <footer>
794
+ 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)
795
+ </footer>
796
+
797
+ <script> prettyPrint(); </script>
798
+ <script src="scripts/linenumber.js"> </script>
799
+ </body>
800
+ </html>