From 9508a453b89b102ab347b3a2aaa125f5c32aa8c9 Mon Sep 17 00:00:00 2001 From: Jianbo Sun Date: Wed, 8 Jun 2022 15:07:51 +0800 Subject: [PATCH] Chore: update want more section (#711) Signed-off-by: Jianbo Sun --- blog/2021-10-08-blog-1.1.md | 2 +- docs/end-user/components/more.md | 169 ++++++++++++++++-- docs/getting-started/definition.md | 2 +- docs/how-to/cli/addon/addon.md | 124 +------------ docs/platform-engineers/addon/intro.md | 2 +- .../system-operation/enable-addon-offline.md | 6 +- docs/reference/addons/overview.md | 2 +- .../current.json | 4 +- .../contributor/non-code-contribute.md | 47 +++++ sidebars.js | 3 +- .../version-v1.4/end-user/components/more.md | 169 ++++++++++++++++-- .../getting-started/definition.md | 2 +- .../version-v1.4/how-to/cli/addon/addon.md | 124 +------------ .../platform-engineers/addon/intro.md | 2 +- .../system-operation/enable-addon-offline.md | 6 +- .../version-v1.4/reference/addons/overview.md | 2 +- versioned_sidebars/version-v1.4-sidebars.json | 6 +- 17 files changed, 382 insertions(+), 290 deletions(-) create mode 100644 i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/non-code-contribute.md diff --git a/blog/2021-10-08-blog-1.1.md b/blog/2021-10-08-blog-1.1.md index b9a9293a67c..131cd61026c 100644 --- a/blog/2021-10-08-blog-1.1.md +++ b/blog/2021-10-08-blog-1.1.md @@ -27,7 +27,7 @@ KubeVela latest 1.1 release is a major milestone bringing more continuous delive - **Multi-environment, multi-cluster rollout**: KubeVela allows users to define the environments and the clusters which application components to deploy to or to promote. This makes it easier for users to manage multi-stage application rollout. For example, users can deploy applicatons to test environment and then promote to production environment. - **Canary rollout and approval gate**: Application delivery is a procedural workflow that takes multiple steps. KubeVela provides such workflow on top of Kubernetes. By default, Users can use KubeVela to build canary rollout, approval gate, notification pipelines to deliver applications confidently. Moreover, the workflow model is declarative and extensible. Workflow steps can be stored in Git to simplify management. -- **Addon management**: All KubeVela capabilities (e.g. Helm chart deployment) are pluggable. They are managed as addons [2]. KubeVela provides simple experience via CLI/UI to discover, install, uninstall addons. There is an official addon registry. Users can also bring their own addon registries. +- **Addon management**: All KubeVela capabilities (e.g. Helm chart deployment) are pluggable. They are managed as addons [2]. KubeVela provides simple experience via CLI/UI to discover, install, uninstall addons. There is an community addon registry. Users can also bring their own addon registries. - **Cloud Resource**: Users can enable Terraform addon on KubeVela to deploy cloud resources using the same abstraction to deploy applications. This enables cooperative delivery of application and its dependencies. That includes databases, redis, message queues, etc. By using KubeVela, users don't need to switch over to another interface to manage middlewares. This provides unified experience and aligns better with the upcoming trends in CNCF Cooperative-Delivery Working Group [3]. That is the introduction about KubeVela 1.1 release. In the following, we will provide deep-dive and examples for the new features. diff --git a/docs/end-user/components/more.md b/docs/end-user/components/more.md index a72e1814aff..57b4942f580 100644 --- a/docs/end-user/components/more.md +++ b/docs/end-user/components/more.md @@ -2,18 +2,165 @@ title: Needs More？ --- -KubeVela is programmable, you have the following ways to discover and extend the platform. +KubeVela is programmable, it can be extended easily with [definition](../../getting-started/definition). You have the following ways to discover and extend the platform. -* Refer to the following links to learn more built-in capabilities: - - [Built-in Component Reference](./references) - - [Built-in Trait Reference](../traits/references) - - [Built-in Policy Reference](../policies/references) - - [Built-in Workflow Step Reference](../workflow/built-in-workflow-defs) +## Learn more built-in capabilities -* Get more capabilities from [installing addons](../../how-to/cli/addon/addon), you can refer to [the overview of official addons](../../reference/addons/overview) for more details. +There're many out-of-box capabilities installed along with KubeVela controller, refer to the following links to learn more details: -* Develop and Extend KubeVela by yourself - - Read the [developer guide](../../contributor/overview) to learn how to contribute and extend capabilities for KubeVela. - - KubeVela use CUE as it's core engine, [learn CUE in KubeVela](../../platform-engineers/cue/basic) and try to extend with CUE configurations. - - [Building your own addons](../../platform-engineers/addon/intro) for extension, you can also [extend cloud resources by addon](../../platform-engineers/addon/terraform). + - [Built-in Component Reference](./references) + - [Built-in Trait Reference](../traits/references) + - [Built-in Policy Reference](../policies/references) + - [Built-in Workflow Step Reference](../workflow/built-in-workflow-defs) +## Manage Addons + +Installing addon from the community is also one of the most important way to discover more capabilities. + +### List Addons + +KubeVela community has maintained a growing [catalog of addons](https://github.com/kubevela/catalog) which will be synced to the default addon registry (https://addons.kubevela.net). You can use vela command line to list all available addons by: + +```shell +vela addon list +``` + +The command will show the basic addon info along with all available versions. + +```console +NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS +rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled +terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled +terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled +dex KubeVela Enable dex for login [0.6.5] disabled +fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled +velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0) +terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled +...snip... +``` + +* You can refer to [addon reference docs](../../reference/addons/overview) for more details of these community certificated addons. + +### Install Addon + +The simplest command for installing one addon is: + +```shell +vela addon enable fluxcd +``` + +The expected output should be: +```console +I0111 21:45:24.553174 89345 apply.go:106] "creating object" name="addon-fluxcd" resource="core.oam.dev/v1beta1, Kind=Application" +I0111 21:45:25.258914 89345 apply.go:106] "creating object" name="helm" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" +I0111 21:45:25.342731 89345 apply.go:106] "creating object" name="kustomize-json-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" +I0111 21:45:25.382201 89345 apply.go:106] "creating object" name="kustomize-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" +I0111 21:45:25.411723 89345 apply.go:106] "creating object" name="kustomize" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" +I0111 21:45:25.625815 89345 apply.go:106] "creating object" name="kustomize-strategy-merge" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" +I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-uischema-helm" resource="/v1, Kind=ConfigMap" +Addon: fluxcd enabled Successfully. +``` + +You can also install addons with some advanced flags. + +* Choose one specific version by adding `--version` flag in this command. eg: + +```shell +vela addon enable fluxcd --version=1.0.0 +``` + +* Choose specific clusters for installation. You can use `--cluster` flag to choose specific clusters. eg: + +```shell +vela addon enable --clusters={cluster1,cluster2} +``` + +By default, the place for installation is specified as control plane cluster or managed cluster inside the metadata of addon. + +### Discover the capabilities installed + +Once addon installed, end user can discover and use these capabilities immediately. + +* Generally, end user can list the new component or trait types added by `vela component` or `vela trait`. Refer to [Lifecycle of a Definition](../../getting-started/definition#lifecycle-of-a-definition) for more usage details. + +* You can also check the capability details of [community addon docs](../../reference/addons/overview). + +### Uninstall Addon + +> Please make sure the addon along with its capabilities is no longer used in any of your applications before uninstalling it. + +```shell +vela addon disable fluxcd +``` + +Expect output: +``` +Successfully disable addon:fluxcd +``` + +### Manage Addon Registry + +You can also manage the addon registries, such as adding/deleting your private addon registry. +Let's take the experimental community registry as example. + +* List your current registries + +``` +$ vela addon registry list +Name Type URL +KubeVela helm https://addons.kubevela.net +``` + +* Add a new registry + +``` +$ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/ +Successfully add an addon registry experimental +``` + +* Delete one registry + +``` +$ vela addon registry delete experimental +Successfully delete an addon registry experimental +``` + +### Air-Gapped Installation for Addon + +If your cluster network cannot request the community addon registry you can enable an addon with a local dir. eg: + +``` +$ ls +README.md fluxcd ocm-cluster-manager terraform terraform-alibaba terraform-aws terraform-azure velaux + +$ vela addon enable velaux/ +Addon: velaux enabled Successfully +``` + +Please notice that, while an addon installing cluster maybe still need pull some images or helm charts.If your cluster cannot reach these resources please refer [docs](../../platform-engineers/system-operation/enable-addon-offline) to do complete installation without internet. + +### Manage the addon with VelaUX + +If you have installed [VelaUX](../../reference/addons/velaux) which is also one of the addon, you can manage it directly on the UI console with admin privileges. + +![addon list](https://static.kubevela.net/images/1.3/addon-list.jpg) + +In the addon list, you can get the status of the addon and other info. Click the addon name could open the addon detail page, you can get the version list, definitions provided by the addon, and the readme message. + +![addon detail](https://static.kubevela.net/images/1.3/addon-detail.jpg) + +Select a version and deployed clusters, you can click the enable button to install this addon. + +For enabled addons, if no applications to use definitions, you can click the disable button to uninstall it. + + +### Make your own addon + +If you're a system infra or operator, you can refer to extension documents to learn how to [make your own addon and registry](../../platform-engineers/addon/intro), including [extend cloud resources by addon](../../platform-engineers/addon/terraform). + +## Extend KubeVela as a Developer + +If you're extremely interested in KubeVela, you can also extend more features as a developer. + +- Read the [developer guide](../../contributor/overview) to learn how to contribute and extend capabilities for KubeVela. +- KubeVela use CUE as it's core engine, [learn CUE in KubeVela](../../platform-engineers/cue/basic) and try to extend with CUE configurations. diff --git a/docs/getting-started/definition.md b/docs/getting-started/definition.md index 40b37e7b7f7..9d36b1a641e 100644 --- a/docs/getting-started/definition.md +++ b/docs/getting-started/definition.md @@ -15,7 +15,7 @@ There're two sources of definitions: - [Trait Definition](../end-user/traits/references) - [Policy Definition](../end-user/policies/references) - [Workflow Step Definition](../end-user/workflow/built-in-workflow-defs) -* Installation of addons will install definitions if there're new capabilities contained. You can refer to [the official addon registry](../reference/addons/overview) for more details. +* Installation of addons will install definitions if there're new capabilities contained. You can refer to [the community addon registry](../reference/addons/overview) for more details. ## Lifecycle of a Definition diff --git a/docs/how-to/cli/addon/addon.md b/docs/how-to/cli/addon/addon.md index 3d823601888..db956e94bb5 100644 --- a/docs/how-to/cli/addon/addon.md +++ b/docs/how-to/cli/addon/addon.md @@ -2,126 +2,4 @@ title: Addon management --- -You can get more capabilities from KubeVela ecosystem by installing addons. - -## Manage the addon via UI - -Users with addon management permissions can enter the addon management page to enable or disable addons. - -![addon list](https://static.kubevela.net/images/1.3/addon-list.jpg) - -In the addon list, you can get the status of the addon and other info. Click the addon name could open the addon detail page, you can get the version list, definitions provided by the addon, and the readme message. - -![addon detail](https://static.kubevela.net/images/1.3/addon-detail.jpg) - -Select a version and deployed clusters, you can click the enable button to install this addon. - -For enabled addons, if no applications to use definitions, you can click the disable button to uninstall it. - -## Manage the addon via CLI - -### List Addons - -By default, the following command lists addons from a default addon registry (https://addons.kubevela.net) maintained by KubeVela team. - -This command will show all available versions of every addon. - -```shell -$ vela addon list -NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS -ocm-gateway-manager-addon KubeVela ocm-gateway-manager-addon is the OCM addon automates the cluster-gateway apiserver. [1.3.2, 1.3.0, 1.1.11] disabled -rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled -terraform-baidu KubeVela Kubernetes Terraform Controller Provider for Baidu Cloud [1.0.1, 1.0.0] disabled -terraform-tencent KubeVela Kubernetes Terraform Controller Provider for Tencent Cloud [1.0.1, 1.0.0] disabled -model-serving KubeVela Enable serving for models [1.0.0] disabled -model-training KubeVela Enable training for models [1.0.0] disabled -terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled -terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled -terraform-azure KubeVela Kubernetes Terraform Controller for Azure [1.0.1, 1.0.0] disabled -terraform-gcp KubeVela Kubernetes Terraform Controller Provider for Google Cloud Platform [1.0.1, 1.0.0] disabled -dex KubeVela Enable dex for login [0.6.5] disabled -ocm-hub-control-plane KubeVela ocm-hub-control-plane can install OCM hub control plane to the central cluster. [0.6.0] disabled -terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for UCloud [1.0.1, 1.0.0] disabled -fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled -velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0) -terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled -``` - -### Install Addon - -``` -$ vela addon enable fluxcd -I0111 21:45:24.553174 89345 apply.go:106] "creating object" name="addon-fluxcd" resource="core.oam.dev/v1beta1, Kind=Application" -I0111 21:45:25.258914 89345 apply.go:106] "creating object" name="helm" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" -I0111 21:45:25.342731 89345 apply.go:106] "creating object" name="kustomize-json-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" -I0111 21:45:25.382201 89345 apply.go:106] "creating object" name="kustomize-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" -I0111 21:45:25.411723 89345 apply.go:106] "creating object" name="kustomize" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" -I0111 21:45:25.625815 89345 apply.go:106] "creating object" name="kustomize-strategy-merge" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" -I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-uischema-helm" resource="/v1, Kind=ConfigMap" -Addon: fluxcd enabled Successfully. -``` - -#### Install with specified version - -You can choose one special version of this addon by add `--version` flag in this command. eg: - -```shell -vela addon enable fluxcd --version=1.0.0 -``` - -By default, this command will install this addon in all managed-clusters.You can use `--cluster` flag to choose specific clusters. eg: - -```shell -vela addon enable --clusters={cluster1,cluster2} -``` - -You can view the new component or trait types added by `vela component` or `vela trait`. You can also find more details about [built-in addon docs](../../../reference/addons/overview). - -### Uninstall Addon - -> Please make sure this addon along with the capabilities is no longer used in any of your applications. - -``` -$ vela addon disable fluxcd -Successfully disable addon:fluxcd -``` - -### List Registry - -``` -$ vela addon registry list -Name Type URL -KubeVela helm https://addons.kubevela.net -``` - -### Add Registry - -``` -$ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/ -Successfully add an addon registry experimental -``` - -### Delete Registry - -``` -$ vela addon registry delete experimental -Successfully delete an addon registry experimental -``` - -### Air-Gapped Installation for Addon - -For some reason, if your cluster network cannot request the official addon registry you can enable an addon with a local dir. eg: - -``` -$ ls -README.md fluxcd ocm-cluster-manager terraform terraform-alibaba terraform-aws terraform-azure velaux - -$ vela addon enable velaux/ -Addon: velaux enabled Successfully -``` - -Please notice that, while a addon installing cluster maybe still need pull some images or helm charts.If your cluster cannot reach these resources please refer [docs](../../../platform-engineers/system-operation/enable-addon-offline) to do complete installation without Internet. - -## Make your own addon - -Refer to extension documents to learn how to [make your own addon and registry](../../../platform-engineers/addon/intro). \ No newline at end of file +The docs are migrated to [user guide](../../../end-user/components/more). \ No newline at end of file diff --git a/docs/platform-engineers/addon/intro.md b/docs/platform-engineers/addon/intro.md index c9f3031a99a..8a05bd01427 100644 --- a/docs/platform-engineers/addon/intro.md +++ b/docs/platform-engineers/addon/intro.md @@ -161,7 +161,7 @@ The schemas directory is used to store the UI-schema files corresponding to `X-D The above is a complete introduction to how to make an addon, you can find the complete description of the above-mentioned addon in this [catalog](https://github.com/kubevela/catalog/tree/master/experimental/addons/example) example. -In addition to uploading the addon resource files to your addon repository, you can also submit a pull request to KubeVela [official addon repository](https://github.com/kubevela/catalog/tree/master/addons) and [experimental addon repository](https://github.com/kubevela/catalog/tree/master/experimental/addons) to addon new addons. After pr merged your addons can be discovered and used by other KubeVela users. +In addition to uploading the addon resource files to your addon repository, you can also submit a pull request to KubeVela [community addon repository](https://github.com/kubevela/catalog/tree/master/addons) and [experimental addon repository](https://github.com/kubevela/catalog/tree/master/experimental/addons) to addon new addons. After pr merged your addons can be discovered and used by other KubeVela users. ## Install Addon Locally diff --git a/docs/platform-engineers/system-operation/enable-addon-offline.md b/docs/platform-engineers/system-operation/enable-addon-offline.md index de946c0327c..bf4f02a9289 100644 --- a/docs/platform-engineers/system-operation/enable-addon-offline.md +++ b/docs/platform-engineers/system-operation/enable-addon-offline.md @@ -8,7 +8,7 @@ Generally, you should git clone the repo which contained the addon configuration You can follow these steps as an example. -1. Git clone [the catalog repo](https://github.com/kubevela/catalog) to download these addon files. You can find all official addons in subdirectory `./addons/` and experimental addons in subdirectory `./experimental/addons`. +1. Git clone [the catalog repo](https://github.com/kubevela/catalog) to download these addon files. You can find all community addons in subdirectory `./addons/` and experimental addons in subdirectory `./experimental/addons`. ```yaml git clone https://github.com/kubevela/catalog @@ -43,7 +43,7 @@ $ vela addon enable /your/local/addon/directory ## Images or helm charts need to sync -Here's a list about images or helm charts of all official addons that should be synced for air-gapped installation. +Here's a list about images or helm charts of all community addons that should be synced for air-gapped installation. ### 1. FluxCD @@ -88,4 +88,4 @@ $ helm pull https://charts.kubevela.net/addons/terraform-controller-0.3.5.tgz 3. Extract the chart and modify the `values.yaml` change `image.repository` to your own image registry.Then push it to your helm chart museum. 4. Modify the addon file `terraform/resources/terraform-controller.cue` change `output.properties.url` to your chart museum's url. -Other official addons needn't sync any resources. \ No newline at end of file +Other community addons needn't sync any resources. \ No newline at end of file diff --git a/docs/reference/addons/overview.md b/docs/reference/addons/overview.md index 25bc8b564f7..5f004477e2c 100644 --- a/docs/reference/addons/overview.md +++ b/docs/reference/addons/overview.md @@ -2,7 +2,7 @@ title: Overview --- -There's an official addon registry (https://addons.kubevela.net) maintained by KubeVela team. It contains following addons: +There's an community addon registry (https://addons.kubevela.net) maintained by KubeVela team. It contains following addons: * [VelaUX](./velaux): The KubeVela User Experience (UX ) addon. It will launch a dashboard and an APIServer for better user experience. * [FluxCD](./fluxcd): Provides capability to deliver helm chart and drive GitOps. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current.json b/i18n/zh/docusaurus-plugin-content-docs/current.json index ae331e00271..d01dbc9b91f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh/docusaurus-plugin-content-docs/current.json @@ -215,8 +215,8 @@ "message": "资源管理", "description": "管理集群和交付目标等资源" }, - "sidebar.docs.category.Official Addons": { - "message": "官方插件", + "sidebar.docs.category.Community Addons": { + "message": "社区认证插件", "description": "内置插件说明" }, "sidebar.docs.category.Cloud Resources": { diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/non-code-contribute.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/non-code-contribute.md new file mode 100644 index 00000000000..13d862e1f24 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.4/contributor/non-code-contribute.md @@ -0,0 +1,47 @@ +--- +title: 非代码贡献手册 +--- + +你可以从以下选择任意一种你感兴趣的方式进行贡献。 + +## 贡献用例和样例 + +* 如果你正在使用 KubeVela，最简单的贡献就是共建[社区信用](https://github.com/kubevela/kubevela/issues/1662)。 +* 如果你有兴趣，你也可以在 kubevela.io 写一个[博客](https://kubevela.net/blog)来分享更多的用例。 +* 你也可以为 [KubeVela 官方样例](https://github.com/kubevela/samples)做出贡献。 + +## 报告 bugs + +在提交一个新的问题之前，尽量先确认是否有人已经报告过这个问题。在[已有的问题](https://github.com/kubevela/kubevela/issues)中寻找类似的问题。 + +通过提交 [bug report](https://github.com/kubevela/kubevela/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.md&title=) 来上报 bug，但你需要提供尽可能多的信息来重现该 bug。 + +遵循问题模板并添加有助于我们复现问题的额外信息。 + +### 安全问题 + +如果你认为你发现了一个安全漏洞，请阅读我们的[安全策略](https://github.com/kubevela/kubevela/blob/master/SECURITY.md)以了解更多细节。 + +## 建议改进 + +如果你有改进 KubeVela 的想法，请提交[功能请求](https://github.com/kubevela/kubevela/issues/new?assignees=&labels=kind%2Ffeature&template=feature_request.md&title=%5BFeature%5D)。 + +## 处理问题 + +如果你暂时没有能力或时间来编码，可以考虑帮助问题分类。社区会感谢你的协助工作。 + +阅读更多关于如何进行[分类问题](https://github.com/kubevela/community/blob/main/ISSUE_TRIAGE.md)的方法。 + +## 回答问题 + +如果你的问题在[文档](https://kubevela.io/zh/docs/)中找不到答案，那你可以在 [Github 讨论](https://github.com/kubevela/kubevela/discussions)中提出。 + +在帮助用户方面，我们也希望获得你的帮助。你可以通过回答[其他 KubeVela 用户的问题](https://github.com/kubevela/kubevela/discussions)来帮助他们。 + +## 文档贡献 + +贡献文档需要学习关于如何在 Github 上提出 pull request 的知识。可以遵循以下手册，这不会很困难。 + +* [kubevela.io 开发者手册](https://github.com/kubevela/kubevela.io/blob/main/README.md) + +关于更多的贡献方式，请查看[开源手册](https://opensource.guide/how-to-contribute/)。 \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index f348332f23d..13378221fd9 100644 --- a/sidebars.js +++ b/sidebars.js @@ -131,7 +131,6 @@ module.exports = { 'how-to/dashboard/config/helm-repo', ], }, - 'how-to/cli/addon/addon', 'platform-engineers/system-operation/observability', 'platform-engineers/system-operation/performance-finetuning', { @@ -224,7 +223,7 @@ module.exports = { 'end-user/workflow/built-in-workflow-defs', { type: 'category', - label: 'Official Addons', + label: 'Community Addons', items: [ 'reference/addons/overview', 'reference/addons/velaux', diff --git a/versioned_docs/version-v1.4/end-user/components/more.md b/versioned_docs/version-v1.4/end-user/components/more.md index a72e1814aff..57b4942f580 100644 --- a/versioned_docs/version-v1.4/end-user/components/more.md +++ b/versioned_docs/version-v1.4/end-user/components/more.md @@ -2,18 +2,165 @@ title: Needs More？ --- -KubeVela is programmable, you have the following ways to discover and extend the platform. +KubeVela is programmable, it can be extended easily with [definition](../../getting-started/definition). You have the following ways to discover and extend the platform. -* Refer to the following links to learn more built-in capabilities: - - [Built-in Component Reference](./references) - - [Built-in Trait Reference](../traits/references) - - [Built-in Policy Reference](../policies/references) - - [Built-in Workflow Step Reference](../workflow/built-in-workflow-defs) +## Learn more built-in capabilities -* Get more capabilities from [installing addons](../../how-to/cli/addon/addon), you can refer to [the overview of official addons](../../reference/addons/overview) for more details. +There're many out-of-box capabilities installed along with KubeVela controller, refer to the following links to learn more details: -* Develop and Extend KubeVela by yourself - - Read the [developer guide](../../contributor/overview) to learn how to contribute and extend capabilities for KubeVela. - - KubeVela use CUE as it's core engine, [learn CUE in KubeVela](../../platform-engineers/cue/basic) and try to extend with CUE configurations. - - [Building your own addons](../../platform-engineers/addon/intro) for extension, you can also [extend cloud resources by addon](../../platform-engineers/addon/terraform). + - [Built-in Component Reference](./references) + - [Built-in Trait Reference](../traits/references) + - [Built-in Policy Reference](../policies/references) + - [Built-in Workflow Step Reference](../workflow/built-in-workflow-defs) +## Manage Addons + +Installing addon from the community is also one of the most important way to discover more capabilities. + +### List Addons + +KubeVela community has maintained a growing [catalog of addons](https://github.com/kubevela/catalog) which will be synced to the default addon registry (https://addons.kubevela.net). You can use vela command line to list all available addons by: + +```shell +vela addon list +``` + +The command will show the basic addon info along with all available versions. + +```console +NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS +rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled +terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled +terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled +dex KubeVela Enable dex for login [0.6.5] disabled +fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled +velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0) +terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled +...snip... +``` + +* You can refer to [addon reference docs](../../reference/addons/overview) for more details of these community certificated addons. + +### Install Addon + +The simplest command for installing one addon is: + +```shell +vela addon enable fluxcd +``` + +The expected output should be: +```console +I0111 21:45:24.553174 89345 apply.go:106] "creating object" name="addon-fluxcd" resource="core.oam.dev/v1beta1, Kind=Application" +I0111 21:45:25.258914 89345 apply.go:106] "creating object" name="helm" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" +I0111 21:45:25.342731 89345 apply.go:106] "creating object" name="kustomize-json-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" +I0111 21:45:25.382201 89345 apply.go:106] "creating object" name="kustomize-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" +I0111 21:45:25.411723 89345 apply.go:106] "creating object" name="kustomize" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" +I0111 21:45:25.625815 89345 apply.go:106] "creating object" name="kustomize-strategy-merge" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" +I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-uischema-helm" resource="/v1, Kind=ConfigMap" +Addon: fluxcd enabled Successfully. +``` + +You can also install addons with some advanced flags. + +* Choose one specific version by adding `--version` flag in this command. eg: + +```shell +vela addon enable fluxcd --version=1.0.0 +``` + +* Choose specific clusters for installation. You can use `--cluster` flag to choose specific clusters. eg: + +```shell +vela addon enable --clusters={cluster1,cluster2} +``` + +By default, the place for installation is specified as control plane cluster or managed cluster inside the metadata of addon. + +### Discover the capabilities installed + +Once addon installed, end user can discover and use these capabilities immediately. + +* Generally, end user can list the new component or trait types added by `vela component` or `vela trait`. Refer to [Lifecycle of a Definition](../../getting-started/definition#lifecycle-of-a-definition) for more usage details. + +* You can also check the capability details of [community addon docs](../../reference/addons/overview). + +### Uninstall Addon + +> Please make sure the addon along with its capabilities is no longer used in any of your applications before uninstalling it. + +```shell +vela addon disable fluxcd +``` + +Expect output: +``` +Successfully disable addon:fluxcd +``` + +### Manage Addon Registry + +You can also manage the addon registries, such as adding/deleting your private addon registry. +Let's take the experimental community registry as example. + +* List your current registries + +``` +$ vela addon registry list +Name Type URL +KubeVela helm https://addons.kubevela.net +``` + +* Add a new registry + +``` +$ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/ +Successfully add an addon registry experimental +``` + +* Delete one registry + +``` +$ vela addon registry delete experimental +Successfully delete an addon registry experimental +``` + +### Air-Gapped Installation for Addon + +If your cluster network cannot request the community addon registry you can enable an addon with a local dir. eg: + +``` +$ ls +README.md fluxcd ocm-cluster-manager terraform terraform-alibaba terraform-aws terraform-azure velaux + +$ vela addon enable velaux/ +Addon: velaux enabled Successfully +``` + +Please notice that, while an addon installing cluster maybe still need pull some images or helm charts.If your cluster cannot reach these resources please refer [docs](../../platform-engineers/system-operation/enable-addon-offline) to do complete installation without internet. + +### Manage the addon with VelaUX + +If you have installed [VelaUX](../../reference/addons/velaux) which is also one of the addon, you can manage it directly on the UI console with admin privileges. + +![addon list](https://static.kubevela.net/images/1.3/addon-list.jpg) + +In the addon list, you can get the status of the addon and other info. Click the addon name could open the addon detail page, you can get the version list, definitions provided by the addon, and the readme message. + +![addon detail](https://static.kubevela.net/images/1.3/addon-detail.jpg) + +Select a version and deployed clusters, you can click the enable button to install this addon. + +For enabled addons, if no applications to use definitions, you can click the disable button to uninstall it. + + +### Make your own addon + +If you're a system infra or operator, you can refer to extension documents to learn how to [make your own addon and registry](../../platform-engineers/addon/intro), including [extend cloud resources by addon](../../platform-engineers/addon/terraform). + +## Extend KubeVela as a Developer + +If you're extremely interested in KubeVela, you can also extend more features as a developer. + +- Read the [developer guide](../../contributor/overview) to learn how to contribute and extend capabilities for KubeVela. +- KubeVela use CUE as it's core engine, [learn CUE in KubeVela](../../platform-engineers/cue/basic) and try to extend with CUE configurations. diff --git a/versioned_docs/version-v1.4/getting-started/definition.md b/versioned_docs/version-v1.4/getting-started/definition.md index 40b37e7b7f7..9d36b1a641e 100644 --- a/versioned_docs/version-v1.4/getting-started/definition.md +++ b/versioned_docs/version-v1.4/getting-started/definition.md @@ -15,7 +15,7 @@ There're two sources of definitions: - [Trait Definition](../end-user/traits/references) - [Policy Definition](../end-user/policies/references) - [Workflow Step Definition](../end-user/workflow/built-in-workflow-defs) -* Installation of addons will install definitions if there're new capabilities contained. You can refer to [the official addon registry](../reference/addons/overview) for more details. +* Installation of addons will install definitions if there're new capabilities contained. You can refer to [the community addon registry](../reference/addons/overview) for more details. ## Lifecycle of a Definition diff --git a/versioned_docs/version-v1.4/how-to/cli/addon/addon.md b/versioned_docs/version-v1.4/how-to/cli/addon/addon.md index 3d823601888..db956e94bb5 100644 --- a/versioned_docs/version-v1.4/how-to/cli/addon/addon.md +++ b/versioned_docs/version-v1.4/how-to/cli/addon/addon.md @@ -2,126 +2,4 @@ title: Addon management --- -You can get more capabilities from KubeVela ecosystem by installing addons. - -## Manage the addon via UI - -Users with addon management permissions can enter the addon management page to enable or disable addons. - -![addon list](https://static.kubevela.net/images/1.3/addon-list.jpg) - -In the addon list, you can get the status of the addon and other info. Click the addon name could open the addon detail page, you can get the version list, definitions provided by the addon, and the readme message. - -![addon detail](https://static.kubevela.net/images/1.3/addon-detail.jpg) - -Select a version and deployed clusters, you can click the enable button to install this addon. - -For enabled addons, if no applications to use definitions, you can click the disable button to uninstall it. - -## Manage the addon via CLI - -### List Addons - -By default, the following command lists addons from a default addon registry (https://addons.kubevela.net) maintained by KubeVela team. - -This command will show all available versions of every addon. - -```shell -$ vela addon list -NAME REGISTRY DESCRIPTION AVAILABLE-VERSIONS STATUS -ocm-gateway-manager-addon KubeVela ocm-gateway-manager-addon is the OCM addon automates the cluster-gateway apiserver. [1.3.2, 1.3.0, 1.1.11] disabled -rollout KubeVela Provides basic batch publishing capability. [1.3.0, 1.2.4, 1.2.3] disabled -terraform-baidu KubeVela Kubernetes Terraform Controller Provider for Baidu Cloud [1.0.1, 1.0.0] disabled -terraform-tencent KubeVela Kubernetes Terraform Controller Provider for Tencent Cloud [1.0.1, 1.0.0] disabled -model-serving KubeVela Enable serving for models [1.0.0] disabled -model-training KubeVela Enable training for models [1.0.0] disabled -terraform KubeVela Terraform Controller is a Kubernetes Controller for Terraform. [1.0.6] disabled -terraform-aws KubeVela Kubernetes Terraform Controller for AWS [1.0.1, 1.0.0] disabled -terraform-azure KubeVela Kubernetes Terraform Controller for Azure [1.0.1, 1.0.0] disabled -terraform-gcp KubeVela Kubernetes Terraform Controller Provider for Google Cloud Platform [1.0.1, 1.0.0] disabled -dex KubeVela Enable dex for login [0.6.5] disabled -ocm-hub-control-plane KubeVela ocm-hub-control-plane can install OCM hub control plane to the central cluster. [0.6.0] disabled -terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for UCloud [1.0.1, 1.0.0] disabled -fluxcd KubeVela Extended workload to do continuous and progressive delivery [1.1.0, 1.0.0] disabled -velaux KubeVela KubeVela User Experience (UX). An extensible, application-oriented delivery and management Dashboard. [v1.3.0, v1.3.0-beta.2, 1.2.4] enabled (v1.3.0) -terraform-alibaba KubeVela Kubernetes Terraform Controller for Alibaba Cloud [1.0.2, 1.0.1] disabled -``` - -### Install Addon - -``` -$ vela addon enable fluxcd -I0111 21:45:24.553174 89345 apply.go:106] "creating object" name="addon-fluxcd" resource="core.oam.dev/v1beta1, Kind=Application" -I0111 21:45:25.258914 89345 apply.go:106] "creating object" name="helm" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" -I0111 21:45:25.342731 89345 apply.go:106] "creating object" name="kustomize-json-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" -I0111 21:45:25.382201 89345 apply.go:106] "creating object" name="kustomize-patch" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" -I0111 21:45:25.411723 89345 apply.go:106] "creating object" name="kustomize" resource="core.oam.dev/v1beta1, Kind=ComponentDefinition" -I0111 21:45:25.625815 89345 apply.go:106] "creating object" name="kustomize-strategy-merge" resource="core.oam.dev/v1beta1, Kind=TraitDefinition" -I0111 21:45:25.660129 89345 apply.go:106] "creating object" name="component-uischema-helm" resource="/v1, Kind=ConfigMap" -Addon: fluxcd enabled Successfully. -``` - -#### Install with specified version - -You can choose one special version of this addon by add `--version` flag in this command. eg: - -```shell -vela addon enable fluxcd --version=1.0.0 -``` - -By default, this command will install this addon in all managed-clusters.You can use `--cluster` flag to choose specific clusters. eg: - -```shell -vela addon enable --clusters={cluster1,cluster2} -``` - -You can view the new component or trait types added by `vela component` or `vela trait`. You can also find more details about [built-in addon docs](../../../reference/addons/overview). - -### Uninstall Addon - -> Please make sure this addon along with the capabilities is no longer used in any of your applications. - -``` -$ vela addon disable fluxcd -Successfully disable addon:fluxcd -``` - -### List Registry - -``` -$ vela addon registry list -Name Type URL -KubeVela helm https://addons.kubevela.net -``` - -### Add Registry - -``` -$ vela addon registry add experimental --type=helm --endpoint=https://addons.kubevela.net/experimental/ -Successfully add an addon registry experimental -``` - -### Delete Registry - -``` -$ vela addon registry delete experimental -Successfully delete an addon registry experimental -``` - -### Air-Gapped Installation for Addon - -For some reason, if your cluster network cannot request the official addon registry you can enable an addon with a local dir. eg: - -``` -$ ls -README.md fluxcd ocm-cluster-manager terraform terraform-alibaba terraform-aws terraform-azure velaux - -$ vela addon enable velaux/ -Addon: velaux enabled Successfully -``` - -Please notice that, while a addon installing cluster maybe still need pull some images or helm charts.If your cluster cannot reach these resources please refer [docs](../../../platform-engineers/system-operation/enable-addon-offline) to do complete installation without Internet. - -## Make your own addon - -Refer to extension documents to learn how to [make your own addon and registry](../../../platform-engineers/addon/intro). \ No newline at end of file +The docs are migrated to [user guide](../../../end-user/components/more). \ No newline at end of file diff --git a/versioned_docs/version-v1.4/platform-engineers/addon/intro.md b/versioned_docs/version-v1.4/platform-engineers/addon/intro.md index c9f3031a99a..8a05bd01427 100644 --- a/versioned_docs/version-v1.4/platform-engineers/addon/intro.md +++ b/versioned_docs/version-v1.4/platform-engineers/addon/intro.md @@ -161,7 +161,7 @@ The schemas directory is used to store the UI-schema files corresponding to `X-D The above is a complete introduction to how to make an addon, you can find the complete description of the above-mentioned addon in this [catalog](https://github.com/kubevela/catalog/tree/master/experimental/addons/example) example. -In addition to uploading the addon resource files to your addon repository, you can also submit a pull request to KubeVela [official addon repository](https://github.com/kubevela/catalog/tree/master/addons) and [experimental addon repository](https://github.com/kubevela/catalog/tree/master/experimental/addons) to addon new addons. After pr merged your addons can be discovered and used by other KubeVela users. +In addition to uploading the addon resource files to your addon repository, you can also submit a pull request to KubeVela [community addon repository](https://github.com/kubevela/catalog/tree/master/addons) and [experimental addon repository](https://github.com/kubevela/catalog/tree/master/experimental/addons) to addon new addons. After pr merged your addons can be discovered and used by other KubeVela users. ## Install Addon Locally diff --git a/versioned_docs/version-v1.4/platform-engineers/system-operation/enable-addon-offline.md b/versioned_docs/version-v1.4/platform-engineers/system-operation/enable-addon-offline.md index de946c0327c..bf4f02a9289 100644 --- a/versioned_docs/version-v1.4/platform-engineers/system-operation/enable-addon-offline.md +++ b/versioned_docs/version-v1.4/platform-engineers/system-operation/enable-addon-offline.md @@ -8,7 +8,7 @@ Generally, you should git clone the repo which contained the addon configuration You can follow these steps as an example. -1. Git clone [the catalog repo](https://github.com/kubevela/catalog) to download these addon files. You can find all official addons in subdirectory `./addons/` and experimental addons in subdirectory `./experimental/addons`. +1. Git clone [the catalog repo](https://github.com/kubevela/catalog) to download these addon files. You can find all community addons in subdirectory `./addons/` and experimental addons in subdirectory `./experimental/addons`. ```yaml git clone https://github.com/kubevela/catalog @@ -43,7 +43,7 @@ $ vela addon enable /your/local/addon/directory ## Images or helm charts need to sync -Here's a list about images or helm charts of all official addons that should be synced for air-gapped installation. +Here's a list about images or helm charts of all community addons that should be synced for air-gapped installation. ### 1. FluxCD @@ -88,4 +88,4 @@ $ helm pull https://charts.kubevela.net/addons/terraform-controller-0.3.5.tgz 3. Extract the chart and modify the `values.yaml` change `image.repository` to your own image registry.Then push it to your helm chart museum. 4. Modify the addon file `terraform/resources/terraform-controller.cue` change `output.properties.url` to your chart museum's url. -Other official addons needn't sync any resources. \ No newline at end of file +Other community addons needn't sync any resources. \ No newline at end of file diff --git a/versioned_docs/version-v1.4/reference/addons/overview.md b/versioned_docs/version-v1.4/reference/addons/overview.md index 25bc8b564f7..5f004477e2c 100644 --- a/versioned_docs/version-v1.4/reference/addons/overview.md +++ b/versioned_docs/version-v1.4/reference/addons/overview.md @@ -2,7 +2,7 @@ title: Overview --- -There's an official addon registry (https://addons.kubevela.net) maintained by KubeVela team. It contains following addons: +There's an community addon registry (https://addons.kubevela.net) maintained by KubeVela team. It contains following addons: * [VelaUX](./velaux): The KubeVela User Experience (UX ) addon. It will launch a dashboard and an APIServer for better user experience. * [FluxCD](./fluxcd): Provides capability to deliver helm chart and drive GitOps. diff --git a/versioned_sidebars/version-v1.4-sidebars.json b/versioned_sidebars/version-v1.4-sidebars.json index 4c5aa8c3fb5..ca226fa45a2 100644 --- a/versioned_sidebars/version-v1.4-sidebars.json +++ b/versioned_sidebars/version-v1.4-sidebars.json @@ -290,10 +290,6 @@ } ] }, - { - "type": "doc", - "id": "version-v1.4/how-to/cli/addon/addon" - }, { "type": "doc", "id": "version-v1.4/platform-engineers/system-operation/observability" @@ -517,7 +513,7 @@ { "collapsed": true, "type": "category", - "label": "Official Addons", + "label": "Community Addons", "items": [ { "type": "doc",