CDS: クラウドデザイン仕様

はじめに

---

紹介

クラウドデザイン仕様 (the "CDS") はJSON/YAMLコードにより、人間とコンピュータの双方が理解できるよう、クラウドの利用要件を定義します。
本ドキュメントにおいて、CDSという呼称は言語仕様そのものの名称であると同時に、同仕様に基づいて記述された設計コードを示します。以前は後者をCloud Design Definition(the "CDD")として明確に区別しましたが、混乱を避けるためCDSに統一されました。よってツールや周辺ドキュメントの一部にCDDの記述が存在しますが、CDSと同義とお考えいただいて問題ありません。

---

既存のプロビジョニングコードの拡張

CDSはCloudFormationなど既存のプロビジョニングコードを拡張する要件定義コードです。クラウドの利用者やアクセスボリュームといったシステム要件を独自の仕様で記述し、クラウドリソースの定義は既存のプロビジョニングコードへの参照によって表現します。同構造により、デベロッパーの学習コストを抑え、既存コード資産の活用を促します。
CDSが含むことのできるプロビジョニングコードの種類については、Resource objectをご参照下さい。

---

ツール

様々なツールを用いて、クラウドの設計を作成、保管、検索、再利用することができます。

Cloud Design Schema 日本語
サードパーティー製エディタ等に組み込むことで、CDSの文法チェックに利用できるJSONスキーマファイルです。

CDSルートスキーマのダウンロード   CDSスニペットスキーマのダウンロード

ForkMe!
Reindeer Technology PTE.LTD.が提供する、クラウド設計管理ツールです。「クラウドの設計を、ソフトウェアのようにフォーク（複製／派生）したい」というデベロッパーの願いをかなえます。（Reindeer ProjectはReindeer Technology PTE.LTD.に発展的に法人化されました。）

アクセス

Reindeer Editor
Reindeer Projectがサポートする、ドキュメント生成ツールです。CDSを編集し、クラウド の利用に関するレポートを表示することができます。

ダウンロード

概要

---

バージョン

CDSはSemantic Versioning 2.0.0 (SemVer)を利用してバージョン管理され、 以下の仕様に従います。
バージョンナンバーはメジャー番号.マイナー番号.パッチ番号の形でインクリメンタルに増加します。 メジャー番号.マイナー番号は１つ以上の機能セットを指定することになります。そして.パッチ番号は 後方互換性のあるバグ修正を指定することになります。 よって、パッチバージョンはツールの利用において考慮されるべきではありません。例えば1.0.0と1.0.1の間で、機能またはツールの区別はすべきではありません。

---

形式

CDSはJSONオブジェクトです。JSONまたはYAMLフォーマットの両方を用いて表現することができます。 YAMLとJSONフォーマットの互換性を維持するため、YAML利用時は以下いくつかの追加の制約に沿った上で、バージョン 1.2 の利用を推奨します。

• タグはJSON Schema rulesetで許可されているものに 限定する必要があります。
• YAMLのmapで仕様されるキーは、YAML Failsafe schema rulesetで 定義されているように、スカラー文字列に制限されなければなりません。

仕様内のすべてのフィールド名は、大文字と小文字が区別されます。これには、 map型のキーとして仕様されるすべてのフィールドが含まれます。ただし、キーが大文字と小文字を区別しないと明示されている場合を除きます。

---

構造

CDSは単一のドキュメントで構成されるか、ユーザーの判断で複数のパーツに分割しても構いません。 ただし後者の場合でも、親（ルート）となるCDSは必ずすべての必須親スキーマを内包する必要があります。 またパーツとして参照されるファイルは「CDSスニペット」と呼ばれ、Componentsオブジェクトだけを内包するようにします。 そしてルートファイルからCDSスニペットに対する参照を$refフィールドで関連づけされねばなりません。 なお、ルートファイルはclouddesign.json」または「clouddesign.yaml」と命名されるべきです。

親スキーマ

---

Cloud Design Object

これはCDSのルートオブジェクトです。

固定フィールド

JSON example

{
  "reindeer": "1.3.2",
  "self": "cloudDesign.json"
  "info": {
    "title": {
      "en": "Sample system",
      "ja": "サンプルシステム",
    },
    以下Infoスキーマ参照
  },
  "actors": {
      "customer": {
        "title": {
          "en": "Customers",
          "ja": "顧客",
        },
        以下Actorスキーマ参照
      }
  },
  "resources": [
      {
        "$ref":"awsTemplate.json",
        以下Resourcesスキーマ参照
      }
  ],
  "contexts": {
    "customerWebAccess": {
      "title": {
        "en": "Web access by customer",
        "ja": "顧客によるウェブアクセス",
      },
      以下Contextsスキーマ参照
    }
  },
  "components": {
    "actors": {
      "operator": {
        "title": {
          "en": "Operator",
          "ja": "運用者",
        },
        以下Actorスキーマ参照
      }
    },
    以下Componentsスキーマ参照
    （Componentsは定義の再利用に便利なオプションスキーマです）
}

---

Info object

このオブジェクトはCDSに関するメタデータを提供します。 他の人がCDSを簡単に検索、発見できるよう、メタデータは適切に記入されるべきです。

固定フィールド

JSON example

{
  "version": "1.0.0",
  "license": {
      "type": "CC0"
  },
  "title": {
      "en": "Sample system",
      "ja": "サンプルシステム",
      "ru": "Образец системы"
  },
  "description": {
      "en": "Sample description",
      "ja": "説明サンプル",
      "ru": "Пример описания"
  },
  "status": "draft",
  "designedAt": "1548731447",
  "authors": {
      "sampleHandleNameA": {
            "roles": ["designer"],
            "joinedAt": 1548730447,
            "leavedAt": 1548731447,
            "sign": xxxxxx123
      },
      "sampleHandleNameB": {
            "roles": ["designer", "auditor"],
            "joinedAt": 1548730447
      }
    },
    "organizations": {
      "sampleCompanyA": {
            "joinedAt": 1548730447,
            "leavedAt": 1548731447
      },
      "sampleCompanyB": {
            "joinedAt": 1548730447,
            "sign": xxxxxx123
      }
    }
}

YAML example

version: 1.0.0
license: 
      type: CC0
title: 
      en: Sample system
      ja: サンプルシステム
      ru: Образец системы
description: 
      en: Sample description
      ja: 説明サンプル
      ru: Пример описания
status: draft
designedAt: 1548731447
authors: 
      sampleHandleNameA: 
            roles: 
                  - designer
            joinedAt: 1548730447
            leavedAt: 1548731447
      sampleHandleNameB: 
            roles: 
                  - designer
                  - auditor
            sign: xxxxxxx123

            joinedAt: 1548730447
      organizations: 
            sampleHandleNameA: 
                  joinedAt: 1548730447
                  leavedAt: 1548731447
                  sign: xxxxxxx123
            sampleHandleNameB: 
                  joinedAt: 1548730447

---

Actor objects

クラウドにアクセスするユーザーや運用者、外部システムに関する情報を提供するオブジェクトです。 CDSを正しく設計、監査するため、包括的に表現されるべきです。

---

マーケットタイプのアクターオブジェクト

このオブジェクトは特定のマーケットに属する消費者、観客など、不特定多数の利用者に関する情報を提供します。 システム提供対象となるユーザ数やリクエスト数を把握するため、正しい数値を提供すべきです。

固定フィールド

JSON Example

{
  "type": "market",
  "title": {
        "en": "Customers", 
        "ja": "顧客",
        "ru": "Клиенты"
  },
  "description": {
        "en": "Users of our products.",
        "ja": "当社製品の利用ユーザー",
        "ru": "Пользователи нашей продукции."
  },
  "market": {
        "title": {
              "en": "65 years and over in U.S., July 2018", 
              "ja": "65才以上の人口　米国　2018年7月",
              "ru": "65 лет и старше в США, июль 2018 года"
        },
        "description": {
              "en": "General population data of U.S. at 2018 by govermental research.",
              "ja": "米国政府による2018年の人口統計",
              "ru": "Данные об общей численности населения США на 2018\nгод по данным государственных исследований."
        },
        "num": 51038120,
        "estimatedBy": "U.S. Census Bureau",
        "estimatedAt": 1530370800
  },
  "marketShare": 0.01,
  "sourceIdentification": false
}

YAML Example

type: market
title: 
      en: Customers 
      ja: 顧客
      ru: Клиенты
description: 
      en: Users of our products.
      ja: 当社製品の利用ユーザー
      ru: Пользователи нашей продукции.
market: 
      title: 
            en: 65 years and over in U.S., July 2018 
            ja: 65才以上の人口　米国　2018年7月
            ru: 65 лет и старше в США, июль 2018 года
      description: 
            en: General population data of U.S. at 2018 by govermental research.
            ja: 米国政府による2018年の人口統計
            ru: | 
                Данные об общей численности населения США на 2018
                год по данным государственных исследований.
      num: 51038120
      estimatedBy: U.S. Census Bureau
      estimatedAt: 1530370800
marketShare: 0.01
sourceIdentification: false

---

個人タイプのアクターオブジェクト

このオブジェクトは、運用担当者のような1人または複数の人物で構成されているアクターの種類に関する情報を提供します。 識別可能な個人とクラウドとの制限されたネットワーク接続を設計する際などに、使用べき種類のアクターです。

固定フィールド

JSON example

{
  "type": "persons",
  "title": {
      "en": "Operators",
      "ja": "運用担当者",
      "ru": "операторы"
  },
  "description": {
      "en": "Operators using management console.",
      "ja": "管理コンソールを利用する運用担当者",
      "ru": "Операторы, использующие консоль управления."
  },
  "num": 7,
  "sourceIdentification": true,
  "identificationGroup": "IPsOfOperatorGroupA"
}

YAML example

type: persons
title: a
      en: Operators 
      ja: 運用担当者
      ru: операторы
description: 
      en: Operators using management console.
      ja: 管理コンソールを利用する運用担当者
      ru: Операторы, использующие консоль управления.
num: 7
sourceIdentification: true
identificationGroup: IPsOfOperatorGroupA

---

外部システムタイプのアクターオブジェクト

このオブジェクトは外部システムのAPIやファイルインターフェイスなど、1つまたはいくつかのシステムで構成される種類のアクターに関する情報を提供します。 識別可能な外部システムとクラウドとの制限されたネットワーク接続を設計する際などに、使用べき種類のアクターです。

固定フィールド

JSON Example

{
  "type": "externalSystem",
  "title": {
        "en": "API of SFA platform",
        "ja": "SFAプラットフォームのAPI",
        "ru": "API платформы SFA"
  },
  "description": {
        "en": "Providing GET and POST interfaces of sales information.",
        "ja": "販売情報のGETおよびPOSTインターフェースを提供する外部システム",
        "ru": "Предоставление GET и POST интерфейсов информации о продажах."
  },
  "sourceIdentification": true,
  "identificationGroup": "ipsOfSFA"
}

YAML Example

type: externalSystem
title: 
      en: API of SFA platform
      ja: SFAプラットフォームのAPI
      ru: API платформы SFA
description: 
      en: Providing GET and POST interfaces of sales information.
      ja: 販売情報のGETおよびPOSTインターフェースを提供する外部システム
      ru: Предоставление GET и POST интерфейсов информации о продажах.
sourceIdentification: true
identificationGroup: ipsOfSFA

---

Resource object

このオブジェクトは、利用するクラウドリソースに関する情報を提供します。 JSONまたはYAMLでフォーマットされた外部ファイルに対する参照でなければなりません。 そして、以下のようなクラウド自動化ツールのために、整形されたデータであるべきです。

固定フィールド

JSON Example

{
  "type": "acf",
  "$ref": "xxx.json"
}

YAML Example

type: acf
$ref: xxx.json

---

Context object

このオブジェクトは、特定の機能を実行する目的でいくつかのアクターとリソースを関連付けることにより、 システムの利用ケースに関する情報を提供します。 それはCDSを正しく設計、監査するために、包括的に記述されるべきです。

固定フィールド

JSON Example

{
  "title": {
        "en": "Customers view",
        "ja": "カスタマー閲覧",
        "ru": "Просмотр клиента"
  },
  "description": {
        "en": "Custormer's web site view of static contents through internet.",
        "ja": "インターネット経由の静的コンテンツ閲覧",
        "ru": "Просмотр статического содержимого через Интернет"
  },
  "trigger": {
        "$ref": "#/components/triggers/trigger1"
  },
  "traffics": [
        {"$ref": "#/components/traffics/traffic1"},
        {"$ref": "#/components/traffics/traffic2"},
        {"$ref": "#/components/traffics/traffic3"}
  ],
  "maxPerformanceDurationRatio": 0.1
}

YAML Example

title: 
      en: Customers view
      ja: カスタマー閲覧
      ru: Просмотр клиента
description: 
      en: Custormer's web site view of static contents through internet.
      ja: インターネット経由の静的コンテンツ閲覧
      ru: Просмотр статического содержимого через Интернет
trigger: 
      $ref: #/components/triggers/trigger1
traffics: 
      - $ref: #/components/traffics/traffic1
      - $ref: #/components/traffics/traffic2
      - $ref: #/components/traffics/traffic3
maxPerformanceDurationRatio: 0.1

---

Components object

CDSのさまざまな側面に対応する一連の再利用可能なオブジェクトを保持します。 componentsオブジェクト内で定義されたすべてのオブジェクトは、それらがcomponentsオブジェクトの外のプロパティから明示的に参照されない限り、CDSに影響を与えません。

固定フィールド

子スキーマ

---

License object

CDSのライセンス情報です。

固定フィールド

JSON Examples

RECOMMENDED
{
  "type": "CC0"
}

{
  "type": "Closed",
  "provider": "Reindeer technology PTE.LTD."
}

YAML Examples

RECOMMENDED
type: CC0

type: Closed
provider: Reindeer technology PTE.LTD.

---

Author object

このオブジェクトは、CDSの作者とその役割についての情報を提供します。 対象のシステム、クラウド技術、そして同システムのサービス提供市場について正しい知識を持っている人を 他の人が見つけるのを助けるため、包括的に記載されるべきです。

固定フィールド

JSON Example

{
  "roles": ["designer","auditor"],
  "joinedAt": 1548730447,
  "leavedAt": 1548731447,
  "sign": ABC123DEF456HIJ789#abc
}

YAML Example

roles: 
      - designer
      - auditor
joinedAt: 1548730447
leavedAt: 1548731447
sign: ABC123DEF456HIJ789#abc

---

Organization object

このオブジェクトは、CDSの関連組織とその役割についての情報を提供します。 対象のシステム、クラウド技術、そして同システムのサービス提供市場について正しい知識を持っている組織を 他の人が見つけるのを助けるため、包括的に記載されるべきです。

固定フィールド

JSON Example

{
"joinedAt": 1548730447,
"leavedAt": 1548731447,
"sign": ABC123DEF456HIJ789#abc
}

YAML Example

joinedAt: 1548730447
leavedAt: 1548731447
sign: ABC123DEF456HIJ789#abc

---

Market object

マーケットに関する情報を提供します。あなた自身、または第三者の調査結果を内包する可能性があります。

固定フィールド

JSON Example

{
  "title": {
        "en": "65 years and over in U.S., July 2018", 
        "ja": "65才以上の人口　米国　2018年7月",
        "ru": "65 лет и старше в США, июль 2018 года"
  },
  "description": {
        "en": "General population data of U.S.\n at 2018 by govermental research.",
        "ja": "米国政府による2018年の人口統計",
        "ru": "Данные об общей численности населения США\n на 2018 год по данным государственных исследований."
  },
  "population": 51038120,
  "estimatedBy": "U.S. Census Bureau",
  "estimatedAt": 1530370800
}

YAML Example

title: 
      en: 65 years and over in U.S., July 2018 
      ja: 65才以上の人口　米国　2018年7月
      ru: 65 лет и старше в США, июль 2018 года
description: 
      en: |
      General population data of U.S. 
      at 2018 by govermental research.
      ja: 米国政府による2018年の人口統計
      ru: |
      Данные об общей численности населения США 
      на 2018 год по данным государственных исследований.
population: 51038120
estimatedBy: U.S. Census Bureau
estimatedAt: 1530370800

---

Trigger objects

contextの初期イベントに関する情報を提供します。 それはサーバへの人的なWebアクセス、または外部APIへの自動化された時限呼び出しである可能性があります。

---

Webアクセスタイプのトリガーオブジェクト

これはアクターによるトリガーの一種です。アクターによるクラウドリソースへのWebアクセスを表現します。 アクターは人間または外部システムの可能性があります。

固定フィールド

JSON Example

{
  "type": "webAccess",
  "description": {
    "en": "API call for movie data acquisition.",
    "ja": "動画データ取得のためのAPI呼び出し。",
    "ru": "API вызов для сбора данных фильма"
  },
  "infoType": {
        "$ref": "#/components/infoType/general"
  },
  "ports": [443],
  "internet": true,
  "restriction": false,
  "dau": {"max": 0.1, "min": 0.03},
  "pagesVisit": {"max": 10, "min": 10},
  "kbPage": {"max": 1024, "min": 1024},
  "reqPage": {"max": 100, "min": 100},
  "busyHours": {"max": 3, "min": 3},
  "postRatio": {"max": 0.1, "min": 0.001},
  "kbPost": {"max": 100, "min": 100},
  "start": {
        "$ref": "#/actors/customer"
  },
  "end": [
        {"$ref": "#/resources/awsCloudEnvironment/data/Resources/cloudFront"}
  ],
  "endpointTitle": {
    "en": "LoadBalancer",
    "ja": "ロードバランサ",
    "ru": "Балансировщик нагрузки"
  },
  "storedRatio": {"max": 0.3, "min": 0.1},
  "storedInfoType": {
    "$ref": "#/components/infoType/general"
  },
  "storageDescription": {
    "en": "Logging for API usage tracing.",
    "ja": "API利用状況把握のためのログ保管",
    "ru": "Хранение журнала для статуса использования API"
  }
}

YAML Example

type: webAccess
description: {
      en: Static content distribution,
      ja: 静的コンテンツの配信,
      ru: Распределение статического контента
infoType: 
      $ref: #/components/infoType/general
ports: [443]
internet: true
restriction: false
dau: {max: 0.1, min: 0.03}
pagesVisit: {max: 10, min: 10}
kbPage: {max: 1024, min: 1024}
reqPage: {max: 100, min: 100}
busyHours: {max: 3, min: 3}
postRatio: {max: 0.1, min: 0.001}
kbPost: {max: 100, min: 100}
start: 
      $ref: #/actors/customer
end: 
      - $ref: #/resources/awsCloudEnvironment/data/Resources/cloudFront
endpointTitle: 
      en: LoadBalancer
      ja: ロードバランサ
      ru: Балансировщик нагрузки
storedRatio: {max: 0.5, min: 0.3}
storedInfoType: 
      $ref: #/components/infoType/general
storageDescription: {
      en: Logging for API usage tracing.,
      ja: API利用状況把握のためのログ保管,
      ru: Хранение журнала для статуса использования API

---

時限アクションタイプのトリガーオブジェクト

これはアクターまたはコンピューティングリソースによって発動されるタイプのトリガーです。 アクターまたはcloud computingリソースからの時限アクションを表現します。

固定フィールド

JSON Example

{
  "type": "timedAction",
  "description": {
    "en": "API call for movie data acquisition.",
    "ja": "動画データ取得のためのAPI呼び出し。",
    "ru": "API вызов для сбора данных фильма"
  },
  "infoType": {
        "$ref": "#/components/infoType/general"
  },
  "ports": [443],
  "internet": false,
  "restriction": false,
  "onlineRps": {"max": 3, "min": 1},
  "reqMonth": {"max": 9000, "min": 5000},
  "kbRequest": {"max": 0.01, "min": 0.01},
  "kbResponse": {"max": 1, "min": 1},
  "start": {
        "$ref": "#/resources/awsCloudEnvironment/resources/jobServer"
  },
  "end": [
        {"$ref": "##/actors/api"}
  ],  
  "endpointTitle": {
    "en": "LoadBalancer",
    "ja": "ロードバランサ",
    "ru": "Балансировщик нагрузки"
  },
  "storedRatio": {"max": 0.3, "min": 0.1},
  "storedInfoType": {
    "$ref": "#/components/infoType/general"
  },
  "storageDescription": {
    "en": "Logging for API usage tracing.",
    "ja": "API利用状況把握のためのログ保管",
    "ru": "Хранение журнала для статуса использования API"
  }

}

YAML Example

type: timedAction
description: {
      en: Static content distribution,
      ja: 静的コンテンツの配信,
      ru: Распределение статического контента
infoType: 
      $ref: #/components/infoType/general
ports: [443]
internet: false
restriction: false
onlineRps: {max: 3, min: 1}
reqMonth: {max: 9000, min: 5000}
kbRequest: {max: 0.01, min: 0.01}
kbResponse: {max: 1, min: 1}
start: 
      $ref: #/resources/awsCloudEnvironment/resources/jobServer
end: 
      - $ref: #/actors/api
endpointTitle: 
      en: LoadBalancer
      ja: ロードバランサ
      ru: Балансировщик нагрузки
storedRatio: {max: 0.5, min: 0.3}
storedInfoType: 
      $ref: #/components/infoType/general
storageDescription: {
      en: Logging for API usage tracing.,
      ja: API利用状況把握のためのログ保管,
      ru: Хранение журнала для статуса использования API
 

---

Traffic objects

context内の通信に関する情報を提供します。これはトリガーイベントの後続処理で利用されなければなりません。 例えばWebサーバーからアプリケーションサーバへの動的コンテンツ要求や、アプリケーションサーバからデータベースへのデータ保存などが表現されます。

---

パススルー比率タイプのトラフィックオブジェクト

これはトラフィックオブジェクトの一種です。開始点が受信したリクエストの一部を後続のリソースに受け渡すという形で発生する通信を表現できます。 例えばロードバランサが受けたリクエストをWebサーバに送信する、アプリケーションが受けたリクエストにもとづいてメール配信キューを生成するといった通信の連鎖が表現できます。 その際、本トラフィックのエンドポイント(endフィールド)が受信するデータサイズは、本トラフィックの前段の通信（sourceフィールド）が 受信したリクエストの何パーセントにあたるかといった表現方法になります。したがって、前段の通信が1MBのPOST値を受け取った後にサーバ内で3MBにデータを拡張して 本トラフィックのエンドポイントに受け渡すといった場合には、データサイズは300%になる（passThroughReqRatio>フィールドが3）と表現できます。

固定フィールド

JSON Example

{
  "type": "passThroughRatio",
  "description": {
    "en": "Static content distribution",
    "ja": "静的コンテンツの配信",
    "ru": "Распределение статического контента"
  },
  "infoType": {
        "$ref": "#/components/infoType/general"
  },
  "ports": [80],
  "internet": false,
  "restriction": false,
  "source": {"$ref": "#/trigger/customer"},
  "end": [
        {"$ref": "#/resources/awsCloudEnvironment/data/Resources/s3"}
  ],
  "passThroughReqRatio": {"max": 1, "min": 0.1},
  "compositResRatio": {"max": 0.5, "min": 0.5},
  "endpointTitle": {
    "en": "LoadBalancer",
    "ja": "ロードバランサ",
    "ru": "Балансировщик нагрузки"
  },
  "storedRatio": {"max": 0.3, "min": 0.1},
  "storedInfoType": {
    "$ref": "#/components/infoType/general"
  },
  "storageDescription": {
    "en": "Logging for API usage tracing.",
    "ja": "API利用状況把握のためのログ保管",
    "ru": "Хранение журнала для статуса использования API"
  }
}

YAML Example

type: passThroughRatio
description: {
      en: Static content distribution,
      ja: 静的コンテンツの配信,
      ru: Распределение статического контента
infoType: 
      $ref: #/components/infoType/general
ports: [80]
internet: false
restriction: false
source: 
      $ref: #/trigger/customer
end: 
    - $ref: #/resources/awsCloudEnvironment/data/Resources/s3
passThroughReqRatio: {max: 1, min: 0.1}
compositResRatio: {max: 0.5, min: 0.5}
endpointTitle: 
      en: LoadBalancer
      ja: ロードバランサ
      ru: Балансировщик нагрузки
storedRatio: {max: 0.5, min: 0.3}
storedInfoType: 
      $ref: #/components/infoType/general
storageDescription: {
      en: Logging for API usage tracing.,
      ja: API利用状況把握のためのログ保管,
      ru: Хранение журнала для статуса использования API
  

---

InfoType object

情報の種類と必要なセキュリティレベルを表します。 本オブジェクトにより、取り扱う情報タイプを定義し、クラウドリソースで 受信、保存、処理される情報を分類すべきです。

固定フィールド

JSON Example

{
  "title": {
        "en": "privacy level", 
        "ja": "個人情報取り扱いレベル",
        "ru": "Чувствительный уровень"
  },
  "description": {
        "en": "Contains privacy information.",
        "ja": "個人情報を含む",
        "ru": "Содержит конфиденциальную личную информацию."
  },
  "confidential": true,
  "privacy": true,
  "definedBy": "ABC company",
  "definedAt": 1530370800
}

YAML Example

title: 
      en: confidential level 
      ja: 個人情報取り扱いレベル
      ru: Чувствительный уровень
description: 
      en: Contains privacy information.
      ja: 個人情報を含む
      ru: Содержит конфиденциальную личную информацию.
confidential: true
privacy: true
definedBy: ABC company
definedAt: 1530370800

Common Schema

---

Range values object

CDSの様々なフィールドで利用される、値範囲を示すオブジェクトです。

固定フィールド

JSON Example

{
  "max": 1.0,
  "min": 0.01
}

YAML Example

max: 1.0
min: 0.01

---

Reference object

CDSの様々なフィールドからCDSやクラウドオートメーションツール用ファイル内のjson/yamlオブジェクトを 参照する際に利用する参照先指定オブジェクトです。参照オブジェクトはJSON参照によって定義されており、 同じ構造、動作、および規則に従います。 この仕様では、参照の解決はJSONスキーマ仕様ではなく JSON参照仕様で定義されているとおりに行われます。

固定フィールド

JSON Example

{
  "$ref": "#/components/actors/custormers"
}

JSON Relative Documents With Embedded Schema Example

{
  "$ref": "externalfile.yaml#/components/actors/custormers"
}

YAML Example

$ref: #/components/actors/custormers

YAML Relative Documents With Embedded Schema Example

$ref: externalfile.yaml#/components/actors/custormers

付録

---

参考資料

Cloud Design仕様は Reindeer Projectの 一環として生まれました。
Reindeer Projectはクラウド活用の支援を通じて、すべての人々につくる力を届けたいと願っています。
誰もが自分の力でサービスを創造できる社会は、表現の自由と生活様式や価値観の多様性をもたらすだけではありません。それはまた、すべての人々に対する富の再分配を促進し、世界中の人々の平均的な富と幸福を改善すると信じています。

ホワイトペーパー
Reindeer projectの目的と計画が記されています。

Cloud Design の6状態
今後のツールとエコシステム展開のイメージです。

---

商標

---

リビジョン