kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Change kubectl-vela comp/trait docs to vela CLI (#355) 

* Change kubectl-vela comp/trait docs to vela CLI

* use `vela trait/comp/registry`

* Fix grammar, restore definition usage
This commit is contained in:
qiaozp 2021-10-27 16:00:14 +08:00 committed by GitHub
parent c7239059ad
commit 7109154b09
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 99 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/developers/cap-center.md
View File

@ -8,35 +8,28 @@ KubeVela is able to discover OAM definition files in this repo automatically and
## Add a capability center ## Add a capability center
Add and sync a capability center in KubeVela: Add a registry in KubeVela:
```bash ```bash
vela cap center config my-center https://github.com/oam-dev/catalog/tree/master/registry vela registry config my-center https://github.com/oam-dev/catalog/tree/master/registry
``` ```
```console ```console
successfully sync 1/1 from my-center remote center Successfully configured registry my-center
Successfully configured capability center my-center and sync from remote
```
```bash
vela cap center sync my-center
```
```console
successfully sync 1/1 from my-center remote center
sync finished
``` ```
Now, this capability center `my-center` is ready to use. Now, this registry `my-center` is ready to use.
## List capability centers ## List capability centers
You are allowed to add more capability centers and list them. You are allowed to add more capability centers and list them.
```bash ```bash
vela cap center ls vela registry ls
``` ```
```console ```console
NAME ADDRESS NAME URL
my-center https://github.com/oam-dev/catalog/tree/master/registry default oss://registry.kubevela.net/
my-center https://github.com/oam-dev/catalog/tree/master/registry
``` ```
## [Optional] Remove a capability center ## [Optional] Remove a capability center
@ -44,20 +37,16 @@ my-center https://github.com/oam-dev/catalog/tree/master/registry
Or, remove one. Or, remove one.
```bash ```bash
vela cap center remove my-center vela registry remove my-center
``` ```
## List all available capabilities in capability center ## List all available capabilities in capability center
Or, list all available capabilities in certain center. Or, list all available ComponentDefinition/TraitDefinition in certain registry.
```bash ```bash
vela cap ls my-center vela trait --discover --registry=my-center
``` vela comp --discover --registry=my-center
```console
NAME CENTER TYPE DEFINITION STATUS APPLIES-TO
clonesetservice my-center componentDefinition clonesets.apps.kruise.io uninstalled []
```
## Install a capability from capability center ## Install a capability from capability center
@ -72,11 +61,7 @@ helm install kruise https://github.com/openkruise/kruise/releases/download/v0.7.
Install `clonesetservice` component from `my-center`. Install `clonesetservice` component from `my-center`.
```bash ```bash
vela cap install my-center/clonesetservice vela comp get clonesetservice --registry=my-center
```
```console
Installing component capability clonesetservice
Successfully installed capability clonesetservice from my-center
``` ```
## Use the newly installed capability ## Use the newly installed capability
@ -145,8 +130,5 @@ testsvc 1 1 1 1 1 46s
> NOTE: make sure no apps are using the capability before uninstalling. > NOTE: make sure no apps are using the capability before uninstalling.
```bash ```bash
vela cap uninstall my-center/clonesetservice kubectl delete componentdefinition -n vela-system clonesetservice
``` ```
```console
Successfully uninstalled capability clonesetservice
```

20
docs/end-user/components/more.md
View File

@ -8,23 +8,27 @@ You can get more from official capability registry by using KubeVela [plugin](..
### List ### List
By default, the commands will list capabilities from [repo](https://registry.kubevela.net) maintained by KubeVela. By default, the following command lists capabilities from [the default registry](https://registry.kubevela.net) maintained by KubeVela.
```shell ```shell
$ kubectl vela comp --discover $ vela comp --discover
Showing components from registry: oss://registry.kubevela.net Listing component definition from registry: default
NAME REGISTRY DEFINITION NAME REGISTRY DEFINITION STATUS
webserver default deployments.apps kustomize default autodetects.core.oam.dev installed
webserver default deployments.apps uninstalled
``` ```
`--discover` means list components from registry
### Install ### Install
Then you can install a component like: Then you can install a component like:
```shell ```shell
$ kubectl vela comp get webserver $ vela comp get webserver
Installing component capability webserver Getting component definition from registry: default
Successfully install component: webserver Installing component: webserver
Successfully install component: webserver
``` ```
## 2. Designed by yourself ## 2. Designed by yourself

39
docs/end-user/traits/more.md
View File

@ -8,33 +8,38 @@ You can get more from official capability registry by using KubeVela [plugin](..
### List ### List
By default, the commands will list capabilities from [repo](https://registry.kubevela.net) maintained by KubeVela. By default, the following command lists capabilities from [the default registry](https://registry.kubevela.net) maintained by KubeVela.
```shell ```shell
$ kubectl vela trait --discover $ vela trait --discover
Showing traits from registry: https://registry.kubevela.net Showing trait definition from registry: default
NAME REGISTRY DEFINITION APPLIES-TO NAME REGISTRY DEFINITION APPLIES-TO STATUS
service-account default [webservice worker] autoscale default autoscalers.standard.oam.dev [deployments.apps] uninstalled
env default [webservice worker] crd-manual-scaler default manualscalertraits.core.oam.dev [deployments.apps] uninstalled
flagger-rollout default canaries.flagger.app [webservice] dynamic-sa default [deployments.apps] uninstalled
init-container default [webservice worker] env default [deployments.apps] installed
keda-scaler default scaledobjects.keda.sh [deployments.apps] expose default [] installed
metrics default metricstraits.standard.oam.dev [webservice backend task] hpa default [deployments.apps] uninstalled
node-affinity default [webservice worker] init-container default [deployments.apps] installed
route default routes.standard.oam.dev [webservice] kautoscale default [deployments.apps] uninstalled
virtualgroup default [webservice worker] metrics default metricstraits.standard.oam.dev [deployments.apps jobs.batch] uninstalled
node-affinity default [deployments.apps] installed
rollout default canaries.flagger.app [deployments.apps] installed
route default routes.standard.oam.dev [deployments.apps] uninstalled
virtualgroup default [deployments.apps] uninstalled
``` ```
Note that the `--discover` flag means show all traits not in your cluster. `--discover` means list components from registry
### Install ### Install
Then you can install a trait like: Then you can install a trait like:
```shell ```shell
$ kubectl vela trait get init-container $ vela trait get init-container
Installing component capability init-container Getting component definition from registry: default
Successfully install trait: init-container Installing component: init-container
Successfully install trait: init-container
``` ```
## 2. Designed by yourself ## 2. Designed by yourself

34
i18n/zh/docusaurus-plugin-content-docs/current/developers/cap-center.md
View File

@ -8,16 +8,11 @@ KubeVela 可以从这些仓库中自动发现 OAM 抽象文件，并且同步这
## 添加能力中心 ## 添加能力中心
新增且同步能力中心到 KubeVela： 新增能力中心到 KubeVela：
```bash ```bash
$ vela cap center config my-center https://github.com/oam-dev/catalog/tree/master/registry vela registry config my-center https://github.com/oam-dev/catalog/tree/master/registry
successfully sync 1/1 from my-center remote center Successfully configured registry my-center
Successfully configured capability center my-center and sync from remote
$ vela cap center sync my-center
successfully sync 1/1 from my-center remote center
sync finished
``` ```
现在，该能力中心 `my-center` 已经可以使用。 现在，该能力中心 `my-center` 已经可以使用。
@ -27,9 +22,10 @@ sync finished
你可以列出或者添加更多能力中心。 你可以列出或者添加更多能力中心。
```bash ```bash
$ vela cap center ls vela registry ls
NAME ADDRESS NAME URL
my-center https://github.com/oam-dev/catalog/tree/master/registry default oss://registry.kubevela.net/
my-center https://github.com/oam-dev/catalog/tree/master/registry
``` ```
## [可选] 删除能力中心 ## [可选] 删除能力中心
@ -37,17 +33,16 @@ my-center https://github.com/oam-dev/catalog/tree/master/registry
删除一个 删除一个
```bash ```bash
$ vela cap center remove my-center vela registry remove my-center
``` ```
## 列出所有可用的能力中心 ## 列出所有可用的能力中心
列出某个中心所有可用的能力。 列出某个中心所有可用的 ComponentDefinition/TraitDefinition。
```bash ```bash
$ vela cap ls my-center vela trait --discover --registry=my-center
NAME CENTER TYPE DEFINITION STATUS APPLIES-TO vela comp --discover --registry=my-center
clonesetservice my-center componentDefinition clonesets.apps.kruise.io uninstalled []
``` ```
## 从能力中心安装能力 ## 从能力中心安装能力
@ -63,9 +58,7 @@ helm install kruise https://github.com/openkruise/kruise/releases/download/v0.7.
从 `my-center` 中安装 `clonesetservice` component 。 从 `my-center` 中安装 `clonesetservice` component 。
```bash ```bash
$ vela cap install my-center/clonesetservice vela comp get clonesetservice --registry=my-center
Installing component capability clonesetservice
Successfully installed capability clonesetservice from my-center
``` ```
## 使用新安装的能力 ## 使用新安装的能力
@ -128,6 +121,5 @@ testsvc 1 1 1 1 1 46s
> 注意，删除能力前请先确认没有被应用引用。 > 注意，删除能力前请先确认没有被应用引用。
```bash ```bash
$ vela cap uninstall my-center/clonesetservice kubectl delete componentdefinition -n vela-system clonesetservice
Successfully uninstalled capability clonesetservice
``` ```

23
i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/more.md
View File

@ -6,29 +6,32 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
## 1. 从官方或第三方能力中心获取模块化能力 ## 1. 从官方或第三方能力中心获取模块化能力
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
### 查看能力中心的模块列表 ### 查看能力中心的模块列表
默认情况下，命令会从 KubeVela 官方维护的[能力中心](https://registry.kubevela.net)中获取模块化功能。 默认情况下，命令会从 KubeVela 官方维护的[能力中心](https://registry.kubevela.net)中获取模块化功能。
例如，让我们尝试列出注册表中所有可用的组件，使用 `--discover` 这个标志位： 例如，让我们尝试列出能力中心中所有可用的组件，使用 `--discover` 这个标志位：
```shell ```shell
$ kubectl vela comp --discover $ vela comp --discover
Showing components from registry: oss://registry.kubevela.net Listing component definition from registry: default
NAME REGISTRY DEFINITION NAME REGISTRY DEFINITION STATUS
webserver default deployments.apps kustomize default autodetects.core.oam.dev installed
webserver default deployments.apps uninstalled
``` ```
`--discover` 表明将从能力中心发现能力并列出
### 从能力中心安装模块 ### 从能力中心安装模块
然后你可以安装一个组件，如： 然后你可以安装一个组件，如：
```shell ```shell
$ kubectl vela comp get webserver $ vela comp get webserver
Installing component capability webserver Getting component definition from registry: default
Successfully install component: webserver Installing component: webserver
Successfully install component: webserver
``` ```
## 2. 自定义模块化能力 ## 2. 自定义模块化能力

43
i18n/zh/docusaurus-plugin-content-docs/current/end-user/traits/more.md
View File

@ -6,38 +6,43 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
## 1. 从官方或第三方能力中心获取模块化能力 ## 1. 从官方或第三方能力中心获取模块化能力
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
### 查看能力中心的模块列表 ### 查看能力中心的模块列表
默认情况下，命令会从 KubeVela 官方维护的[能力中心](https://registry.kubevela.net)中获取模块化功能。 默认情况下，命令会从 KubeVela 官方维护的[能力中心](https://registry.kubevela.net)中获取模块化功能。
例如，让我们尝试列出注册表中所有可用的 trait： 例如，让我们尝试列出能力中心中所有可用的 trait：
```shell ```shell
$ kubectl vela trait --discover $ vela trait --discover
Showing traits from registry: https://registry.kubevela.net Showing trait definition from registry: default
NAME REGISTRY DEFINITION APPLIES-TO I1025 19:18:59.276330 80303 request.go:665] Waited for 1.042612105s due to client-side throttling, not priority and fairness, request: GET:https://127.0.0.1:63926/apis/standard.oam.dev/v1alpha1?timeout=32s
service-account default [webservice worker] NAME REGISTRY DEFINITION APPLIES-TO STATUS
env default [webservice worker] autoscale default autoscalers.standard.oam.dev [deployments.apps] uninstalled
flagger-rollout default canaries.flagger.app [webservice] crd-manual-scaler default manualscalertraits.core.oam.dev [deployments.apps] uninstalled
init-container default [webservice worker] dynamic-sa default [deployments.apps] uninstalled
keda-scaler default scaledobjects.keda.sh [deployments.apps] env default [deployments.apps] installed
metrics default metricstraits.standard.oam.dev [webservice backend task] expose default [] installed
node-affinity default [webservice worker] hpa default [deployments.apps] uninstalled
route default routes.standard.oam.dev [webservice] init-container default [deployments.apps] installed
virtualgroup default [webservice worker] kautoscale default [deployments.apps] uninstalled
metrics default metricstraits.standard.oam.dev [deployments.apps jobs.batch] uninstalled
node-affinity default [deployments.apps] installed
rollout default canaries.flagger.app [deployments.apps] installed
route default routes.standard.oam.dev [deployments.apps] uninstalled
virtualgroup default [deployments.apps] uninstalled
``` ```
请注意，`--discover` 标志表示显示不在集群中的所有特征。
`--discover` 表明将从能力中心发现能力并列出
### 从能力中心安装模块 ### 从能力中心安装模块
然后你可以安装一个 trait，如： 然后你可以安装一个 trait，如：
```shell ```shell
$ kubectl vela trait get init-container $ vela trait get init-container
Installing component capability init-container Getting component definition from registry: default
Successfully install trait: init-container Installing component: init-container
Successfully install trait: init-container
``` ```
## 2. 自定义模块化能力 ## 2. 自定义模块化能力