第 4 章 Kamelets 参考

4.1. Kamelet 结构

Kamelet 通常采用 YAML 域特定语言进行编码。文件名前缀是 Kamelet 的名称。例如,一个名称为 FTP sink 的 Kamelet 具有文件名 ftp-sink.kamelet.yaml

请注意,在 OpenShift 中,K Kamelet 是一个资源,显示 Kamelet 的名称(不是文件名)。

在高级别上,K Kamelet 资源描述了:

  • 包含 Kamelet 的 ID 及其他信息的 metadata 部分,如 Kamelet 类型(sinkaction)。
  • 包含一组可用于配置 Kamelet 的定义(JSON-schema 规格)。
  • 一个可选的 type 部分,其中包含 Kamelet 预期输入和输出的信息。
  • YAML DSL 中的 Camel 模板,用于定义 Kamelet 的实施。

下图显示了 Kamelet 及其部分的示例。

Kamelet 结构示例

telegram-text-source.kamelet.yaml
apiVersion: camel.apache.org/v1alpha1
kind: Kamelet
metadata:
  name: telegram-source 1
  annotations: 2
    camel.apache.org/catalog.version: "master-SNAPSHOT"
    camel.apache.org/kamelet.icon: "data:image/..."
    camel.apache.org/provider: "Red Hat"
    camel.apache.org/kamelet.group: "Telegram"
  labels: 3
    camel.apache.org/kamelet.type: "source"
spec:
  definition: 4
    title: "Telegram Source"
    description: |-
        Receive all messages that people send to your telegram bot.
        To create a bot, contact the @botfather account using the
        Telegram app.
        The source attaches the following headers to the messages:
        - chat-id / ce-chatid: the ID of the chat where the
        message comes from
    required:
        - authorizationToken
    type: object
    properties:
        authorizationToken:
          title: Token
          description: The token to access your bot on Telegram, that you
                   can obtain from the Telegram "Bot Father".
          type: string
          format: password
        x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:password
  types: 5
    out:
      mediaType: application/json
  dependencies:
  - "camel:jackson"
  - "camel:kamelet"
  - "camel:telegram"
  template: 6
    from:
        uri: telegram:bots
        parameters:
            authorizationToken: "{{authorizationToken}}"
        steps:
        - set-header:
          name: chat-id
          simple: "${header[CamelTelegramChatId]}"
        - set-header:
          name: ce-chatid
          simple: "${header[CamelTelegramChatId]}"
        - marshal:
          json: {}
        - to: "kamelet:sink"
  1. Kamelet ID - 当您想引用 Kamelet 时,在 Camel K 集成中使用此 ID。
  2. 注解(如图标)为 Kamelet 提供显示功能。
  3. 标签允许用户查询 Kamelets(例如,kind: "source"、"sink" 或 "action")
  4. JSON-schema 规格格式的 Kamelet 和参数的描述。
  5. 输出的介质类型(可以包含 schema)。
  6. 定义 Kamelet 行为的路由模板。