-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
2578 lines (2485 loc) · 148 KB
/
index.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
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
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-119014319-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-119014319-2');
</script>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="description" content="">
<meta name="keywords" content="">
<title>Cloud Design Specification - Reindeer Project</title>
<!-- Styles -->
<link href="resources/page.min.css" rel="stylesheet">
<link href="resources/style.css" rel="stylesheet">
<link href="resources/cdstop.css" rel="stylesheet">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css"
integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
<!-- Favicons -->
<link rel="apple-touch-icon" href="https://reindeer.tech/assets/img/reindeerfavicon.png">
<link rel="icon" href="https://reindeer.tech/assets/img/reindeerfavicon.png">
</head>
<body data-spy="scroll" data-target=".nav-sidebar" data-offset="100" data-gr-c-s-loaded="true" class="">
<!-- Navbar -->
<nav class="navbar navbar-expand-lg navbar-dark navbar-stick-dark">
<div class="container">
<div class="navbar-left">
<ul class="nav nav-navbar">
<li class="nav-item">
<a class="nav-link" style="padding-left:0px" href="https://reindeer.tech" target="_blank">
<span>Supported by reindeer</span>
</a>
</li>
</ul>
</div>
<v-spacer></v-spacer>
<div class="navbar-right">
<ul class="nav nav-navbar">
<li class="nav-item">
<a class="nav-link" style="padding-left:0px" href="/index_ja.html" target="_blank">
<span>日本語</span>
</a>
</li>
</ul>
</div>
</div>
</nav>
<!-- /.navbar -->
<!-- Header -->
<header class="header">
<div id="headertitle" class="container">
<div class="row">
<div class="col-sm-12" style="text-align:center">
<img src="cloudDesignSpecification.svg" class="mb-3" style="max-width:150px;">
<h1 style="padding-top:10px;">CDS: Cloud Design Specification</h1>
<div style="padding-bottom:30px;padding-top:10px;font-size:20px;color:white">Ver 1.3.2</div>
</div>
</div>
</div>
</header>
<!-- /.header -->
<!-- Main Content -->
<main id="main" class="main-content">
<div class="container">
<div class="row">
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| Sidebar
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
!-->
<div class="col-md-4 col-xl-3">
<aside class="sidebar sidebar-expand-md sidebar-sticky pr-md-4 br-1" style="width: 209.988px;">
<div class="sidebar-body ps ps--active-y">
<ul class="nav nav-sidebar nav-sidebar-hero nav-sidebar-pill flex-nowrap">
<li class="nav-item">
<a class="nav-link navParent" href="#gettingstarted">Getting started</a>
<div class="nav">
<a class="nav-link small" href="#introduction">Introduction</a>
<a class="nav-link small" href="#extension">Extensional design</a>
<a class="nav-link small" href="#tools">Tools</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link navParent" href="#general">General</a>
<div class="nav">
<a class="nav-link small" href="#versions">Versions</a>
<a class="nav-link small" href="#format">Format</a>
<a class="nav-link small" href="#structure">Structure</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link navParent" href="#parentSchema">Parent Schema</a>
<div class="nav">
<a class="nav-link small" href="#s-clouddesign">
<i class="fa fa-home mr-3" aria-hidden="true"></i>
Cloud Design</a>
<a class="nav-link small" href="#s-info">
<i class="fa fa-info-circle mr-3" aria-hidden="true"></i>
Info</a>
<a class="nav-link small" href="#s-actor">
<i class="fa fa-user mr-3" aria-hidden="true"></i>
Actor</a>
<a class="nav-link small" href="#s-resource">
<i class="fa fa-server mr-3" aria-hidden="true"></i>
Resource</a>
<a class="nav-link small" href="#s-context">
<i class="fa fa-route mr-3" aria-hidden="true"></i>
Context</a>
<a class="nav-link small" href="#s-components">
<i class="fa fa-cube mr-3" aria-hidden="true"></i>
Components</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link navParent" href="#childSchema">Child Schema</a>
<div class="nav">
<a class="nav-link small" href="#s-license">
<i class="fas fa-signature mr-3" aria-hidden="true"></i>
License</a>
<a class="nav-link small" href="#s-author">
<i class="fa fa-id-card mr-3" aria-hidden="true"></i>
Author</a>
<a class="nav-link small" href="#s-organization">
<i class="fa fa-id-card mr-3" aria-hidden="true"></i>
Organization</a>
<a class="nav-link small" href="#s-market">
<i class="fa fa-crosshairs mr-3" aria-hidden="true"></i>
Market</a>
<a class="nav-link small" href="#s-trigger">
<i class="fa fa-play-circle mr-3" aria-hidden="true"></i>
Trigger</a>
<a class="nav-link small" href="#s-traffic">
<i class="fa fa-link mr-3" aria-hidden="true"></i>
Traffic</a>
<a class="nav-link small" href="#s-infoType">
<i class="fa fa-lock mr-3" aria-hidden="true"></i>
InfoType</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link navParent" href="#commonSchema">Common Schema</a>
<div class="nav">
<a class="nav-link small" href="#s-rangeValue">
<i class="fa fa-calculator mr-3" aria-hidden="true"></i>
Range values</a>
<a class="nav-link small" href="#s-ref">
<i class="fa fa-eye mr-3" aria-hidden="true"></i>
Reference</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link navParent" href="#appendix">Appendix</a>
<div class="nav">
<a class="nav-link small" href="#resourcearticles">Resources</a>
<a class="nav-link small" href="#revision">Revision</a>
</div>
</li>
</ul>
<div class="ps__rail-x" style="left: 0px; bottom: 0px;">
<div class="ps__thumb-x" tabindex="0" style="left: 0px; width: 0px;"></div>
</div>
<div class="ps__rail-y" style="top: 0px; right: 0px; height: 318px;">
<div class="ps__thumb-y" tabindex="0" style="top: 0px; height: 227px;"></div>
</div>
</div>
</aside>
</div>
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| Content
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
!-->
<div class="col-md-7 col-xl-8 ml-md-auto py-8">
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| Getting started
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
!-->
<h2 id="gettingstarted">Getting started<a class="anchor" href="#gettingstarted"></a></h2>
<div class="alert alert-secondary">
<p class="lead-2">Get started with Cloud requirements definition with this reference and tools.</p>
<p>This document is licensed under <a href="https://www.apache.org/licenses/LICENSE-2.0.html"
target="_blank">
The Apache License, Version 2.0</a>.
</p>
<p>The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”,
“RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be
interpreted as described in <a href="https://www.ietf.org/rfc/rfc2119.txt" target="_blank">RFC 2119</a>.
</p>
</div>
<hr class="hr-dot-bold my-7">
<h3 id="introduction">Introduction<a class="anchor" href="#introduction"></a></h3>
<p>The Cloud Design Specification (<b>the "CDS"</b>) defines cloud usage requirements by JSON/YAML codes for both human and computer comprehension.
<br>In this document, CDS is the name of the language specification itself, and at the same time, it
indicates the code described based on the cloud design specification. Previously, the latter was clearly
distinguished as Cloud Design Definition (<b> the "CDD" </b>), but it has been unified into CDS to prevent a
mess of terms.
So there is a description of CDD in some tools and peripheral documents, still it is no problem that you
think it is synonymous with CDS.
</p>
<hr class="hr-dot-bold my-7">
<h3 id="extension">Extension of the existing provisioning codes <a class="anchor" href="#introduction"></a>
</h3>
<p>CDS is a requirements definition code that complements existing provisioning code such as CloudFormation. System
requirements such as users and access volumes are described in this own specifications, and cloud resource
definitions are expressed by references to existing provisioning codes. This structure reduces the
learning cost of developers and encourages the utilization of existing code assets.
<br>Please refer <a href="#s-resource">Resource object</a> for the types of provisioning code that you can
use on CDD.
</p>
<hr class="hr-dot-bold my-7">
<h3 id="tools">Tools<a class="anchor" href="#tools"></a></h3>
<p>You can create, store, search, reuse the Cloud Designs by using various tools.</p>
<br><br>
<p><B>Cloud Design Schema</B><br>It is a JSON schema file that can be used to check the grammar of the CDS by
incorporating it into a third party editor.</p>
<a class="btn btn-primary mb-1" href="/en/reindeer-schema_cds.json" target="_blank"
onClick="ga('send','event','btn', 'click', 'cds_schema_en');">Download CDS root schema</a>
<a class="btn btn-primary mb-1" href="/en/reindeer-schema_cds-snippet.json" target="_blank"
onClick="ga('send','event','btn', 'click', 'CDS_snippet_schema_en');">Download CDS snippet schema</a>
</p>
<br>
<p><B>ForkMe!</B><br>A cloud design management tool provided by Reindeer Technology PTE.LTD. It fulfills the
developer's desire to "fork (duplicate / derive) cloud design like software". (The Reindeer Project was
progressively incorporated into Reindeer Technology PTE. LTD.)
</p>
<p><a class="btn btn-primary mb-1" href="https://forkme.cloud/" target="_blank"
onClick="ga('send','event','btn', 'click', 'hub_ja');">Access</a>
</p>
<p><B>Reindeer Editor</B><br>A documentation generation tool supported by Reindeer Project. You can edit a CDS
and display
the cloud adoption report by using this.</p>
<p><a class="btn btn-primary mb-1" href="https://github.com/reindeer-project/reindeer-editor" target="_blank"
onClick="ga('send','event','btn', 'click', 'download_demo_en');">Download</a></p>
<br>
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| General
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
!-->
<div class="text-center my-7"><a href="#gettingstarted"><i class="fa fa-angle-up" aria-hidden="true"
style="font-size: 50px;"></i></a></div>
<h2 id="general">General<a class="anchor" href="#general"></a></h2>
<div class="alert alert-secondary">
<p class="lead-2">Describing the general specification of Cloud Design.</p>
</div>
<hr class="hr-dot-bold my-7">
<h3 id="versions">Versions<a class="anchor" href="#versions"></a></h3>
<p>The CDS is versioned using <a href="https://semver.org/spec/v2.0.0.html" target="_blank">Semantic
Versioning 2.0.0</a> (SemVer) and follows
the below specification.<br>A version number is given incrementally as <code>major.minor.patch</code>. The
<code>major.minor</code> SHALL designate
the one or some feature set. And the <code>.patch</code> SHALL designate backward-compatible bug fixes.
So the patch version SHOULD NOT be considered by tooling, SHOULD NOT make any distinction about the feature
or tooling between 1.0.0 and 1.0.1 for example.
</p>
<hr class="hr-dot-bold my-7">
<h3 id="format">Format<a class="anchor" href="#format"></a></h3>
<p>The CDS is itself a JSON object,
which MAY be represented either in JSON or YAML format.
In order to preserve the ability to round-trip between YAML and JSON formats,
YAML version <a href="https://yaml.org/spec/1.2/spec.html" target="_blank">1.2</a> is RECOMMENDED along with
some additional constraints:
<ul>
<li>Tags MUST be limited to those allowed by the <a href="http://www.yaml.org/spec/1.2/spec.html#id2803231"
target="_blank">JSON Schema ruleset</a>.</li>
<li>Keys used in YAML maps MUST be limited to a scalar string,
as defined by the <a href="http://yaml.org/spec/1.2/spec.html#id2802346" target="_blank">YAML Failsafe
schema ruleset</a>.</li>
</ul>
<p>All field names in the specification are <b>case confidential</b>.
This includes all fields that are used as keys in a map, except where explicitly noted that keys are <b>case
inconfidential</b>.</p>
<hr class="hr-dot-bold my-7">
<h3 id="structure">Structure<a class="anchor" href="#structure"></a></h3>
<p>The CDS MAY consist of a single document or split into multiple parts at the user's discretion.
However, in the latter case, the root CDS MUST always contain all required <a href="#parentSchema">parent
schemas</a>.
Also, files referred to as parts are called CDS snippets, and SHOULD contain only <a
href="#s-components">components</a> objects.
And the reference to the CDS snippet from the root file SHOULD be associated name in <code>$ref</code>
field.
And the root file SHOULD be named 'clouddesign.json' or 'clouddesign.yaml'.
</p>
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| Parent Schema
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
!-->
<div class="text-center my-7"><a href="#general"><i class="fa fa-angle-up" aria-hidden="true"
style="font-size: 50px;"></i></a></div>
<h2 id="parentSchema">Parent Schema<a class="anchor" href="#parentSchema"></a></h2>
<div class="alert alert-secondary">
<p class="lead-2">Describing the primary data structure of Cloud Design.
In the following description, if a field is not explicitly REQUIRED or described with a MUST or SHALL,
it can be considered OPTIONAL.
</p>
</div>
<hr class="hr-dot-bold my-7">
<h3 id="s-clouddesign">
<i class="fa fa-home mr-3" aria-hidden="true"></i>
Cloud Design Object<a class="anchor" href="#s-clouddesign"></a>
</h3>
<p>This is the root object of the CDS.</p>
<h6>Fixed Fields</h6>
<div class="d-table table-responsive line-break">
<div class="d-table-row">
<p class="d-table-cell p-2 bg-primary text-white border">Field Name</p>
<p class="d-table-cell p-2 bg-primary text-white border">Type</p>
<p class="d-table-cell p-2 bg-primary text-white border">Description</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">reindeer</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
This string MUST be the <a href="#versions">semantic version number</a> of the CDS itself.
The <code>reindeer</code> field SHOULD be used by tools for interpreting the CDS.
This is not related to the <code>info.version</code> string.
<span style="font-weight:bold;color:red">Use '1.3.2' at <a href="https://forkme.cloud/" target="_blank">ForkMe!</a></span>
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">self</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
This string is the filename of the CDS. It MUST be with the extension, <code>.json</code>,
<code>.yaml</code> or <code>.yml</code>.
The <code>self</code> field SHOULD be used by tools for interpreting the CDS.
<span style="font-weight:bold;color:red">Use 'cloudDesign.json' at <a href="https://forkme.cloud/" target="_blank">ForkMe!</a></span>
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">info</p>
<p class="d-table-cell p-2 bg-white text-dark border"><a href="#s-info">Info object</a></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
Provides metadata about the cloud adoption. The metadata MAY be used by tooling as required.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">actors</p>
<p class="d-table-cell p-2 bg-white text-dark border">[ <a href="#s-actor">Actor object</a> |
<code>string</code>, <a href="#s-ref">Reference object</a>]
</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
An array of actor objects, which provide information about the external user or system to which cloud
computing is connected.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">resources</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <a
href="#s-resource">Resource object</a> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
An array of resource objects, which is pointing to the external documents (files written by provisioning
codes) describing the cloud architecture.</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">contexts</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <a
href="#s-context">Context object</a> | <code>string</code>, <a href="#s-ref">Reference object</a>]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
An array of context objects, which provide information about the relationship
for achieving a specific purpose between actors and cloud resources.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">components</p>
<p class="d-table-cell p-2 bg-white text-dark border"><a href="#s-components">Components object</a></p>
<p class="d-table-cell p-2 bg-white text-dark border">Holds a set of reusable objects for different
aspects of the CDS.
All objects defined within the components object will have no effect on the Cloud Design
unless they are explicitly referenced from properties outside the components object.
</p>
</div>
</div>
<h6>JSON example</h6>
<pre><code>{
<span class="token tag">"reindeer": </span>"1.3.2",
<span class="token tag">"self": </span>"cloudDesign.json"
<span class="token tag">"info": </span>{
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"Sample system",
<span class="token tag">"ja": </span>"サンプルシステム",
},
Refer 'Info' schema
},
<span class="token tag">"actors": </span>{
<span class="token tag">"customer": </span>{
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"Customers",
<span class="token tag">"ja": </span>"顧客",
},
Refer 'Actor' schema
}
},
<span class="token tag">"resources": </span>[
{
<span class="token tag">"$ref":</span>"awsTemplate.json",
Refer 'Resources' schema
}
],
<span class="token tag">"contexts": </span>{
<span class="token tag">"customerWebAccess": </span>{
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"Web access by customer",
<span class="token tag">"ja": </span>"顧客によるウェブアクセス",
},
Refer 'Contexts' schema
}
},
<span class="token tag">"components": </span>{
<span class="token tag">"actors": </span>{
<span class="token tag">"operator": </span>{
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"Operator",
<span class="token tag">"ja": </span>"運用者",
},
Refer 'Actor' schema
}
},
Refer 'Components' schema
(Components is an optional schema useful for reusing definitions)
}
</code></pre>
<hr class="hr-dot-bold my-7">
<h3 id="s-info">
<i class="fa fa-info-circle mr-3" aria-hidden="true"></i>
Info object<a class="anchor" href="#s-info"></a>
</h3>
<p>
The object provides metadata about the CDS.
The metadata SHOULD be filled properly for helping others easy to search and find the CDS.
</p>
<h6>Fixed Fields</h6>
<div class="d-table table-responsive line-break">
<div class="d-table-row">
<p class="d-table-cell p-2 bg-primary text-white border">Field Name</p>
<p class="d-table-cell p-2 bg-primary text-white border">Type</p>
<p class="d-table-cell p-2 bg-primary text-white border">Description</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">version</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The version of your design (which is distinct from <a href="#versions">the CDS version</a>).
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">license</p>
<p class="d-table-cell p-2 bg-white text-dark border"><a href="#s-license">License object</a></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. The license information
of the CDS.</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">title</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8.<br>
The title of the service, adopting this cloud design.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">description</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8. <br>
The description of the service, adopting this cloud design.
It SHOULD be the concise memo including every keyword of the purpose and functions of the system.
This text MAY be used as the search index by external tools.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">status</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. The status of the CDS.
Valid values are <code>idea</code>, <code>draft</code>, <code>production</code>.<br>
<code>draft: </code>Requirement unregistered or under definition.<br>
<code>prepared: </code>State where requirements are defined.<br>
<code>designed: </code>Design codes created based on requirements.<br>
<code>reviewed: </code>Completed design review and modification.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">designedAt</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>integer</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The time when the CDS was designed at. It MUST be the UNIXTIME format.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">authors</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code>, <a
href="#s-author">Author object</a> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. The authors of the CDS.
This information MAY be used by external tools as the important evidence of involved person's skill and
experience.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">organizations</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code>, <a
href="#s-organization">Organization object</a> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border">Related organizations of the CDS.
This information MAY be used by external tools as the important evidence of involved organization's
skill and experience.
</p>
</div>
</div>
<h6>JSON example</h6>
<pre><code>{
<span class="token tag">"version": </span>"1.0.0",
<span class="token tag">"license": </span>{
<span class="token tag">"type": </span>"CC0"
},
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"Sample system",
<span class="token tag">"ja": </span>"サンプルシステム",
<span class="token tag">"ru": </span>"Образец системы"
},
<span class="token tag">"description": </span>{
<span class="token tag">"en": </span>"Sample description",
<span class="token tag">"ja": </span>"説明サンプル",
<span class="token tag">"ru": </span>"Пример описания"
},
<span class="token tag">"status": </span>"draft",
<span class="token tag">"designedAt": </span>"1548731447",
<span class="token tag">"authors": </span>{
<span class="token tag">"sampleHandleNameA": </span>{
<span class="token tag">"roles": </span>[<span class="token tag">"designer"</span>],
<span class="token tag">"joinedAt": </span>1548730447,
<span class="token tag">"leavedAt": </span>1548731447
},
<span class="token tag">"sampleHandleNameB": </span>{
<span class="token tag">"roles": </span>[<span class="token tag">"designer"</span>, <span class="token tag">"auditor"</span>],
<span class="token tag">"joinedAt": </span>1548730447
}
},
<span class="token tag">"organizations": </span>{
<span class="token tag">"sampleCompanyA": </span>{
<span class="token tag">"joinedAt": </span>1548730447,
<span class="token tag">"leavedAt": </span>1548731447
},
<span class="token tag">"sampleCompanyB": </span>{
<span class="token tag">"joinedAt": </span>1548730447,
<span class="token tag">"sign": </span>xxxxxx123
}
}
}
</code></pre>
<h6>YAML example</h6>
<pre><code><span class="token tag">version: </span>1.0.0
<span class="token tag">license: </span>
<span class="token tag">type: </span>CC0
<span class="token tag">title: </span>
<span class="token tag">en: </span>Sample system
<span class="token tag">ja: </span>サンプルシステム
<span class="token tag">ru: </span>Образец системы
<span class="token tag">description: </span>
<span class="token tag">en: </span>Sample description
<span class="token tag">ja: </span>説明サンプル
<span class="token tag">ru: </span>Пример описания
<span class="token tag">status: </span>draft
<span class="token tag">designedAt: </span>1548731447
<span class="token tag">authors: </span>
<span class="token tag">sampleHandleNameA: </span>
<span class="token tag">roles: </span>
<span class="token tag">- </span>designer
<span class="token tag">joinedAt: </span>1548730447
<span class="token tag">leavedAt: </span>1548731447
<span class="token tag">sampleHandleNameB: </span>
<span class="token tag">roles: </span>
<span class="token tag">- </span>designer
<span class="token tag">- </span>auditor
<span class="token tag">sign: </span>xxxxxxx123
<span class="token tag">joinedAt: </span>1548730447
<span class="token tag">organizations: </span>
<span class="token tag">sampleHandleNameA: </span>
<span class="token tag">joinedAt: </span>1548730447
<span class="token tag">leavedAt: </span>1548731447
<span class="token tag">sign: </span>xxxxxxx123
<span class="token tag">sampleHandleNameB: </span>
<span class="token tag">joinedAt: </span>1548730447
</code></pre>
<hr class="hr-dot-bold my-7">
<h3 id="s-actor">
<i class="fa fa-user mr-3" aria-hidden="true"></i>
Actor objects<a class="anchor" href="#s-info"></a>
</h3>
<p>
The objects provide information about users, operators or external systems the cloud will be
connected with.
It SHOULD be comprehensive for designing and auditing the CDS correctly.
</p>
<hr class="hr-dot my-5">
<h3 id="s-actor-market" class="font-italic">Market type of actor object<a class="anchor"
href="#s-actor-market"></a></h3>
<p>
This object provides information about an unspecified number of users, such as consumers and spectators
belonging to a particular market.
It is the kind of actor you SHOULD use, for example, when designing a limited network connection with an
identifiable individual and cloud.
The correct number SHOULD be provided in order to understand the number of users and the number of requests
to be provided to the system.
</p>
<h6>Fixed Fields</h6>
<div class="d-table table-responsive line-break">
<div class="d-table-row">
<p class="d-table-cell p-2 bg-primary text-white border">Field Name</p>
<p class="d-table-cell p-2 bg-primary text-white border">Type</p>
<p class="d-table-cell p-2 bg-primary text-white border">Description</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">type</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. Fixed value,
'<code>market</code>'.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">title</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8.<br>
The title of the actor.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">description</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8. <br>
The description of the actor.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">market</p>
<p class="d-table-cell p-2 bg-white text-dark border"><a href="#s-market">Market object</a> | <a
href="#s-ref">Reference object</a> </p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. Market information to
which this actor belongs.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">marketShare</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>float</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. The share ratio of this
actor among the belonging market.
For example, <code>0.3</code> means 30%.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">sourceIdentification</p>
<p class="d-table-cell p-2 bg-white text-dark border">[ <code>boolean</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. Whether specific IP
address range or domains is assigned or not.
If true, <code>identificationGroup</code> property is required.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">identificationGroup</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border">The group name of IP address range, domains and so
on..
Required when <code>sourceIdentification</code> propery is true. And MUST NOT use when
<code>sourceIdentification</code> propery is false.
</p>
</div>
</div>
<h6>JSON Example</h6>
<pre><code>{
<span class="token tag">"type": "market",</span>
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"Customers",
<span class="token tag">"ja": </span>"顧客",
<span class="token tag">"ru": </span>"Клиенты"
},
<span class="token tag">"description": </span>{
<span class="token tag">"en": </span>"Users of our products.",
<span class="token tag">"ja": </span>"当社製品の利用ユーザー",
<span class="token tag">"ru": </span>"Пользователи нашей продукции."
},
<span class="token tag">"market": </span>{
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"65 years and over in U.S., July 2018",
<span class="token tag">"ja": </span>"65才以上の人口 米国 2018年7月",
<span class="token tag">"ru": </span>"65 лет и старше в США, июль 2018 года"
},
<span class="token tag">"description": </span>{
<span class="token tag">"en": </span>"General population data of U.S. at 2018 by govermental research.",
<span class="token tag">"ja": </span>"米国政府による2018年の人口統計",
<span class="token tag">"ru": </span>"Данные об общей численности населения США на 2018\nгод по данным государственных исследований."
},
<span class="token tag">"num": </span>51038120,
<span class="token tag">"estimatedBy": </span>"U.S. Census Bureau",
<span class="token tag">"estimatedAt": </span>1530370800
},
<span class="token tag">"marketShare": </span>0.01,
<span class="token tag">"sourceIdentification": </span>false
}
</code></pre>
<h6>YAML Example</h6>
<pre><code><span class="token tag">type: market</span>
<span class="token tag">title: </span>
<span class="token tag">en: </span>Customers
<span class="token tag">ja: </span>顧客
<span class="token tag">ru: </span>Клиенты
<span class="token tag">description: </span>
<span class="token tag">en: </span>Users of our products.
<span class="token tag">ja: </span>当社製品の利用ユーザー
<span class="token tag">ru: </span>Пользователи нашей продукции.
<span class="token tag">market: </span>
<span class="token tag">title: </span>
<span class="token tag">en: </span>65 years and over in U.S., July 2018
<span class="token tag">ja: </span>65才以上の人口 米国 2018年7月
<span class="token tag">ru: </span>65 лет и старше в США, июль 2018 года
<span class="token tag">description: </span>
<span class="token tag">en: </span>General population data of U.S. at 2018 by govermental research.
<span class="token tag">ja: </span>米国政府による2018年の人口統計
<span class="token tag">ru: </span>|
Данные об общей численности населения США на 2018
год по данным государственных исследований.
<span class="token tag">num: </span>51038120
<span class="token tag">estimatedBy: </span>U.S. Census Bureau
<span class="token tag">estimatedAt: </span>1530370800
<span class="token tag">marketShare: </span>0.01
<span class="token tag">sourceIdentification: </span>false
</code></pre>
<hr class="hr-dot my-5">
<h3 id="s-actor-persons" class="font-italic">Persons type of actor object<a class="anchor"
href="#s-actor-persons"></a></h3>
<p>
The object provides information about a type of actor being consisted of one or a few persons like system
operator.
The kind of actor you SHOULD use, for example, when designing a limited network connection between an
identifiable external system and cloud. </p>
<h6>Fixed Fields</h6>
<div class="d-table table-responsive line-break">
<div class="d-table-row">
<p class="d-table-cell p-2 bg-primary text-white border">Field Name</p>
<p class="d-table-cell p-2 bg-primary text-white border">Type</p>
<p class="d-table-cell p-2 bg-primary text-white border">Description</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">type</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. Fixed value,
'<code>persons</code>'.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">title</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8.<br>
The title of the group of persons.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">description</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8. <br>
The description of the group of persons.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">num</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>integer</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. The number of members.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">sourceIdentification</p>
<p class="d-table-cell p-2 bg-white text-dark border">[ <code>boolean</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. Assigned specific IP
address range, domains and so on, or not.
If true, <code>identificationGroup</code> property is required.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">identificationGroup</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border">The group name of IP address range, domains and so
on.
Required when <code>sourceIdentification</code> propery is true. And MUST NOT use when
<code>sourceIdentification</code> propery is false.
</p>
</div>
</div>
<h6>JSON example</h6>
<pre><code>{
<span class="token tag">"type": "persons",</span>
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"Operators",
<span class="token tag">"ja": </span>"運用担当者",
<span class="token tag">"ru": </span>"операторы"
},
<span class="token tag">"description": </span>{
<span class="token tag">"en": </span>"Operators using management console.",
<span class="token tag">"ja": </span>"管理コンソールを利用する運用担当者",
<span class="token tag">"ru": </span>"Операторы, использующие консоль управления."
},
<span class="token tag">"num": </span>7,
<span class="token tag">"sourceIdentification": </span>true,
<span class="token tag">"identificationGroup": </span>"IPsOfOperatorGroupA"
}</code></pre>
<h6>YAML example</h6>
<pre><code><span class="token tag">type: persons</span>
<span class="token tag">title: </span>a
<span class="token tag">en: </span>Operators
<span class="token tag">ja: </span>運用担当者
<span class="token tag">ru: </span>операторы
<span class="token tag">description: </span>
<span class="token tag">en: </span>Operators using management console.
<span class="token tag">ja: </span>管理コンソールを利用する運用担当者
<span class="token tag">ru: </span>Операторы, использующие консоль управления.
<span class="token tag">num: </span>7
<span class="token tag">sourceIdentification: </span>true
<span class="token tag">identificationGroup: </span>IPsOfOperatorGroupA
</code></pre>
<hr class="hr-dot my-5">
<h3 id="s-actor-system" class="font-italic">External system type of actor object<a class="anchor"
href="#s-actor-system"></a></h3>
<p>
The object provides information about a type of actor being consisted of one or a few systems like external
API, FILE interface and so on.
The kind of actor you SHOULD use, for example, when designing a limited network connection between an
identifiable external system and cloud.
</p>
<h6>Fixed Fields</h6>
<div class="d-table table-responsive line-break">
<div class="d-table-row">
<p class="d-table-cell p-2 bg-primary text-white border">Field Name</p>
<p class="d-table-cell p-2 bg-primary text-white border">Type</p>
<p class="d-table-cell p-2 bg-primary text-white border">Description</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">type</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. Fixed value,
'<code>externalSystem</code>'.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">title</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8.<br>
The title of the external system interface.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">description</p>
<p class="d-table-cell p-2 bg-white text-dark border">Map[ <code>string</code>, <code>string</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
The key MUST be 2 letter language code of <a href="https://www.iso.org/iso-639-language-codes.html">ISO
639-1</a>.
And the value MUST be string of UTF-8. <br>
The description of the external system interface.
</p>
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">sourceIdentification</p>
<p class="d-table-cell p-2 bg-white text-dark border">[ <code>boolean</code> ]</p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>. Assigned specific IP
address range, domains and so on, or not.
If true, <code>identificationGroup</code> property is required.
</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">identificationGroup</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border">The group name of IP address range, domains and so
on..
Required when <code>sourceIdentification</code> propery is true. And MUST NOT use when
<code>sourceIdentification</code> propery is false.
</p>
</div>
</div>
<h6>JSON Example</h6>
<pre><code>{
<span class="token tag">"type": "externalSystem"</span>,
<span class="token tag">"title": </span>{
<span class="token tag">"en": </span>"API of SFA platform",
<span class="token tag">"ja": </span>"SFAプラットフォームのAPI",
<span class="token tag">"ru": </span>"API платформы SFA"
},
<span class="token tag">"description": </span>{
<span class="token tag">"en": </span>"Providing GET and POST interfaces of sales information.",
<span class="token tag">"ja": </span>"販売情報のGETおよびPOSTインターフェースを提供する外部システム",
<span class="token tag">"ru": </span>"Предоставление GET и POST интерфейсов информации о продажах."
},
<span class="token tag">"sourceIdentification": </span>true,
<span class="token tag">"identificationGroup": </span>"ipsOfSFA"
}</code></pre>
<h6>YAML Example</h6>
<pre><code><span class="token tag">type: externalSystem</span>
<span class="token tag">title: </span>
<span class="token tag">en: </span>API of SFA platform
<span class="token tag">ja: </span>SFAプラットフォームのAPI
<span class="token tag">ru: </span>API платформы SFA
<span class="token tag">description: </span>
<span class="token tag">en: </span>Providing GET and POST interfaces of sales information.
<span class="token tag">ja: </span>販売情報のGETおよびPOSTインターフェースを提供する外部システム
<span class="token tag">ru: </span>Предоставление GET и POST интерфейсов информации о продажах.
<span class="token tag">sourceIdentification: </span>true
<span class="token tag">identificationGroup: </span>ipsOfSFA
</code></pre>
<hr class="hr-dot-bold my-7">
<h3 id="s-resource">
<i class="fa fa-server mr-3" aria-hidden="true"></i>
Resource object<a class="anchor" href="#s-resource"></a>
</h3>
<p>
The object provides information about cloud resources used by this system.
It MUST be references of the external file formatted by JSON or YAML.
And it SHOULD be well-formatted data for cloud automation tools like below.<br>
<div class="font-italic">AWS CloudFormation</div>
<div class="font-italic">Azure Resource Manager</div>
<div class="font-italic">Google Cloud Deployment Manager</div>
<div class="font-italic">Alibaba Cloud Resource Orchestration Service</div>
<div class="font-italic">Terraform</div>
<div class="font-italic">Serverless Framework</div>
</p>
<h6>Fixed Fields</h6>
<div class="d-table table-responsive line-break">
<div class="d-table-row">
<p class="d-table-cell p-2 bg-primary text-white border">Field Name</p>
<p class="d-table-cell p-2 bg-primary text-white border">Type</p>
<p class="d-table-cell p-2 bg-primary text-white border">Description</p>
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">type</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>REQUIRED</strong>.
Type of the cloud automation language. It MUST be one of the following values.
<br><code>acf</code> : AWS CloudFormation.
<br><code>arm</code> : Azure Resource Manager.
<br><code>gdm</code> : Google Cloud Deployment Manager.
<br><code>aro</code> : Alibaba Cloud Resource Orchestration Service.
<br><code>tfm</code> : Terraform.
<br><code>slf</code> : Serverless Framework.
<br><code>oth</code> : Others.
</div>
<div class="d-table-row">
<p class="d-table-cell p-2 bg-white text-dark border">$ref</p>
<p class="d-table-cell p-2 bg-white text-dark border"><code>string</code></p>