Docs: provide install options for helm user (#507)

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG 2022-02-15 15:36:16 +08:00 committed by GitHub
parent 1847109721
commit 0abcb550fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 112 additions and 8 deletions

View File

@ -232,6 +232,15 @@ sudo mv ./vela /usr/local/bin/vela
## 2. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
> The version of vela CLI >= 1.2.3.
```shell script
@ -267,6 +276,23 @@ If you want to enable dashboard, please run "vela addon enable velaux"
</details>
</TabItem>
<TabItem value="helm">
If you are helm user, you can also use helm to install kubevela core:
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.3 --wait
```
</TabItem>
</Tabs>
## 4. Install VelaUX
VelaUX is a dashboard including UI+API services, it enables you to do everything around application delivery and management.

View File

@ -51,7 +51,7 @@ The spec are as follows:
required: bool
max: int
min: int
regular: string
pattern: string
options: Optional, for select forms
- label: string
value: string

View File

@ -228,7 +228,16 @@ sudo mv ./vela /usr/local/bin/vela
## 3. 安装 KubeVela Core
> vela CLI 版本需要 >=1.2.3
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
> Vela CLI 版本需要 >=1.2.3
```shell script
vela install
@ -262,6 +271,23 @@ If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
如果你是 Helm 用户,你同样可以使用 Helm 安装 KubeVela Core:
> helm 版本 >= 3.2.0
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.3 --wait
```
</TabItem>
</Tabs>
## 4. 安装 VelaUX

View File

@ -51,7 +51,7 @@ UI Schema 包含的字段如下:
required: bool 是否必填
max: int 最大值
min: int 最小值
regular: string 正则校验规则
pattern: string 正则校验规则
options: 可选项,适用于选择性表单
- label: string 可选项显示名称
value: string 可选项值

View File

@ -228,7 +228,16 @@ sudo mv ./vela /usr/local/bin/vela
## 3. 安装 KubeVela Core
> vela CLI 版本需要 >=1.2.3
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
> Vela CLI 版本需要 >=1.2.3
```shell script
vela install
@ -262,6 +271,23 @@ If you want to enable dashboard, please run "vela addon enable velaux"
```
</details>
</TabItem>
<TabItem value="helm">
如果你是 Helm 用户,你同样可以使用 Helm 安装 KubeVela Core:
> helm 版本 >= 3.2.0
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.3 --wait
```
</TabItem>
</Tabs>
## 4. 安装 VelaUX

View File

@ -121,7 +121,7 @@ spec:
```cue
output: {
type: "k8s-obeject"
type: "raw"
properties: {
apiVersion: "v1"
kind: "ConfigMap"
@ -144,7 +144,7 @@ parameter: {
你如果了解 [模版定义](../oam/x-definition) 中 CUE 模版的写法的话,应该会对这种写法感到非常熟悉,它们之间的区别是模版定义的 `output` 是一个具体的 K8S 对象,而这里的 `output` 定义的其实是一个应用中的具体组件。
可以看到上面例子中的 `output` 中描述了一个 `k8s-object` 类型的组件,其中 `properties.data.input` 需要在启用时根据输入参数指定。插件在启用时的参数都需要以 CUE 的语法编写在 `parameter.cue` 文件当中。 UX/CLI 在启用插件时会把全部的 CUE 文件和 `parameter.cue` 放在一个上下文中进行渲染,最终得到一系列的组件并添加到应用当中。
可以看到上面例子中的 `output` 中描述了一个 `raw` 类型的组件,其中 `properties.data.input` 需要在启用时根据输入参数指定。插件在启用时的参数都需要以 CUE 的语法编写在 `parameter.cue` 文件当中。 UX/CLI 在启用插件时会把全部的 CUE 文件和 `parameter.cue` 放在一个上下文中进行渲染,最终得到一系列的组件并添加到应用当中。
你也可以通过 [CUE 基础入门文档](../cue/basic) 了解 CUE 的具体语法。

View File

@ -51,7 +51,7 @@ UI Schema 包含的字段如下:
required: bool 是否必填
max: int 最大值
min: int 最小值
regular: string 正则校验规则
pattern: string 正则校验规则
options: 可选项,适用于选择性表单
- label: string 可选项显示名称
value: string 可选项值

View File

@ -232,6 +232,15 @@ sudo mv ./vela /usr/local/bin/vela
## 2. Install KubeVela Core
<Tabs
className="unique-tabs"
defaultValue="vela"
values={[
{label: 'Default', value: 'vela'},
{label: 'Helm', value: 'helm'},
]}>
<TabItem value="vela">
> The version of vela CLI >= 1.2.3.
```shell script
@ -267,6 +276,23 @@ If you want to enable dashboard, please run "vela addon enable velaux"
</details>
</TabItem>
<TabItem value="helm">
If you are helm user, you can also use helm to install kubevela core:
> helm v3.2.0+ required
```
helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.3 --wait
```
</TabItem>
</Tabs>
## 4. Install VelaUX
VelaUX is a dashboard including UI+API services, it enables you to do everything around application delivery and management.

View File

@ -51,7 +51,7 @@ The spec are as follows:
required: bool
max: int
min: int
regular: string
pattern: string
options: Optional, for select forms
- label: string
value: string