Version: v1.2

Kustomize 补丁

本小节将介绍如何使用 trait 对 Kustomize 组件做差异化配置。

功能说明

Trait简介
kustomize-patch支持以 inline YAML 字符串形式支持 strategy Merge 和 JSON6902 格式的 patch。
kustomize-json-patch支持以 JSON6902 格式对 kustomize 进行 patch
kustomize-strategy-merge支持以 YAML 格式对 kustomize 进行 patch

kustomize-patch 字段说明

kustomize-patch 类型的 trait 以字符串形式描述 patch 内容。

  1. vela show kustomize-patch

输出如下：

  1. # Properties
  3. +---------+---------------------------------------------------------------+-----------------------+----------+---------+
  5. |  NAME   |                          DESCRIPTION                          |         TYPE          | REQUIRED | DEFAULT |
  7. +---------+---------------------------------------------------------------+-----------------------+----------+---------+
  9. | patches | a list of StrategicMerge or JSON6902 patch to selected target | [[]patches](#patches) | true     |         |
  11. +---------+---------------------------------------------------------------+-----------------------+----------+---------+
  19. ## patches
  21. +--------+---------------------------------------------------+-------------------+----------+---------+
  23. |  NAME  |                    DESCRIPTION                    |       TYPE        | REQUIRED | DEFAULT |
  25. +--------+---------------------------------------------------+-------------------+----------+---------+
  27. | patch  | Inline patch string, in yaml style                | string            | true     |         |
  29. | target | Specify the target the patch should be applied to | [target](#target) | true     |         |
  31. +--------+---------------------------------------------------+-------------------+----------+---------+
  39. ### target
  41. +--------------------+-------------+--------+----------+---------+
  43. |        NAME        | DESCRIPTION |  TYPE  | REQUIRED | DEFAULT |
  45. +--------------------+-------------+--------+----------+---------+
  47. | name               |             | string | false    |         |
  49. | group              |             | string | false    |         |
  51. | version            |             | string | false    |         |
  53. | kind               |             | string | false    |         |
  55. | namespace          |             | string | false    |         |
  57. | annotationSelector |             | string | false    |         |
  59. | labelSelector      |             | string | false    |         |
  61. +--------------------+-------------+--------+----------+---------+

如何使用

使用示例如下

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: Application
  5. metadata:
  7.   name: bucket-app
  9. spec:
  11.   components:
  13.     - name: bucket-comp
  15.       type: kustomize
  17.       # ... omitted for brevity
  19.       traits:
  21.         - type: kustomize-patch
  23.           properties:
  25.             patches:
  27.               - patch: |-
  29.                   apiVersion: v1
  31.                   kind: Pod
  33.                   metadata:
  35.                     name: not-used
  37.                     labels:
  39.                       app.kubernetes.io/part-of: test-app
  41.                 target:
  43.                   labelSelector: "app=podinfo"

上面的例子给原本的 kustomize 添加了一个 patch ： 筛选出带有 app=podinfo 标签的 Pod 打了 patch。

kustomize-json-patch 字段说明

可以以 JSON6902 格式进行 patch。先来了解其信息：

  1. vela show kustomize-json-patch
  1. # Properties
  3. +-------------+---------------------------+-------------------------------+----------+---------+
  5. |    NAME     |        DESCRIPTION        |             TYPE              | REQUIRED | DEFAULT |
  7. +-------------+---------------------------+-------------------------------+----------+---------+
  9. | patchesJson | A list of JSON6902 patch. | [[]patchesJson](#patchesJson) | true     |         |
  11. +-------------+---------------------------+-------------------------------+----------+---------+
  19. ## patchesJson
  21. +--------+-------------+-------------------+----------+---------+
  23. |  NAME  | DESCRIPTION |       TYPE        | REQUIRED | DEFAULT |
  25. +--------+-------------+-------------------+----------+---------+
  27. | patch  |             | [patch](#patch)   | true     |         |
  29. | target |             | [target](#target) | true     |         |
  31. +--------+-------------+-------------------+----------+---------+
  39. #### target
  41. +--------------------+-------------+--------+----------+---------+
  43. |        NAME        | DESCRIPTION |  TYPE  | REQUIRED | DEFAULT |
  45. +--------------------+-------------+--------+----------+---------+
  47. | name               |             | string | false    |         |
  49. | group              |             | string | false    |         |
  51. | version            |             | string | false    |         |
  53. | kind               |             | string | false    |         |
  55. | namespace          |             | string | false    |         |
  57. | annotationSelector |             | string | false    |         |
  59. | labelSelector      |             | string | false    |         |
  61. +--------------------+-------------+--------+----------+---------+
  69. ### patch
  71. +-------+-------------+--------+----------+---------+
  73. | NAME  | DESCRIPTION |  TYPE  | REQUIRED | DEFAULT |
  75. +-------+-------------+--------+----------+---------+
  77. | path  |             | string | true     |         |
  79. | op    |             | string | true     |         |
  81. | value |             | string | false    |         |
  83. +-------+-------------+--------+----------+---------+

如何使用

使用示例如下：

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: Application
  5. metadata:
  7.   name: bucket-app
  9. spec:
  11.   components:
  13.     - name: bucket-comp
  15.       type: kustomize
  17.       # ... omitted for brevity
  19.       traits:
  21.         - type: kustomize-json-patch
  23.           properties:
  25.             patchesJson:
  27.               - target:
  29.                   version: v1
  31.                   kind: Deployment
  33.                   name: podinfo
  35.                 patch:
  37.                 - op: add
  39.                   path: /metadata/annotations/key
  41.                   value: value

上面这个例子中给所有 Deployment 对象的 annotations 添加了一条：key: value

kustomize-strategy-merge 字段说明

可以以 格式进行 patch。先来了解其信息：

  1. vela show kustomize-json-patch
  1. # Properties
  3. +-----------------------+-----------------------------------------------------------+---------------------------------------------------+----------+---------+
  5. |         NAME          |                        DESCRIPTION                        |                       TYPE                        | REQUIRED | DEFAULT |
  7. +-----------------------+-----------------------------------------------------------+---------------------------------------------------+----------+---------+
  9. | patchesStrategicMerge | a list of strategicmerge, defined as inline yaml objects. | [[]patchesStrategicMerge](#patchesStrategicMerge) | true     |         |
  11. +-----------------------+-----------------------------------------------------------+---------------------------------------------------+----------+---------+
  19. ## patchesStrategicMerge
  21. +-----------+-------------+--------------------------------------------------------+----------+---------+
  23. |   NAME    | DESCRIPTION |                          TYPE                          | REQUIRED | DEFAULT |
  25. +-----------+-------------+--------------------------------------------------------+----------+---------+
  27. | undefined |             | map[string](null|bool|string|bytes|{...}|[...]|number) | true     |         |

如何使用

使用示例如下：

  1. apiVersion: core.oam.dev/v1beta1
  3. kind: Application
  5. metadata:
  7.   name: bucket-app
  9. spec:
  11.   components:
  13.     - name: bucket-comp
  15.       type: kustomize
  17.       # ... omitted for brevity
  19.       traits:
  21.         - type: kustomize-strategy-merge
  23.           properties:
  25.             patchesStrategicMerge:
  27.               - apiVersion: apps/v1
  29.                 kind: Deployment
  31.                 metadata:
  33.                   name: podinfo
  35.                 spec:
  37.                   template:
  39.                     spec:
  41.                       serviceAccount: custom-service-account

上面这个例子中用 YAML 原生格式（即非内嵌字符串格式）对原本 kustomize 进行了patch。