Merge pull request #741 from wangyikewxgm/contib-addon-docs
[Addon ]Update addon contribution docs.
This commit is contained in:
wyike
GitHub
commit
a3f0276111
|
|
@ -228,15 +228,14 @@ vela addon enable ./your-addon-dir/
|
|||
|
||||
## Known Limits
|
||||
|
||||
- Now if you choose to enable the addon in the cluster, KubeVela will be installed in all subclusters by default, and the parameters filled in when enabling the addon will take effect in all clusters. Later, we plan to improve the multi-cluster addon management system, including supporting features such as cluster differential configuration.
|
||||
|
||||
- Addon version management and upgrade mechanisms, and plans to improve these features in the future.
|
||||
|
||||
- Convenient local addon debugging methods and the follow-up plan is to provide a complete addon local debugging function on the CLI side.
|
||||
|
||||
- Install the addon in the subcluster. If the addon is not installed in the control plane, but only in subclusters, there are some issues.
|
||||
|
||||
- Cannot only install addon in the sub-clusters. Because of KubeVela need render out every kind of resource in control plane, if an addon contain some [CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/), these CRD must be installed in control plane, otherwise Vela-core controller will meet an error of cannot find CRD.
|
||||
|
||||
## Extend Terraform Addon
|
||||
|
||||
* We have build some tool for more convenience to extend cloud resource addons, you can refer to the [extend terraform addon docs](./terraform).
|
||||
* We have built some tools to extend cloud resource as addons for convenience, you can refer to the [extend terraform addon docs](./terraform).
|
||||
|
||||
## Contribution
|
||||
|
||||
If you have developed your own addons, welcome to contribute to the [community catalog](https://github.com/kubevela/catalog).
|
||||
|
||||
Meanwhile, any bugfix of existing addons are welcomed. Just make a pull request to [this](https://github.com/kubevela/catalog) repo.
|
||||
|
|
@ -19,4 +19,6 @@ There's an community addon registry (https://addons.kubevela.net) maintained by
|
|||
* [Cert manager](./cert-manager) Add certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates.
|
||||
* [KubeVela doc](./kubevela-io) Help you to read the KubeVela document in your cluster which can be air-gaped environment.
|
||||
* [Flink kubernetes operator](./flink-kubernetes-operator) A Kubernetes operator for Apache Flink(https://github.com/apache/flink-kubernetes-operator).
|
||||
* [dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX.
|
||||
* [dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX.
|
||||
|
||||
**If you want to make your own addon please refer to [doc](../../platform-engineers/addon/intro.md).**
|
||||
|
|
@ -192,8 +192,9 @@ vela addon enable ./your-addon-dir/
|
|||
|
||||
## 已知局限 (Known Limits)
|
||||
|
||||
- 现在如果选择在集群中启用插件，KubeVela 会默认在所有子集群中安装，并且启用插件时所填的参数，会在所有集群中生效，之后计划完善多集群插件管理体系，包括支持集群差异化配置等特性。
|
||||
- 尚不支持仅在子集群中安装插件。 由于 KubeVela 需要在管控平面中渲染出所有类型的资源再将其下发到子集群当中，如果插件中包含了一些 [CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/), 插件不在管控平面安装的话 Vela 的控制器会遇到无法找到 CRD 错误。
|
||||
|
||||
- 尚缺少插件的版本管理，升降级等机制，之后计划完善这些特性。
|
||||
## 贡献 Addon
|
||||
|
||||
- 尚不支持仅在子集群中安装插件。 如果不在控制平面安装插件，仅安装在子集群中，会遇到诸多已知问题。
|
||||
如果你根据本文档制作了新的插件，非常欢迎贡献到社区。
|
||||
同时，如果你发现了某个插件的 bug，也欢迎帮助社区修复此 bug。
|
||||
|
|
@ -192,8 +192,9 @@ vela addon enable ./your-addon-dir/
|
|||
|
||||
## 已知局限 (Known Limits)
|
||||
|
||||
- 现在如果选择在集群中启用插件，KubeVela 会默认在所有子集群中安装，并且启用插件时所填的参数，会在所有集群中生效，之后计划完善多集群插件管理体系，包括支持集群差异化配置等特性。
|
||||
- 尚不支持仅在子集群中安装插件。 由于 KubeVela 需要在管控平面中渲染出所有类型的资源再将其下发到子集群当中，如果插件中包含了一些 [CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/), 插件不在管控平面安装的话 Vela 的控制器会遇到无法找到 CRD 错误。
|
||||
|
||||
- 尚缺少插件的版本管理，升降级等机制，之后计划完善这些特性。
|
||||
## 贡献 Addon
|
||||
|
||||
- 尚不支持仅在子集群中安装插件。 如果不在控制平面安装插件，仅安装在子集群中，会遇到诸多已知问题。
|
||||
如果你根据本文档制作了新的插件，非常欢迎贡献到社区。
|
||||
同时，如果你发现了某个插件的 bug，也欢迎帮助社区修复此 bug。
|
||||
|
|
@ -228,15 +228,14 @@ vela addon enable ./your-addon-dir/
|
|||
|
||||
## Known Limits
|
||||
|
||||
- Now if you choose to enable the addon in the cluster, KubeVela will be installed in all subclusters by default, and the parameters filled in when enabling the addon will take effect in all clusters. Later, we plan to improve the multi-cluster addon management system, including supporting features such as cluster differential configuration.
|
||||
|
||||
- Addon version management and upgrade mechanisms, and plans to improve these features in the future.
|
||||
|
||||
- Convenient local addon debugging methods and the follow-up plan is to provide a complete addon local debugging function on the CLI side.
|
||||
|
||||
- Install the addon in the subcluster. If the addon is not installed in the control plane, but only in subclusters, there are some issues.
|
||||
|
||||
- Cannot only install addon in the sub-clusters. Because of KubeVela need render out every kind of resource in control plane, if an addon contain some [CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/), these CRD must be installed in control plane, otherwise Vela-core controller will meet an error of cannot find CRD.
|
||||
|
||||
## Extend Terraform Addon
|
||||
|
||||
* We have build some tool for more convenience to extend cloud resource addons, you can refer to the [extend terraform addon docs](./terraform).
|
||||
* We have built some tools to extend cloud resource as addons for convenience, you can refer to the [extend terraform addon docs](./terraform).
|
||||
|
||||
## Contribution
|
||||
|
||||
If you have developed your own addons, welcome to contribute to the [community catalog](https://github.com/kubevela/catalog).
|
||||
|
||||
Meanwhile, any bugfix of existing addons are welcomed. Just make a pull request to [this](https://github.com/kubevela/catalog) repo.
|
||||
|
|
@ -19,4 +19,6 @@ There's an community addon registry (https://addons.kubevela.net) maintained by
|
|||
* [Cert manager](./cert-manager) Add certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates.
|
||||
* [KubeVela doc](./kubevela-io) Help you to read the KubeVela document in your cluster which can be air-gaped environment.
|
||||
* [Flink kubernetes operator](./flink-kubernetes-operator) A Kubernetes operator for Apache Flink(https://github.com/apache/flink-kubernetes-operator).
|
||||
* [dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX.
|
||||
* [dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX.
|
||||
|
||||
**If you want to make your own addon please refer to [doc](../../platform-engineers/addon/intro.md).**
|
||||
Loading…
Reference in New Issue