1. 概述

本规范旨在定义对 Higress Wasm Plugin 镜像的内容和构建方式。在编写时,笔者参考了 Wasm Image Specification

注意:本规范使用 OCI 镜像格式,并不限定插件只能使用 OCI 镜像,对于自定义插件开发,请参考自定义插件里介绍的更简单的方式。

OCI 镜像是用来规范所有平台推出的通用标准插件使用

2. 镜像结构

每个镜像必须基于 scratch 使用 OCI 格式规范进行构建,且可包含以下文件:

  • spec.yaml:必要。插件的元数据文件。其内容格式请见第 3 节。
  • README.md:必要。插件的用法说明文件。使用 Markdown 格式。语言可使用英文或中文。
  • README_{lang}.md:可选。插件用法说明文件的翻译版本。使用 Markdown 格式。lang 的取值为 ZHEN
  • icon.png:可选。插件的图标文件。也可以选择在 spec.yaml 中指定图标 URL。二者同时存在时,系统会使用包内部的图标文件用于展示。
  • plugin.wasm:必要。插件的二进制文件。

镜像的每一层只可包含一个文件。

除 plugin.wasm 所在层外,其它层需根据文件名设置 media type:

  • spec.yaml:application/vnd.module.wasm.spec.v1+yaml
  • README.md:application/vnd.module.wasm.doc.v1+markdown
  • README_{lang}.md:application/vnd.module.wasm.doc.v1.{lang}+markdown
  • icon.png:application/vnd.module.wasm.icon.v1+png

plugin.wasm 文件必须放置于镜像的最后一层,且该层应使用 application/vnd.oci.image.layer.v1.tar+gzip 作为 media type。

3. 元数据文件格式

本节以 basic-auth 插件的元数据信息为例,介绍元数据文件 spec.yaml 的格式。

  1. apiVersion: 1.0.0 # 本文件所使用的格式版本。目前固定为 1.0.0
  2. info:
  3. category: auth # 插件类型。可选值有:auth(认证鉴权)、security(安全防护)、protocol(协议转换)、flow-control(流量控制)、flow-monitor(流量观测)、custom(自定义)
  4. name: basic-auth/v1 # 插件名称。这是插件的唯一标识。建议在尾部追加类似”/v1”的版本号,以便应对后续不兼容升级的场景
  5. title: Basic Auth # 显示名称,支持国际化
  6. description: 本插件实现了基于 HTTP Basic Auth 标准进行认证鉴权的功能。 # 功能描述,支持国际化
  7. x-description-i18n: # 上面 description 字段的国际化内容。所有支持国际化的字段均可使用”x-{name}-i18n”的方式添加国际化内容
  8. en-US: This plugin implements an authentication function based on HTTP Basic Auth standard.
  9. version: 1.0.0 # 版本号
  10. contact: # 联系信息
  11. name: Higress Team
  12. email: admin@higress.io
  13. spec:
  14. priority: 0 # 阶段内的运行优先级。取值请参考 https://istio.io/latest/docs/reference/config/proxy_extensions/wasm-plugin/#WasmPlugin
  15. configSchema: # 插件运行配置的数据模型,目前仅支持使用 OpenAPI 3.0.0 标准中的 Schema 格式进行定义
  16. openAPIV3Schema: # 以下内容的数据格式请参考 https://openapi.apifox.cn/#schema-%E5%AF%B9%E8%B1%A1 。部分显示用字段支持国际化。
  17. type: object
  18. properties:
  19. consumers:
  20. type: array
  21. x-scope: GLOBAL # 配置项作用范围。可选值:GLOBAL(全局配置)、RULE(规则级配置,即在关联到路由、域名、服务等特定时的配置)、ANY(不限制作用范围)。可空。缺省值为 ANY。
  22. title: 调用方列表
  23. x-title-i18n:
  24. en-US: Consumer List
  25. description: 服务调用方列表,用于对请求进行认证
  26. x-description-i18n:
  27. en-US: List of service consumers which will be used in request authentication
  28. items:
  29. type: object
  30. properties:
  31. name:
  32. type: string
  33. title: 名称
  34. x-title-i18n:
  35. en-US: Name
  36. description: 该调用方的名称
  37. x-description-i18n:
  38. en-US: The name of the consumer
  39. # 数据校验场景参照 JSON Schema Validation Spec 实现
  40. # 目前支持以下字段:
  41. # - maximum
  42. # - minimum
  43. # - maxLength
  44. # - minLength
  45. # - pattern
  46. # - maxItems
  47. # - minItems
  48. # - required
  49. minLength: 6 # 最小长度,用于数据校验
  50. maxLength: 256 # 最大长度,用于数据校验
  51. pattern: “^$ # 正则表达式,用于数据校验
  52. example:
  53. - consumer1
  54. credential:
  55. type: string
  56. title: 访问凭证
  57. x-title-i18n:
  58. en-US: Credential
  59. description: 该调用方的访问凭证
  60. x-description-i18n:
  61. en-US: The credential of the consumer
  62. example:
  63. - admin:123456
  64. required:
  65. - name
  66. - credential
  67. allow:
  68. type: array
  69. title: 授权访问的调用方列表
  70. x-title-i18n:
  71. en-US: Allowed Consumers
  72. description: 对于匹配上述条件的请求,允许访问的调用方列表
  73. x-description-i18n:
  74. en-US: Consumers to be allowed for matched requests
  75. items:
  76. type: string
  77. example:
  78. - consumer1
  79. required:
  80. - allow
  81. - consumers
  82. example:
  83. consumers:
  84. - name: consumer1
  85. credential: admin:123456
  86. - name: consumer2
  87. credential: guest:abc
  88. allow:
  89. - consumer2

4. 镜像构建方式

  1. 在 Higress 项目目录内启动构建用容器
  1. GO_VERSION=”1.19
  2. TINYGO_VERSION=”0.28.1
  3. ORAS_VERSION=”1.0.0
  4. PLUGIN_NAME=”hello-world
  5. BUILDER_IMAGE=”higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/wasm-go-builder:go${GO_VERSION}-tinygo${TINYGO_VERSION}-oras${ORAS_VERSION}”
  6. docker run -v ${PWD}:/workspace -e PLUGIN_NAME=${PLUGIN_NAME} -it —rm ${BUILDER_IMAGE} /bin/bash
  1. 在容器中构建 Wasm 文件
  1. cd /workspace/plugins/wasm-go/extensions/${PLUGIN_NAME}
  2. go mod tidy
  3. tinygo build -o ./plugin.wasm -scheduler=none -target=wasi -gc=custom -tags=’custommalloc nottinygc_finalizer ./main.go
  1. 构建并推送 OCI 镜像
  1. tar czvf plugin.tar.gz plugin.wasm
  2. IMAGE_REGISTRY_SERVICE=docker.io
  3. IMAGE_REPOSITORY=”${IMAGE_REGISTRY_SERVICE}/plugins/${PLUGIN_NAME}”
  4. IMAGE_TAG=”v0.0.1
  5. oras login ${IMAGE_REGISTRY_SERVICE}
  6. oras push ${IMAGE_REPOSITORY}:${IMAGE_TAG} \
  7. ./spec.yaml:application/vnd.module.wasm.spec.v1+yaml \
  8. ./README.md:application/vnd.module.wasm.doc.v1+markdown \
  9. ./README_EN.md:application/vnd.module.wasm.doc.v1.en+markdown \
  10. ./plugin.tar.gz:application/vnd.oci.image.layer.v1.tar+gzip

5. 附录

5.1 各插件类型的缺省图标