-
Notifications
You must be signed in to change notification settings - Fork 0
/
index_ja.html
2441 lines (2352 loc) · 156 KB
/
index_ja.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="ja">
<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>クラウドデザイン仕様 - 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/ja/index.html" 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="/" target="_blank">
<span>English</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: クラウドデザイン仕様</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">はじめに</a>
<div class="nav">
<a class="nav-link small" href="#introduction">紹介</a>
<a class="nav-link small" href="#extension">デザイン拡張</a>
<a class="nav-link small" href="#tools">ツール</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link navParent" href="#general">概要</a>
<div class="nav">
<a class="nav-link small" href="#versions">バージョン</a>
<a class="nav-link small" href="#format">形式</a>
<a class="nav-link small" href="#structure">構造</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link navParent" href="#parentSchema">親スキーマ</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">子スキーマ</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">共通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">付録</a>
<div class="nav">
<a class="nav-link small" href="#resourcearticles">参考資料</a>
<a class="nav-link small" href="#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">はじめに<a class="anchor" href="#gettingstarted"></a></h2>
<div class="alert alert-secondary">
<p class="lead-2">本資料とツール群を使って、クラウドの要件定義をはじめましょう！</p>
<p>この文書は、<a href="https://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">
The Apache License, Version 2.0</a> のもとで公開されます。
</p>
<p>本書の各キーワード「せねばならない」、「してはならない」、「必要」、
「する／することになる」、「することはない」、「すべき」、「すべきでない」、「推奨される」、「してもよい／構わない／可能性がある」、「オプション」は、<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">紹介<a class="anchor" href="#introduction"></a></h3>
<p>クラウドデザイン仕様 (<b>the "CDS"</b>) はJSON/YAMLコードにより、人間とコンピュータの双方が理解できるよう、クラウドの利用要件を定義します。
<br>本ドキュメントにおいて、CDSという呼称は言語仕様そのものの名称であると同時に、同仕様に基づいて記述された設計コードを示します。以前は後者をCloud Design Definition(<b>the
"CDD"</b>)として明確に区別しましたが、混乱を避けるためCDSに統一されました。よってツールや周辺ドキュメントの一部にCDDの記述が存在しますが、CDSと同義とお考えいただいて問題ありません。
<hr class="hr-dot-bold my-7">
<h3 id="extension">既存のプロビジョニングコードの拡張 <a class="anchor" href="#introduction"></a></h3>
<p>
CDSはCloudFormationなど既存のプロビジョニングコードを拡張する要件定義コードです。クラウドの利用者やアクセスボリュームといったシステム要件を独自の仕様で記述し、クラウドリソースの定義は既存のプロビジョニングコードへの参照によって表現します。同構造により、デベロッパーの学習コストを抑え、既存コード資産の活用を促します。
<br>CDSが含むことのできるプロビジョニングコードの種類については、<a href="#s-resource">Resource object</a>をご参照下さい。
</p>
<hr class="hr-dot-bold my-7">
<h3 id="tools">ツール<a class="anchor" href="#tools"></a></h3>
<p>様々なツールを用いて、クラウドの設計を作成、保管、検索、再利用することができます。
<br><br>
<p><B>Cloud Design Schema 日本語</B><br>サードパーティー製エディタ等に組み込むことで、CDSの文法チェックに利用できるJSONスキーマファイルです。</p>
<a class="btn btn-primary mb-1" href="/ja/reindeer-schema_cds.json" target="_blank"
onClick="ga('send','event','btn', 'click', 'cds_schema_ja');">CDSルートスキーマのダウンロード</a>
<a class="btn btn-primary mb-1" href="/ja/reindeer-schema_cds-snippet.json" target="_blank"
onClick="ga('send','event','btn', 'click', 'CDS_snippet_schema_ja');">CDSスニペットスキーマのダウンロード</a>
<br><br>
<p><B>ForkMe!</B><br>Reindeer Technology
PTE.LTD.が提供する、クラウド設計管理ツールです。「クラウドの設計を、ソフトウェアのようにフォーク（複製／派生）したい」というデベロッパーの願いをかなえます。（Reindeer ProjectはReindeer
Technology PTE.LTD.に発展的に法人化されました。）
</p>
<p><a class="btn btn-primary mb-1" href="https://forkme.cloud/ja/" target="_blank"
onClick="ga('send','event','btn', 'click', 'hub_ja');">アクセス</a>
</p>
<p><B>Reindeer Editor</B><br>Reindeer Projectがサポートする、ドキュメント生成ツールです。CDSを編集し、クラウド
の利用に関するレポートを表示することができます。</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_editor_ja');">ダウンロード</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">概要<a class="anchor" href="#general"></a></h2>
<div class="alert alert-secondary">
<p class="lead-2">Cloud Designの概要を記載します。
</p>
</div>
<hr class="hr-dot-bold my-7">
<h3 id="versions">バージョン<a class="anchor" href="#versions"></a></h3>
<p>CDSは<a href="https://semver.org/spec/v2.0.0.html" target="_blank">Semantic Versioning 2.0.0</a>
(SemVer)を利用してバージョン管理され、
以下の仕様に従います。
<br>バージョンナンバーは<code>メジャー番号.マイナー番号.パッチ番号</code>の形でインクリメンタルに増加します。
<code>メジャー番号.マイナー番号</code>は１つ以上の機能セットを指定することになります。そして<code>.パッチ番号</code>は
後方互換性のあるバグ修正を指定することになります。
よって、パッチバージョンはツールの利用において考慮されるべきではありません。例えば1.0.0と1.0.1の間で、機能またはツールの区別はすべきではありません。
<hr class="hr-dot-bold my-7">
<h3 id="format">形式<a class="anchor" href="#format"></a></h3>
<p>CDSはJSONオブジェクトです。JSONまたはYAMLフォーマットの両方を用いて表現することができます。
YAMLとJSONフォーマットの互換性を維持するため、YAML利用時は以下いくつかの追加の制約に沿った上で、バージョン
<a href="https://yaml.org/spec/1.2/spec.html" target="_blank">1.2</a> の利用を推奨します。
<ul>
<li>タグは<a href="http://www.yaml.org/spec/1.2/spec.html#id2803231" target="_blank">JSON Schema
ruleset</a>で許可されているものに
限定する必要があります。</li>
<li>YAMLのmapで仕様されるキーは、<a href="http://yaml.org/spec/1.2/spec.html#id2802346" target="_blank">YAML Failsafe
schema ruleset</a>で
定義されているように、スカラー文字列に制限されなければなりません。</li>
</ul>
<p>仕様内のすべてのフィールド名は、大文字と小文字が<b>区別されます</b>。これには、
map型のキーとして仕様されるすべてのフィールドが含まれます。ただし、キーが大文字と小文字を<b>区別しない</b>と明示されている場合を除きます。
</p>
<hr class="hr-dot-bold my-7">
<h3 id="structure">構造<a class="anchor" href="#structure"></a></h3>
<p>CDSは単一のドキュメントで構成されるか、ユーザーの判断で複数のパーツに分割しても構いません。
ただし後者の場合でも、親（ルート）となるCDSは必ずすべての必須<a href="#parentSchema">親スキーマ</a>を内包する必要があります。
またパーツとして参照されるファイルは「CDSスニペット」と呼ばれ、<a href="#s-components">Components</a>オブジェクトだけを内包するようにします。
そしてルートファイルからCDSスニペットに対する参照を<code>$ref</code>フィールドで関連づけされねばなりません。
なお、ルートファイルはclouddesign.json」または「clouddesign.yaml」と命名されるべきです。
<!--
|‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒‒
| 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">親スキーマ<a class="anchor" href="#parentSchema"></a></h2>
<div class="alert alert-secondary">
<p class="lead-2">Cloud Designの主要なデータ構造を説明します。
以下の説明では、フィールドが明示的に「必須」と定義されない、または「しなければならない」または「する／することになる」と記載されていない場合、オプションと見なすことができます。
</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>これはCDSのルートオブジェクトです。</p>
<h6>固定フィールド</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">フィールド名</p>
<p class="d-table-cell p-2 bg-primary text-white border">種類</p>
<p class="d-table-cell p-2 bg-primary text-white border">説明</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>必須</strong>.
この文字列はCDS自体の<a href="#versions">semantic version number</a>でなければなりません。
<code>reindeer</code>フィールドは、CDSを解釈するためのツールに使用されるべきです。 これはinfo.versionフィールドとは関係ありません。
<br>
<span style="font-weight:bold;color:red"><a href="https://forkme.cloud/ja/" target="_blank">ForkMe!</a>では「1.3.2」をご指定ください。</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>必須</strong>.
この文字列はCDSのファイル名です。
拡張子は<code>.json</code>, <code>.yaml</code> または <code>.yml</code>でなければなりません。
<code>self</code>フィールドは、CDSを解釈するためのツールに使用されるべきです。
<span style="font-weight:bold;color:red"><a href="https://forkme.cloud/ja/" target="_blank">ForkMe!</a>では「cloudDesign.json」をご指定ください。</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>必須</strong>.
クラウドの活用に関するメタデータを提供します。 メタデータは、必要に応じてツールによって使用される場合があります。
</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>必須</strong>.
アクターオブジェクトの配列です。クラウドに接続する／される外部ユーザーまたはシステムに関する情報を提供します。
</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>必須</strong>.
クラウドの構造を記述する外部ドキュメント（プロビジョニングコードが記載されたファイル）への参照を示す、リソースオブジェクトの配列です。</p>.</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>必須</strong>.
コンテキストオブジェクトの配列です。アクターとクラウドリソースの間で、
特定の目的を達成するための関連性についての情報を提供します。
</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">CDSのさまざまな側面に対応する一連の再利用可能な
オブジェクトを保持します。 コンポーネントオブジェクト内で定義されたすべてのオブジェクトは、
それらがコンポーネントオブジェクトの外部のプロパティから
明示的に参照されない限り、クラウドの設計には影響しません。
</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>"サンプルシステム",
},
以下Infoスキーマ参照
},
<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>"顧客",
},
以下Actorスキーマ参照
}
},
<span class="token tag">"resources": </span>[
{
<span class="token tag">"$ref":</span>"awsTemplate.json",
以下Resourcesスキーマ参照
}
],
<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>"顧客によるウェブアクセス",
},
以下Contextsスキーマ参照
}
},
<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>"運用者",
},
以下Actorスキーマ参照
}
},
以下Componentsスキーマ参照
（Componentsは定義の再利用に便利なオプションスキーマです）
}
</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>
このオブジェクトはCDSに関するメタデータを提供します。
他の人がCDSを簡単に検索、発見できるよう、メタデータは適切に記入されるべきです。
</p>
<h6>固定フィールド</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">フィールド名</p>
<p class="d-table-cell p-2 bg-primary text-white border">種類</p>
<p class="d-table-cell p-2 bg-primary text-white border">説明</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>必須</strong>.
あなたの設計のバージョンです。（<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>必須</strong>. 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>必須</strong>.
このクラウドの設計を適用するサービスの名称です。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>.
このクラウドの設計を適用するサービスの説明です。
それはシステムの目的と機能のすべてのキーワードを含む簡潔なメモであるべきです。
このテキストは外部ツールによる検索インデックスとして使われる可能性があります。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>. CDSの状態です。
以下の値が利用できます。<br>
<code>draft: </code>ドラフト<br>
<code>prepared: </code>準備済<br>
<code>designed: </code>設計済<br>
<code>reviewed: </code>レビュー済<br>
</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>必須</strong>.
CDSが作成された日時です。UNIXタイムスタンプ形式を利用する必要があります。
</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>必須</strong>. CDSの作成者です。
この情報は外部ツールによって利用される可能性があり、関係者のスキルや経験を証明する重要な情報となります。
</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">CDS作成に関与する組織です。
この情報は外部ツールによって利用される可能性があり、組織のスキルや経験を証明する重要な情報となります。
</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">"sign": </span>xxxxxx123
},
<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>
クラウドにアクセスするユーザーや運用者、外部システムに関する情報を提供するオブジェクトです。
CDSを正しく設計、監査するため、包括的に表現されるべきです。
</p>
<hr class="hr-dot my-5">
<h3 id="s-actor-market" class="font-italic">マーケットタイプのアクターオブジェクト<a class="anchor" href="#s-actor-market"></a>
</h3>
<p>
このオブジェクトは特定のマーケットに属する消費者、観客など、不特定多数の利用者に関する情報を提供します。
システム提供対象となるユーザ数やリクエスト数を把握するため、正しい数値を提供すべきです。
</p>
<h6>固定フィールド</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">フィールド名</p>
<p class="d-table-cell p-2 bg-primary text-white border">種別</p>
<p class="d-table-cell p-2 bg-primary text-white border">説明</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>必須</strong>. 固定値： '<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>必須</strong>.
アクターの名称です。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>.
アクターの説明です。
このテキストは外部ツールによる検索インデックスとして使われる可能性があります。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>. アクターが属する市場に関する情報です。
</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>必須</strong>. 市場シェアを示します。
例えば <code>0.3</code> は 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>必須</strong>.
特定のIPアドレス範囲やドメイン名などで識別できるかどうかを意味します。
trueの場合、<code>identificationGroup</code> フィールドは必須です。
</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">IPアドレス範囲やドメイン名など。
<code>sourceIdentification</code> フィールドがtrueの場合は必須です。そして、<code>sourceIdentification</code>
が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">個人タイプのアクターオブジェクト<a class="anchor" href="#s-actor-persons"></a>
</h3>
<p>
このオブジェクトは、運用担当者のような1人または複数の人物で構成されているアクターの種類に関する情報を提供します。
識別可能な個人とクラウドとの制限されたネットワーク接続を設計する際などに、使用べき種類のアクターです。
</p>
<h6>固定フィールド</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">フィールド名</p>
<p class="d-table-cell p-2 bg-primary text-white border">種類 </p>
<p class="d-table-cell p-2 bg-primary text-white border">説明</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>必須</strong>. 固定値： '<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>必須</strong>.
アクターの名称です。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>.
アクターの説明です。
このテキストは外部ツールによる検索インデックスとして使われる可能性があります。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>. 本アクターを構成する人数です。</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>必須</strong>.
特定のIPアドレス範囲やドメイン名などで識別できるかどうかを意味します。
trueの場合、<code>identificationGroup</code> フィールドは必須です。
</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">IPアドレス範囲やドメイン名など。
<code>sourceIdentification</code> フィールドがtrueの場合は必須です。そして、<code>sourceIdentification</code>
が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">外部システムタイプのアクターオブジェクト<a class="anchor" href="#s-actor-system"></a>
</h3>
<p>
このオブジェクトは外部システムのAPIやファイルインターフェイスなど、1つまたはいくつかのシステムで構成される種類のアクターに関する情報を提供します。
識別可能な外部システムとクラウドとの制限されたネットワーク接続を設計する際などに、使用べき種類のアクターです。
</p>
<h6>固定フィールド</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">フィールド名</p>
<p class="d-table-cell p-2 bg-primary text-white border">種類</p>
<p class="d-table-cell p-2 bg-primary text-white border">説明</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>必須</strong>. 固定値：
'<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>必須</strong>.
アクターの名称です。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>.
アクターの説明です。
このテキストは外部ツールによる検索インデックスとして使われる可能性があります。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>必須</strong>.
特定のIPアドレス範囲やドメイン名などで識別できるかどうかを意味します。
trueの場合、<code>identificationGroup</code> フィールドは必須です。
</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">IPアドレス範囲やドメイン名など。
<code>sourceIdentification</code> フィールドがtrueの場合は必須です。そして、<code>sourceIdentification</code>
が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>
このオブジェクトは、利用するクラウドリソースに関する情報を提供します。
JSONまたはYAMLでフォーマットされた外部ファイルに対する参照でなければなりません。
そして、以下のようなクラウド自動化ツールのために、整形されたデータであるべきです。
<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>固定フィールド</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">フィールド名</p>
<p class="d-table-cell p-2 bg-primary text-white border">種類</p>
<p class="d-table-cell p-2 bg-primary text-white border">説明</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>必須</strong>.
プロビジョニングコードの種別です。以下値の中の１つである必要があります。
<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> : その他
</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>
<p class="d-table-cell p-2 bg-white text-dark border"><strong>必須</strong>.
プロビジョニングコードで記述されたファイルへの参照で、<a href="#s-ref">Reference object</a>の$refアイテムと同じです。
<code>.json</code>, <code>.yaml</code>, または <code>.yml</code>の拡張子を持つ外部ファイルを参照しなければなりません。
そしてその拡張子は、外部ツールによってリンク先のファイルフォーマットを検出するために利用されるべきものです。
</div>
</div>
<h6>JSON Example</h6>
<pre><code>{
<span class="token tag">"type": "acf"</span>,
<span class="token tag">"$ref": </span>"xxx.json"
}
</code></pre>
<h6>YAML Example</h6>
<pre><code><span class="token tag">type: acf</span>
<span class="token tag">$ref: </span>xxx.json
</code></pre>
<hr class="hr-dot-bold my-7">
<h3 id="s-context">
<i class="fa fa-route mr-3" aria-hidden="true"></i>
Context object<a class="anchor" href="#s-context"></a>
</h3>
<p>
このオブジェクトは、特定の機能を実行する目的でいくつかのアクターとリソースを関連付けることにより、
システムの利用ケースに関する情報を提供します。
それはCDSを正しく設計、監査するために、包括的に記述されるべきです。
</p>
<h6>固定フィールド</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">フィールド名</p>
<p class="d-table-cell p-2 bg-primary text-white border">種類</p>
<p class="d-table-cell p-2 bg-primary text-white border">説明</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>必須</strong>.
コンテキストの名称です。
キーは<a href="https://www.iso.org/iso-639-language-codes.html">ISO 639-1</a>の2文字の言語コードでなければなりません。
そして値はUTF-8の文字列でなければなりません。
</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>