作者 | 孫健波（天元）阿里雲技術專家

**導讀**：OAM Spec 經歷了近 3 個月的迭代，[v1alpha2](https://mp.weixin.qq.com/s/c7A8lOdAKkW25GoqmwOgWg) 版本終於釋出啦！新版本在堅持 OAM Spec 平臺無關的基礎上，整體變得更 Kubernetes 友好化，很大程度上平衡了標準與可擴充套件性，更好的支援 CRD。如果你已經編寫了現成的 CRD Operator，可以平滑的接入到 OAM 體系中，並且享受到 OAM 模型的紅利。

目前 OAM 已經成為了包括阿里、微軟、Upbond、諧雲等多家公司構建雲產品的核心架構。他們透過 OAM 構建了“以應用為中心”、使用者友好化的 Kubernetes PaaS；充分發揮 OAM 的標準化與可擴充套件性，實現 OAM 核心 Controller 的同時，快速接入了已有的 Operator 能力；透過 OAM 橫向打通多個模組，破除了原有 Operator 彼此孤立、無法複用的窘境。<br>

- 瞭解 OAM 的背景及由來，可以參考[《深度解讀！阿里統一應用管理架構升級的教訓與實踐》](http://mp.weixin.qq.com/s?__biz=MzUzNzYxNjAzMg==&mid=2247489722&idx=1&sn=cdac0fad138b3b989af29d5fafcf38ad&chksm=fae51375cd929a63f27bba4b6d68cd613c3311bdbef54b7bcdbb674a800ab57aca37244831a4&scene=21#wechat_redirect)；

- OAM 能為終端使用者帶來哪些價值？可以參考[《OAM 深入解讀：OAM 為雲原生應用帶來哪些價值？》](http://mp.weixin.qq.com/s?__biz=MzUzNzYxNjAzMg==&mid=2247489060&idx=1&sn=211fbe2114f164f7230cbf0bed7f1420&chksm=fae51debcd9294fd509f633521b020316f9cf88e08c8a1821761742ff1715c8826e4428b4255&scene=21#wechat_redirect)

下面言歸正傳，讓我們來看一下 v1alpha2 到底做了哪些改動？

# 主要改動說明

為了方便大家閱讀，這裡只羅列了最主要的改動點，一些細節還是以上游 [OAM Spec Github](https://github.com/oam-dev/spec) 倉庫為準。

## 術語說明

- CRD（Custom Resource Definition）：在 OAM 中說的 CRD 是一種泛指的自定義資源描述定義。在 K8s 的 OAM 實現中可以完全對應 K8s 的 CRD，在非 K8s 的實現中，OAM 的 CRD 需要包含 APIVersion/Kind 並且能夠描述欄位進行校驗；

- CR （Custom Resource），OAM 中的 CR 是 CRD 的一個例項，是符合 CRD 中欄位格式定義的一個資源描述。在 K8s 的 OAM 實現中可以完全對應 K8s 的 CR，在 非 K8s 的實現中，可以需要對齊 APIVersion/Kind  和欄位格式定義。

## 主要改動 1 使用 Reference 模型定義 Workload、Trait 和 Scope

v1alpha1 原先的方式是這樣的：

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: WorkloadType
metadata:
  name: OpenFaaS
  annotations:
    version: v1.0.0
    description: "OpenFaaS a Workload which can serve workload running as functions"
spec:
  group: openfaas.com
  version: v1alpha2
  names:
    kind: Function
    singular: function
    plural: functions
  workloadSettings: |
    {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "object",
      "required": [
        "name", "image"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "the name to the function"
        },
        "image": {
          "type": "string",
          "description": "the docker image of the function"
        }
      }
    }
```

在原先的模式中，group/version/kind 分別是欄位，spec 的校驗透過 jsonschema 表示，整體的格式實際上類似 CRD，但不完全一致。

新版 v1alpha2 中徹底改為了引用模型，透過 `WorkloadDefinition`  `TraitDefinition`  `ScopeDefinition` 的形式，描述了一個引用關係。可以直接引用一個 CRD，name 就是 CRD 的名稱。對於非 K8s 的 OAM 實現來說，這裡的名字則是一個索引，可以找到類似 CRD 的校驗檔案，校驗檔案中包含 apiVersion 和 kind，以及相應的 schema 校驗。

- Workload

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: WorkloadDefinition
metadata:
  name: containerisedworkload.core.oam.dev
spec:
  definitionRef:
    # Name of CRD. 
    name: containerisedworkload.core.oam.dev
```

- Trait

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: TraitDefinition
metadata:
  name: manualscalertrait.core.oam.dev
spec:
  appliesToWorkloads:
    - containerizedworkload.core.oam.dev
  definitionRef:
    name: manualscalertrait.core.oam.dev
```

- Scope

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: ScopeDefinition
metadata:
  name: networkscope.core.oam.dev
spec:
  allowComponentOverlap: true
  definitionRef:
    name: networkscope.core.oam.dev
```

注意：

1.  這裡對於 K8s 的 OAM 實現來說，name 就是 K8s 裡面 CRD 的 name，由 `<plural-kind>.<group>` 組成。社群的最佳實踐是一個 CRD 只有一個 version 在叢集中執行，一般新 version 都會向前相容，升級時都一次性替換到最新 version。如果確實有 2 個 version 同時存在的場景，使用者也可以透過 `kubectl get crd <name>` 的方式進一步選擇；

2. Definition 這一層不面向 end user，主要給平臺實現使用，對於非 K8s 實現來說，如果存在多個 version 的場景，OAM 的實現平臺可以給終端使用者展示不同 version 的選擇。

## 主要改動 2 直接嵌入 K8s CR 作為 Component 和 Trait 例項

原先的方式在 Workload 和 Trait 層面我們都只把 CR 的 spec 部分拿出來，分別放在 `workloadSettings` 和 `properties` 欄位裡。

這樣的方式雖然已經可以“推導”出 K8s CR，但是不利於 K8s 生態內的 CRD 接入，需要換種格式重新定義一遍 spec。

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: ComponentSchematic
metadata:
  name: rediscluster
spec:
  workloadType: cache.crossplane.io/v1alpha1.RedisCluster
  workloadSettings:
    engineVersion: 1.0
    region: cn
```

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: ApplicationConfiguration
metadata:
  name: custom-single-app
  annotations:
    version: v1.0.0
    description: "Customized version of single-app"
spec:
  variables:
  components:
    - componentName: frontend
      instanceName: web-front-end
      parameterValues:
      traits:
        - name: manual-scaler
          properties:
            replicaCount: 5
```

現在的方式則直接嵌入 CR，可以看到，在 `workload` 和 `trait` 欄位下面是完整的 CR 描述。

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: Component
metadata:
  name: example-server
spec:
  prameters:
    - name: xxx
      fieldPaths: 
        - "spec.osType"
  workload:
    apiVersion: core.oam.dev/v1alpha2
    kind: Server
    spec:
      osType: linux
      containers:
      - name: my-cool-server
        image:
          name: example/very-cool-server:1.0.0
        ports:
        - name: http
          value: 8080
        env:
        - name: CACHE_SECRET
```

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: ApplicationConfiguration
metadata:
  name: cool-example
spec:
  components:
  - componentName: example-server
    traits:
    - trait:
        apiVersion: core.oam.dev/v1alpha2
        kind: ManualScalerTrait
        spec:
          replicaCount: 3
```

這樣的好處很明顯：

1. 可以很容易的對接現有 K8s 體系裡的 CRD，甚至包括 K8s 原生的 `Deployment` （作為自定義 workload 接入）等資源；
1. K8s CR 層面的欄位定義是成熟的，解析和校驗也完全交由 CRD 體系。

這裡大家注意到 traits 下面是 `[]trait{CR}` 而不是 `[]CR`  的結構，多了一層看似無用的 `trait` 欄位，主要由如下 2 個原因：

- 為後續在 trait 這個維度做擴充套件留下空間，比如可能的編排（ `ordering` ） 等。
- 非 K8s 體系在這一層可以不嚴格按照 CR 的寫法來，完全自定義，不繫結 K8s 描述格式。

## 主要改動 3 引數傳遞使用 jsonPath 替換原先的 fromParam

**研發能夠留出欄位給運維覆蓋**，一直是 OAM 很重要的功能。

體現在 OAM Spec 的流程上就是：研發在 Component 裡面定義 parameter，運維在 AppConfig 裡面透過 parameterValue 去覆蓋對應的引數。

最初的引數傳遞，是在每個欄位後面有個 `fromParam`  欄位，對於支援了自定義 schema 後，這樣的方式顯然是無法覆蓋所有場景的：

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: ComponentSchematic
metadata:
  name: rediscluster
spec:
  workloadType: cache.crossplane.io/v1alpha1.RedisCluster
  parameters:
  - name: engineVersion
    type: string
  workloadSettings:
    - name: engineVersion
      type: string
      fromParam: engineVersion
```

後來我們曾經提議過這樣的方案：

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: ComponentSchematic
metadata:
  name: rediscluster
spec:
  workloadType: cache.crossplane.io/v1alpha1.RedisCluster
  parameters:
  - name: engineVersion
    type: string
  workloadSettings:
    engineVersion: "[fromParam(engineVersion)]"
```

這個方案最大的問題是 靜態的 IaD (Infrastructure as Data) 裡面加入了動態的函式，給理解和使用帶來了複雜性。

經過多方面的討論，在新方案裡我們透過 JsonPath 的形式描述要注入的引數位置，在使用者理解上保證了 AppConfig 是靜態的。

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: Component
metadata:
  name: example-server
spec:
  workload:
    apiVersion: core.oam.dev/v1alpha2
    kind: Server
    spec:
      containers:
      - name: my-cool-server
        image:
          name: example/very-cool-server:1.0.0
        ports:
        - name: http
          value: 8080
        env:
        - name: CACHE_SECRET
          value: cache
  parameters:
  - name: instanceName
    required: true
    fieldPaths:
    - ".metadata.name"
  - name: cacheSecret
    required: true
    fieldPaths:
    - ".workload.spec.containers[0].env[0].value"
```

fieldPaths 是個陣列，每個元素定義了引數和對應 Workload 裡的欄位。
```yaml
apiVersion: core.oam.dev/v1alpha2
kind: ApplicationConfiguration
metadata:
  name: my-app-deployment
spec:
  components:
    - componentName: example-server
      parameterValues:
        - name: cacheSecret
          value: new-cache
```

在 AppConfig 中還是走 parameterValues 去覆蓋 Component 中的 parameter。

## 主要改動 4 ComponentSchematic 名稱改為 Component

原先元件這個概念叫 ComponentSchematic，這樣命名的主要原因是裡面混了一些語法描述和選擇，比如針對 Core Workload（ `container`）和針對擴充套件 Workload （ `workloadSettings` ），寫法上不一樣的，`container` 裡是定義具體的引數，`workloadSettings` 更像是 schema（引數怎麼填的說明）。v1alpha1 版本的 WorkloadSetting 還融入了 type/description之類的，更顯得模稜兩可。

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: ComponentSchematic
metadata:
  name: rediscluster
spec:
  containers:
     ...
  workloadSettings:
    - name: engineVersion
      type: string
      description: engine version
      fromParam: engineVersion
     ...
```

在 v1alpha2 版本中，元件這個概念改為 Component，明確為 Workload 的例項，所有語法定義都是在WorkloadDefinition 中引用的實際 CRD 定義的。

在 K8s 實現中，WorkloadDefinition 就是引用 CRD ，Component.spec.workload 裡就是寫 CRD 對應的例項 CR。

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: Component
metadata:
  name: example-server
spec:
  workload:
    apiVersion: core.oam.dev/v1alpha2
    kind: Server
    spec:
   ...
```

## 主要改動 5 Scope 由 CR 單獨建立，不再由 AppConfig 建立

v1alpha1 中的 Scope 是由 AppConfig 建立的，從例子中可以看出，本質上它也是個 CR，可以“推導”建立出 CR來。但是由於 Scope 的定位是可以容納不同 AppConfig 中的 Component，且 Scope 本身並非一個 App，所以使用 AppConfig 建立 Scope 一直是不太合適的。

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: ApplicationConfiguration
metadata:
  name: my-vpc-network
spec:
  variables:
    - name: networkName
      value: "my-vpc"
  scopes:
    - name: network
      type: core.oam.dev/v1alpha1.Network
      properties:
        network-id: "[fromVariable(networkName)]"
        subnet-ids: "my-subnet1, my-subnet2"
```

v1alpha2 新版本全面使用 CR 來對應例項，為了讓 Scope 的概念更清晰，更方便對應不同型別的 Scope，將 Scope 拿出來直接由 ScopeDefinition 定義的 CRD 對應的 CR 建立。例子如下所示：

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: ScopeDefinition
metadata:
  name: networkscope.core.oam.dev
spec:
  allowComponentOverlap: true
  definitionRef:
    name: networkscope.core.oam.dev
```

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: NetworkScope
metadata:
  name: example-vpc-network
  labels:
    region: us-west
    environment: production
spec:
  networkId: cool-vpc-network
  subnetIds:
  - cool-subnetwork
  - cooler-subnetwork
  - coolest-subnetwork
  internetGatewayType: nat
```

在 AppConfig 中使用 scope 引用如下所示:

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: ApplicationConfiguration
metadata:
  name: custom-single-app
  annotations:
    version: v1.0.0
    description: "Customized version of single-app"
spec:
  components:
    - componentName: frontend
      scopes:
        - scopeRef:
            apiVersion: core.oam.dev/v1alpha2
            kind: NetworkScope
            name: my-vpc-network
    - componentName: backend
      scopes:
        - scopeRef:
            apiVersion: core.oam.dev/v1alpha2
            kind: NetworkScope
            name: my-vpc-network
```

## 主要改動 6 移除 Variable 列表和 [fromVariable()] 動態函式

v1alpha1 版本中有 Variable 是為了 AppConfig 裡開源引用一些公共變數減少冗餘，所以加入了 Variable 列表。但實踐來看，減少的冗餘並沒有明顯減少 OAM spec 的複雜性，相反，增加動態的函式顯著增加了複雜性。

另一方面，fromVariable 這樣的能力完全可以透過 helm template/ kustomiz 等工具來做，由這些工具渲染出完整的 OAM spec，再進行使用。

所以這裡 variables 列表和相關的 fromVariable 均去掉，並不影響任何功能。

```yaml
// 老版本，僅對比使用
apiVersion: core.oam.dev/v1alpha1
kind: ApplicationConfiguration
metadata:
  name: my-app-deployment
spec:
  variables:
    - name: VAR_NAME
      value: SUPPLIED_VALUE
  components:
    - componentName: my-web-app-component
      instanceName: my-app-frontent
      parameterValues:
        - name: ANOTHER_PARAMETER
          value: "[fromVariable(VAR_NAME)]"
      traits:
        - name: ingress
          properties:
            DATA: "[fromVariable(VAR_NAME)]"
```

## 主要改動 7 用 ContainerizedWorkload 替代原來的六種核心 Workload

因為現在已經統一用 WorkloadDefinition 定義 Workload，Component 變成了例項，所以原先的六種核心Workload 實際上都變成了同一個 WorkloadDefinition，欄位描述完全一樣，唯一的不同是對 trait 約束和訴求不一樣。因此原先的六種核心 Workload 的 spec，統一修改為一種名為 ContainerizedWorkload 的 Workload 型別。

同時，這裡計劃要透過增加 policy 這樣的概念，來讓研發表達對運維策略的訴求，即 Component 中可以表達希望增加哪些 trait。

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: WorkloadDefinition
metadata:
  name: containerizedworkloads.core.oam.dev
spec:
  definitionRef:
    name: containerizedworkloads.core.oam.dev
```

一個使用 ContainerizedWorkload 示例：

```yaml
apiVersion: core.oam.dev/v1alpha2
kind: Component
metadata:
  name: frontend
  annotations:
    version: v1.0.0
    description: "A simple webserver"
spec:
  workload:
    apiVersion: core.oam.dev/v1alpha2
    kind: ContainerizedWorkload
    metadata:
      name: sample-workload
    spec:
      osType: linux
      containers:
      - name: web
        image: example/charybdis-single:latest@@sha256:verytrustworthyhash
        resources:
          cpu:
            required: 1.0
          memory:
            required: 100MB
        env:
        - name: MESSAGE
          value: default
  parameters:
  - name: message
    description: The message to display in the web app.  
    required: true
    type: string
    fieldPaths:
    - ".spec.containers[0].env[0].value"
```

# 下一步計劃

1. 應用級別的元件間引數傳遞和依賴關係（[workflow](https://github.com/oam-dev/spec/pull/326)）；
1. [Policy 方案](https://docs.google.com/document/d/1d3kVBFyf7yf-YzmVqkL1hr_qcIVXf6BUJLWKu9NJwvE/edit#heading=h.hh69i79bk4p3)，便於研發在 Component 對 trait 提出訴求；
1. [Component](https://github.com/oam-dev/spec/issues/336) 增加版本的概念，同時給出 [OAM 解決應用版本釋出相關方式](https://github.com/oam-dev/spec/issues/341)。

# 常見 FAQ

1. 我們原有平臺改造為 OAM 模型實現需要做什麼？

對於原先是 K8s 上的應用管理平臺，接入改造為 OAM 實現可以分為兩個階段：

- 實現 OAM ApplicationConfiguration Controller（簡稱 AppConfig Controller），這個 Controller 同時包含 OAM 的 Component、WorkloadDefinition、TraitDefinition、ScopeDefinition 等 CRD。AppConfig Controller 根據 OAM AppConfig 中的描述，拉起原有平臺的 CRD Operator；
- 逐漸將原先的 CRD Operator 根據關注點分離的思想，分為 Workload 和 Trait。同時接入和複用 OAM 社群中更多的 Workload、Trait，豐富更多場景下的功能。

2. 現有的 CRD Operator 為接入 OAM 需要做什麼改變？

現有的 CRD Operator** 功能上可以平滑接入 OAM 體系，比如作為一個獨立擴充套件 Workload 接入。但是為了更好的讓終端使用者體會到 OAM 關注點分離的好處，我們強烈建議 CRD Operator 根據研發和運維不同的關注點分離為不同的 CRD，研發關注的 CRD 作為 Workload 接入 OAM，運維關注的 CRD 作為 Trait 接入 OAM。

目前，OAM 規範和模型實際已解決許多現有問題，但它的路程才剛剛開始。OAM 是一箇中立的開源專案，我們歡迎更多的人參與其中，共同定義雲原生應用交付的未來。

參與方式：

- 釘釘掃碼進入 OAM 專案中文討論群

- [透過 Gitter 直接參與討論](https://gitter.im/oam-dev/)
- [OAM 開源實現地址](https://github.com/oam-dev/rudr)
- [點選 star 一下](https://github.com/oam-dev/rudr)

# 作者簡介

孫健波（花名：天元）阿里雲技術專家，是 OAM 規範的主要制定者之一，致力於推動雲原生應用標準化。同時也在阿里巴巴參與大規模雲原生應用交付與應用管理相關工作。團隊誠邀應用交付、Serverless、PaaS 領域的專家加入，歡迎聯絡  jianbo.sjb AT alibaba-inc.com

# 招人啦！

雲原生應用平臺誠邀 Kubernetes / Serverless / PaaS / 應用交付領域專家（ P6-P8 ）加盟：

- 工作年限：建議 P6-7 三年起，P8 五年起，具體看實際能力；
- 工作地點：國內（北京 / 杭州 / 深圳）；海外（舊金山灣區 / 西雅圖）；
- 崗位包含：架構師、技術專家、全棧工程師等。

簡歷立刻回覆，2~3 周出結果，簡歷投遞：jianbo.sjb AT alibaba-inc.com。</name></group></plural-kind>

OAM v1alpha2 新版：平衡標準與可擴充套件性

相關文章