update some docs
Signed-off-by: 楚岳 <wangyike.wyk@alibaba-inc.com>
This commit is contained in:
楚岳
parent
dbc8745735
commit
2193a8d8e5
|
|
@ -173,15 +173,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.
|
||||
|
||||
- Install the addon in the sub-cluster. If the addon is not installed in the control plane, but only in sub-clusters, there are known some issues.
|
||||
|
||||
## 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 build some tool for more convenience to extend cloud resource addons, you can refer to the [extend terraform addon docs](./terraform).
|
||||
|
||||
## Contribution
|
||||
|
||||
If you make and use an addon in your product environment, welcome to contribute your customize addon to community. By doing this, whole community can help to test, optimize , upgrade or fix bugs for the addon. Community also can help you find more usage scenario about thr addon.
|
||||
|
||||
Meanwhile, any bug fix about existing addon is also welcome. Contribution is making a pull request to [this](https://github.com/kubevela/catalog) repo. Please refer to [doc](https://github.com/kubevela/catalog/blob/master/README.md#contribution) for more info about contribution rules.
|
||||
|
|
@ -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)**
|
||||
|
|
@ -172,8 +172,9 @@ vela addon enable ./your-addon-dir/
|
|||
|
||||
## 已知局限 (Known Limits)
|
||||
|
||||
- 现在如果选择在集群中启用插件，KubeVela 会默认在所有子集群中安装，并且启用插件时所填的参数，会在所有集群中生效，之后计划完善多集群插件管理体系，包括支持集群差异化配置等特性。
|
||||
- 尚不支持仅在子集群中安装插件。 如果不在控制平面安装插件，仅安装在子集群中，会遇到诸多已知问题。
|
||||
|
||||
- 尚缺少插件的版本管理，升降级等机制，之后计划完善这些特性。
|
||||
## 贡献 Addon
|
||||
|
||||
- 尚不支持仅在子集群中安装插件。 如果不在控制平面安装插件，仅安装在子集群中，会遇到诸多已知问题。
|
||||
如果你根据本文档制作了新的插件，非常欢迎贡献到社区。通过如此，整个社区可以帮助你测试、升级、维护这个插件。并发觉更多关于该插件的可能场景。
|
||||
同时，如果你发现了某个插件的 bug，也欢迎帮助社区修复此 bug。 贡献的方式是给该 [仓库](https://github.com/kubevela/catalog) 提交 Pull request。 在贡献前请阅读[文档](https://github.com/kubevela/catalog#contribution)了解贡献规则。
|
||||
|
|
@ -172,8 +172,9 @@ vela addon enable ./your-addon-dir/
|
|||
|
||||
## 已知局限 (Known Limits)
|
||||
|
||||
- 现在如果选择在集群中启用插件，KubeVela 会默认在所有子集群中安装，并且启用插件时所填的参数，会在所有集群中生效，之后计划完善多集群插件管理体系，包括支持集群差异化配置等特性。
|
||||
- 尚不支持仅在子集群中安装插件。 如果不在控制平面安装插件，仅安装在子集群中，会遇到诸多已知问题。
|
||||
|
||||
- 尚缺少插件的版本管理，升降级等机制，之后计划完善这些特性。
|
||||
## 贡献 Addon
|
||||
|
||||
- 尚不支持仅在子集群中安装插件。 如果不在控制平面安装插件，仅安装在子集群中，会遇到诸多已知问题。
|
||||
如果你根据本文档制作了新的插件，非常欢迎贡献到社区。通过如此，整个社区可以帮助你测试、升级、维护这个插件。并发觉更多关于该插件的可能场景。
|
||||
同时，如果你发现了某个插件的 bug，也欢迎帮助社区修复此 bug。 贡献的方式是给该 [仓库](https://github.com/kubevela/catalog) 提交 Pull request。 在贡献前请阅读[文档](https://github.com/kubevela/catalog#contribution)了解贡献规则。
|
||||
|
|
@ -173,15 +173,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.
|
||||
|
||||
- Install the addon in the sub-cluster. If the addon is not installed in the control plane, but only in sub-clusters, there are known some issues.
|
||||
|
||||
## 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 build some tool for more convenience to extend cloud resource addons, you can refer to the [extend terraform addon docs](./terraform).
|
||||
|
||||
## Contribution
|
||||
|
||||
If you make and use an addon in your product environment, welcome to contribute your customize addon to community. By doing this, whole community can help to test, optimize , upgrade or fix bugs for the addon. Community also can help you find more usage scenario about thr addon.
|
||||
|
||||
Meanwhile, any bug fix about existing addon is also welcome. Contribution is making a pull request to [this](https://github.com/kubevela/catalog) repo. Please refer to [doc](https://github.com/kubevela/catalog/blob/master/README.md#contribution) for more info about contribution rules.
|
||||
|
|
@ -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