dependency addon version (#1091)
* dependency version Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com> * fix comments Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com> Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
This commit is contained in:
wyike
GitHub
parent
98eb8ede5e
commit
4562c05857
|
|
@ -57,7 +57,7 @@ A `metadata.yaml` describes the basic information of an addon, such as the name,
|
|||
```yaml
|
||||
name: example
|
||||
version: 1.0.0
|
||||
description: Example adddon.
|
||||
description: Example addon.
|
||||
icon: xxx
|
||||
url: xxx
|
||||
|
||||
|
|
@ -69,6 +69,7 @@ deployTo:
|
|||
|
||||
dependencies:
|
||||
- name: addon_name
|
||||
version: addon_version
|
||||
|
||||
system:
|
||||
vela: ">=v1.4.0"
|
||||
|
|
@ -79,18 +80,18 @@ invisible: false
|
|||
|
||||
Here's the usage of every field:
|
||||
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: | :----------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| name | yes | string | The name of the addon. |
|
||||
| version | yes | string | The version of addon, increase for every change and follow [SemVer](https://semver.org/) rule. |
|
||||
| description | yes | string | Description of the addon. |
|
||||
| icon | no | string | Icon of the addon, will display in addon dashboard. |
|
||||
| url | no | string | The official website of the project behind the addon. |
|
||||
| tags | no | []string | The tags to display and organize the addon. |
|
||||
| dependencies | no | []{ name: string } | Names of other addons it depends on. KubeVela will make sure these dependencies are enabled before installing this addon. |
|
||||
| system.vela | no | string | Required version of vela controller, vela CLI will block the installation if vela controller can't match the requirements. |
|
||||
| system.kubernetes | no | string | Required version of Kubernetes, vela CLI will block the installation if Kubernetes cluster can't match the requirements. |
|
||||
| deployTo.runtimeCluster | no | bool | By default, the addon will not be installed in the managed clusters. If it's `true`, it will be delivered to all managed clusters automatically. (This field only take effect when application template file is YAML typed) |
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: |:-----------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| name | yes | string | The name of the addon. |
|
||||
| version | yes | string | The version of addon, increase for every change and follow [SemVer](https://semver.org/) rule. |
|
||||
| description | yes | string | Description of the addon. |
|
||||
| icon | no | string | Icon of the addon, will display in addon dashboard. |
|
||||
| url | no | string | The official website of the project behind the addon. |
|
||||
| tags | no | []string | The tags to display and organize the addon. |
|
||||
| dependencies | no | []{ name: string, version: string } | Infos of other addons it depends on. You can specify the version of dependency addon by defining the `version` filed, otherwise would use latest one. KubeVela will make sure these dependencies are enabled before installing this addon. |
|
||||
| system.vela | no | string | Required version of vela controller, vela CLI will block the installation if vela controller can't match the requirements. |
|
||||
| system.kubernetes | no | string | Required version of Kubernetes, vela CLI will block the installation if Kubernetes cluster can't match the requirements. |
|
||||
| deployTo.runtimeCluster | no | bool | By default, the addon will not be installed in the managed clusters. If it's `true`, it will be delivered to all managed clusters automatically. (This field only take effect when application template file is YAML typed) |
|
||||
|
||||
#### README.md (Required)
|
||||
|
||||
|
|
|
|||
|
|
@ -75,18 +75,18 @@ invisible: false
|
|||
|
||||
所有的字段及其作用如下：
|
||||
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: | :----------------: | :---------------------------------------------------------------------------------------------------: |
|
||||
| name | yes | string | 名称 |
|
||||
| version | yes | string | 版本，每次变更递增且符合 [SemVer](https://semver.org/) 规范 |
|
||||
| description | yes | string | 描述 |
|
||||
| icon | no | string | 图标，图标将在 VelaUX 的插件页面展示 |
|
||||
| url | no | string | 插件所包含项目的官网地址 |
|
||||
| tags | no | []string | 标签 |
|
||||
| dependencies | no | []{ name: string } | 依赖的其他插件，安装是 KubeVela 会保证依赖插件均已安装 |
|
||||
| system.vela | no | string | 环境中所要求的 KubeVela 的版本，如果不满足，安装将会被拒绝 |
|
||||
| system.kubernetes | no | string | 环境中所要求的 Kubernetes 的版本 |
|
||||
| deployTo.runtimeCluster | no | bool | 插件是否可以安装到子集群，默认不设置该字段插件不会安装在任何子集群中 （只在 YAML 描述插件应用时生效） |
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: |:----------------------------------:|:-----------------------------------------------------------------------------:|
|
||||
| name | yes | string | 名称 |
|
||||
| version | yes | string | 版本，每次变更递增且符合 [SemVer](https://semver.org/) 规范 |
|
||||
| description | yes | string | 描述 |
|
||||
| icon | no | string | 图标，图标将在 VelaUX 的插件页面展示 |
|
||||
| url | no | string | 插件所包含项目的官网地址 |
|
||||
| tags | no | []string | 标签 |
|
||||
| dependencies | no | []{ name: string, version: string} | 依赖的其他插件。你可以通过设置 `version` 字段来指定所依赖插件的版本，如果不设置将依赖最新版本。安装时 KubeVela 会保证依赖插件均已安装 |
|
||||
| system.vela | no | string | 环境中所要求的 KubeVela 的版本，如果不满足，安装将会被拒绝 |
|
||||
| system.kubernetes | no | string | 环境中所要求的 Kubernetes 的版本 |
|
||||
| deployTo.runtimeCluster | no | bool | 插件是否可以安装到子集群，默认不设置该字段插件不会安装在任何子集群中 （只在 YAML 描述插件应用时生效） |
|
||||
|
||||
#### 介绍文档 (README.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -75,18 +75,18 @@ invisible: false
|
|||
|
||||
所有的字段及其作用如下：
|
||||
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: | :----------------: | :---------------------------------------------------------------------------------------------------: |
|
||||
| name | yes | string | 名称 |
|
||||
| version | yes | string | 版本，每次变更递增且符合 [SemVer](https://semver.org/) 规范 |
|
||||
| description | yes | string | 描述 |
|
||||
| icon | no | string | 图标，图标将在 VelaUX 的插件页面展示 |
|
||||
| url | no | string | 插件所包含项目的官网地址 |
|
||||
| tags | no | []string | 标签 |
|
||||
| dependencies | no | []{ name: string } | 依赖的其他插件，安装是 KubeVela 会保证依赖插件均已安装 |
|
||||
| system.vela | no | string | 环境中所要求的 KubeVela 的版本，如果不满足，安装将会被拒绝 |
|
||||
| system.kubernetes | no | string | 环境中所要求的 Kubernetes 的版本 |
|
||||
| deployTo.runtimeCluster | no | bool | 插件是否可以安装到子集群，默认不设置该字段插件不会安装在任何子集群中 （只在 YAML 描述插件应用时生效） |
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: |:----------------------------------:|:-----------------------------------------------------------------------------:|
|
||||
| name | yes | string | 名称 |
|
||||
| version | yes | string | 版本，每次变更递增且符合 [SemVer](https://semver.org/) 规范 |
|
||||
| description | yes | string | 描述 |
|
||||
| icon | no | string | 图标，图标将在 VelaUX 的插件页面展示 |
|
||||
| url | no | string | 插件所包含项目的官网地址 |
|
||||
| tags | no | []string | 标签 |
|
||||
| dependencies | no | []{ name: string, version: string} | 依赖的其他插件。你可以通过设置 `version` 字段来指定所依赖插件的版本，如果不设置将依赖最新版本。安装时 KubeVela 会保证依赖插件均已安装 |
|
||||
| system.vela | no | string | 环境中所要求的 KubeVela 的版本，如果不满足，安装将会被拒绝 |
|
||||
| system.kubernetes | no | string | 环境中所要求的 Kubernetes 的版本 |
|
||||
| deployTo.runtimeCluster | no | bool | 插件是否可以安装到子集群，默认不设置该字段插件不会安装在任何子集群中 （只在 YAML 描述插件应用时生效） |
|
||||
|
||||
#### 介绍文档 (README.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ A `metadata.yaml` describes the basic information of an addon, such as the name,
|
|||
```yaml
|
||||
name: example
|
||||
version: 1.0.0
|
||||
description: Example adddon.
|
||||
description: Example addon.
|
||||
icon: xxx
|
||||
url: xxx
|
||||
|
||||
|
|
@ -69,6 +69,7 @@ deployTo:
|
|||
|
||||
dependencies:
|
||||
- name: addon_name
|
||||
version: addon_version
|
||||
|
||||
system:
|
||||
vela: ">=v1.4.0"
|
||||
|
|
@ -79,18 +80,18 @@ invisible: false
|
|||
|
||||
Here's the usage of every field:
|
||||
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: | :----------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| name | yes | string | The name of the addon. |
|
||||
| version | yes | string | The version of addon, increase for every change and follow [SemVer](https://semver.org/) rule. |
|
||||
| description | yes | string | Description of the addon. |
|
||||
| icon | no | string | Icon of the addon, will display in addon dashboard. |
|
||||
| url | no | string | The official website of the project behind the addon. |
|
||||
| tags | no | []string | The tags to display and organize the addon. |
|
||||
| dependencies | no | []{ name: string } | Names of other addons it depends on. KubeVela will make sure these dependencies are enabled before installing this addon. |
|
||||
| system.vela | no | string | Required version of vela controller, vela CLI will block the installation if vela controller can't match the requirements. |
|
||||
| system.kubernetes | no | string | Required version of Kubernetes, vela CLI will block the installation if Kubernetes cluster can't match the requirements. |
|
||||
| deployTo.runtimeCluster | no | bool | By default, the addon will not be installed in the managed clusters. If it's `true`, it will be delivered to all managed clusters automatically. (This field only take effect when application template file is YAML typed) |
|
||||
| Field | Required | Type | Usage |
|
||||
| :---------------------: | :------: |:-----------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| name | yes | string | The name of the addon. |
|
||||
| version | yes | string | The version of addon, increase for every change and follow [SemVer](https://semver.org/) rule. |
|
||||
| description | yes | string | Description of the addon. |
|
||||
| icon | no | string | Icon of the addon, will display in addon dashboard. |
|
||||
| url | no | string | The official website of the project behind the addon. |
|
||||
| tags | no | []string | The tags to display and organize the addon. |
|
||||
| dependencies | no | []{ name: string, version: string } | Infos of other addons it depends on. You can specify the version of dependency addon by defining the `version` filed, otherwise would use latest one. KubeVela will make sure these dependencies are enabled before installing this addon. |
|
||||
| system.vela | no | string | Required version of vela controller, vela CLI will block the installation if vela controller can't match the requirements. |
|
||||
| system.kubernetes | no | string | Required version of Kubernetes, vela CLI will block the installation if Kubernetes cluster can't match the requirements. |
|
||||
| deployTo.runtimeCluster | no | bool | By default, the addon will not be installed in the managed clusters. If it's `true`, it will be delivered to all managed clusters automatically. (This field only take effect when application template file is YAML typed) |
|
||||
|
||||
#### README.md (Required)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue