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
GitHub
parent
c7239059ad
commit
7109154b09
|
|
@ -8,35 +8,28 @@ KubeVela is able to discover OAM definition files in this repo automatically and
|
|||
|
||||
## Add a capability center
|
||||
|
||||
Add and sync a capability center in KubeVela:
|
||||
Add a registry in KubeVela:
|
||||
|
||||
```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
|
||||
successfully sync 1/1 from my-center remote 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
|
||||
Successfully configured registry my-center
|
||||
```
|
||||
|
||||
Now, this capability center `my-center` is ready to use.
|
||||
Now, this registry `my-center` is ready to use.
|
||||
|
||||
## List capability centers
|
||||
|
||||
You are allowed to add more capability centers and list them.
|
||||
|
||||
```bash
|
||||
vela cap center ls
|
||||
vela registry ls
|
||||
```
|
||||
```console
|
||||
NAME ADDRESS
|
||||
my-center https://github.com/oam-dev/catalog/tree/master/registry
|
||||
NAME URL
|
||||
default oss://registry.kubevela.net/
|
||||
my-center https://github.com/oam-dev/catalog/tree/master/registry
|
||||
```
|
||||
|
||||
## [Optional] Remove a capability center
|
||||
|
|
@ -44,20 +37,16 @@ my-center https://github.com/oam-dev/catalog/tree/master/registry
|
|||
Or, remove one.
|
||||
|
||||
```bash
|
||||
vela cap center remove my-center
|
||||
vela registry remove my-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
|
||||
vela cap ls my-center
|
||||
```
|
||||
```console
|
||||
NAME CENTER TYPE DEFINITION STATUS APPLIES-TO
|
||||
clonesetservice my-center componentDefinition clonesets.apps.kruise.io uninstalled []
|
||||
```
|
||||
vela trait --discover --registry=my-center
|
||||
vela comp --discover --registry=my-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`.
|
||||
|
||||
```bash
|
||||
vela cap install my-center/clonesetservice
|
||||
```
|
||||
```console
|
||||
Installing component capability clonesetservice
|
||||
Successfully installed capability clonesetservice from my-center
|
||||
vela comp get clonesetservice --registry=my-center
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
```bash
|
||||
vela cap uninstall my-center/clonesetservice
|
||||
```
|
||||
```console
|
||||
Successfully uninstalled capability clonesetservice
|
||||
```
|
||||
kubectl delete componentdefinition -n vela-system clonesetservice
|
||||
```
|
||||
|
|
@ -8,23 +8,27 @@ You can get more from official capability registry by using KubeVela [plugin](..
|
|||
|
||||
### 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
|
||||
$ kubectl vela comp --discover
|
||||
Showing components from registry: oss://registry.kubevela.net
|
||||
NAME REGISTRY DEFINITION
|
||||
webserver default deployments.apps
|
||||
$ vela comp --discover
|
||||
Listing component definition from registry: default
|
||||
NAME REGISTRY DEFINITION STATUS
|
||||
kustomize default autodetects.core.oam.dev installed
|
||||
webserver default deployments.apps uninstalled
|
||||
```
|
||||
|
||||
`--discover` means list components from registry
|
||||
|
||||
### Install
|
||||
|
||||
Then you can install a component like:
|
||||
|
||||
```shell
|
||||
$ kubectl vela comp get webserver
|
||||
Installing component capability webserver
|
||||
Successfully install component: webserver
|
||||
$ vela comp get webserver
|
||||
Getting component definition from registry: default
|
||||
Installing component: webserver
|
||||
Successfully install component: webserver
|
||||
```
|
||||
|
||||
## 2. Designed by yourself
|
||||
|
|
|
|||
|
|
@ -8,33 +8,38 @@ You can get more from official capability registry by using KubeVela [plugin](..
|
|||
|
||||
### 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
|
||||
$ kubectl vela trait --discover
|
||||
Showing traits from registry: https://registry.kubevela.net
|
||||
NAME REGISTRY DEFINITION APPLIES-TO
|
||||
service-account default [webservice worker]
|
||||
env default [webservice worker]
|
||||
flagger-rollout default canaries.flagger.app [webservice]
|
||||
init-container default [webservice worker]
|
||||
keda-scaler default scaledobjects.keda.sh [deployments.apps]
|
||||
metrics default metricstraits.standard.oam.dev [webservice backend task]
|
||||
node-affinity default [webservice worker]
|
||||
route default routes.standard.oam.dev [webservice]
|
||||
virtualgroup default [webservice worker]
|
||||
$ vela trait --discover
|
||||
Showing trait definition from registry: default
|
||||
NAME REGISTRY DEFINITION APPLIES-TO STATUS
|
||||
autoscale default autoscalers.standard.oam.dev [deployments.apps] uninstalled
|
||||
crd-manual-scaler default manualscalertraits.core.oam.dev [deployments.apps] uninstalled
|
||||
dynamic-sa default [deployments.apps] uninstalled
|
||||
env default [deployments.apps] installed
|
||||
expose default [] installed
|
||||
hpa default [deployments.apps] uninstalled
|
||||
init-container default [deployments.apps] installed
|
||||
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
|
||||
```
|
||||
|
||||
Note that the `--discover` flag means show all traits not in your cluster.
|
||||
`--discover` means list components from registry
|
||||
|
||||
### Install
|
||||
|
||||
Then you can install a trait like:
|
||||
|
||||
```shell
|
||||
$ kubectl vela trait get init-container
|
||||
Installing component capability init-container
|
||||
Successfully install trait: init-container
|
||||
$ vela trait get init-container
|
||||
Getting component definition from registry: default
|
||||
Installing component: init-container
|
||||
Successfully install trait: init-container
|
||||
```
|
||||
|
||||
## 2. Designed by yourself
|
||||
|
|
|
|||
|
|
@ -8,16 +8,11 @@ KubeVela 可以从这些仓库中自动发现 OAM 抽象文件，并且同步这
|
|||
|
||||
## 添加能力中心
|
||||
|
||||
新增且同步能力中心到 KubeVela：
|
||||
新增能力中心到 KubeVela：
|
||||
|
||||
```bash
|
||||
$ vela cap center config my-center https://github.com/oam-dev/catalog/tree/master/registry
|
||||
successfully sync 1/1 from my-center remote 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
|
||||
vela registry config my-center https://github.com/oam-dev/catalog/tree/master/registry
|
||||
Successfully configured registry my-center
|
||||
```
|
||||
|
||||
现在，该能力中心 `my-center` 已经可以使用。
|
||||
|
|
@ -27,9 +22,10 @@ sync finished
|
|||
你可以列出或者添加更多能力中心。
|
||||
|
||||
```bash
|
||||
$ vela cap center ls
|
||||
NAME ADDRESS
|
||||
my-center https://github.com/oam-dev/catalog/tree/master/registry
|
||||
vela registry ls
|
||||
NAME URL
|
||||
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
|
||||
$ vela cap center remove my-center
|
||||
vela registry remove my-center
|
||||
```
|
||||
|
||||
## 列出所有可用的能力中心
|
||||
|
||||
列出某个中心所有可用的能力。
|
||||
列出某个中心所有可用的 ComponentDefinition/TraitDefinition。
|
||||
|
||||
```bash
|
||||
$ vela cap ls my-center
|
||||
NAME CENTER TYPE DEFINITION STATUS APPLIES-TO
|
||||
clonesetservice my-center componentDefinition clonesets.apps.kruise.io uninstalled []
|
||||
vela trait --discover --registry=my-center
|
||||
vela comp --discover --registry=my-center
|
||||
```
|
||||
|
||||
## 从能力中心安装能力
|
||||
|
|
@ -63,9 +58,7 @@ helm install kruise https://github.com/openkruise/kruise/releases/download/v0.7.
|
|||
从 `my-center` 中安装 `clonesetservice` component 。
|
||||
|
||||
```bash
|
||||
$ vela cap install my-center/clonesetservice
|
||||
Installing component capability clonesetservice
|
||||
Successfully installed capability clonesetservice from my-center
|
||||
vela comp get clonesetservice --registry=my-center
|
||||
```
|
||||
|
||||
## 使用新安装的能力
|
||||
|
|
@ -128,6 +121,5 @@ testsvc 1 1 1 1 1 46s
|
|||
> 注意，删除能力前请先确认没有被应用引用。
|
||||
|
||||
```bash
|
||||
$ vela cap uninstall my-center/clonesetservice
|
||||
Successfully uninstalled capability clonesetservice
|
||||
kubectl delete componentdefinition -n vela-system clonesetservice
|
||||
```
|
||||
|
|
|
|||
|
|
@ -6,29 +6,32 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
|
|||
|
||||
## 1. 从官方或第三方能力中心获取模块化能力
|
||||
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
|
||||
|
||||
### 查看能力中心的模块列表
|
||||
|
||||
默认情况下，命令会从 KubeVela 官方维护的[能力中心](https://registry.kubevela.net)中获取模块化功能。
|
||||
|
||||
例如，让我们尝试列出注册表中所有可用的组件，使用 `--discover` 这个标志位：
|
||||
例如，让我们尝试列出能力中心中所有可用的组件，使用 `--discover` 这个标志位：
|
||||
|
||||
```shell
|
||||
$ kubectl vela comp --discover
|
||||
Showing components from registry: oss://registry.kubevela.net
|
||||
NAME REGISTRY DEFINITION
|
||||
webserver default deployments.apps
|
||||
$ vela comp --discover
|
||||
Listing component definition from registry: default
|
||||
NAME REGISTRY DEFINITION STATUS
|
||||
kustomize default autodetects.core.oam.dev installed
|
||||
webserver default deployments.apps uninstalled
|
||||
```
|
||||
|
||||
`--discover` 表明将从能力中心发现能力并列出
|
||||
|
||||
|
||||
### 从能力中心安装模块
|
||||
|
||||
然后你可以安装一个组件，如：
|
||||
|
||||
```shell
|
||||
$ kubectl vela comp get webserver
|
||||
Installing component capability webserver
|
||||
Successfully install component: webserver
|
||||
$ vela comp get webserver
|
||||
Getting component definition from registry: default
|
||||
Installing component: webserver
|
||||
Successfully install component: webserver
|
||||
```
|
||||
|
||||
## 2. 自定义模块化能力
|
||||
|
|
|
|||
|
|
@ -6,38 +6,43 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
|
|||
|
||||
## 1. 从官方或第三方能力中心获取模块化能力
|
||||
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
|
||||
|
||||
### 查看能力中心的模块列表
|
||||
|
||||
默认情况下，命令会从 KubeVela 官方维护的[能力中心](https://registry.kubevela.net)中获取模块化功能。
|
||||
|
||||
例如，让我们尝试列出注册表中所有可用的 trait：
|
||||
例如，让我们尝试列出能力中心中所有可用的 trait：
|
||||
|
||||
```shell
|
||||
$ kubectl vela trait --discover
|
||||
Showing traits from registry: https://registry.kubevela.net
|
||||
NAME REGISTRY DEFINITION APPLIES-TO
|
||||
service-account default [webservice worker]
|
||||
env default [webservice worker]
|
||||
flagger-rollout default canaries.flagger.app [webservice]
|
||||
init-container default [webservice worker]
|
||||
keda-scaler default scaledobjects.keda.sh [deployments.apps]
|
||||
metrics default metricstraits.standard.oam.dev [webservice backend task]
|
||||
node-affinity default [webservice worker]
|
||||
route default routes.standard.oam.dev [webservice]
|
||||
virtualgroup default [webservice worker]
|
||||
$ vela trait --discover
|
||||
Showing trait definition from registry: default
|
||||
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
|
||||
NAME REGISTRY DEFINITION APPLIES-TO STATUS
|
||||
autoscale default autoscalers.standard.oam.dev [deployments.apps] uninstalled
|
||||
crd-manual-scaler default manualscalertraits.core.oam.dev [deployments.apps] uninstalled
|
||||
dynamic-sa default [deployments.apps] uninstalled
|
||||
env default [deployments.apps] installed
|
||||
expose default [] installed
|
||||
hpa default [deployments.apps] uninstalled
|
||||
init-container default [deployments.apps] installed
|
||||
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，如：
|
||||
|
||||
```shell
|
||||
$ kubectl vela trait get init-container
|
||||
Installing component capability init-container
|
||||
Successfully install trait: init-container
|
||||
$ vela trait get init-container
|
||||
Getting component definition from registry: default
|
||||
Installing component: init-container
|
||||
Successfully install trait: init-container
|
||||
```
|
||||
|
||||
## 2. 自定义模块化能力
|
||||
|
|
|
|||
Loading…
Reference in New Issue