Skip to content

插件描述

一个典型的插件描述文件 plugin.yaml 如下所示:

yaml
metadata:
  name: starter
  version: 1.0.0
spec:
  requires: ">=1.0.0"
  author:
    name: Aurora
    website: https://docker.ac.cn
  logo: https://docker.ac.cn/logo.svg
  homepage: https://github.com/MR5356/aurora-plugin-starter#readme
  repo: https://github.com/MR5356/aurora-plugin-starter
  displayName: "示例插件"
  description: "一个简单的 Aurora 插件示例"
  • metadata.name是插件的唯一标识名,包含不超过 64 个字符,仅包含小写字母、数字或中划线(-),以字母或数字开头,以字母或数字结尾
  • metadata.version是插件的版本号
  • spec.requires表示插件受支持的Aurora版本
  • spec.author为插件作者和可获得支持的网站地址
  • spec.logo为插件 logo,可以是链接或相对于项目 resources 目录的文件路径,如将 logo 放在 resources/logo.png 则配置为 logo.png 即可
  • spec.homepage为插件官网或帮助中心链接等
  • spec.repo为插件的源码地址
  • spec.displayName为插件的显示名称,它通常是以少数几个字来概括插件的用途
  • spec.description为插件描述,用一段简短的说明来介绍插件的用途
Copyright @ 2024 Aurora冀公网安备 13112202000250 号冀ICP备20003324号Compiled and deployed using Aurora