fix link path (#317)
This commit is contained in:
Jianbo Sun
GitHub
parent
db8b163fed
commit
88300543b2
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
title: Kubectl plugin
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
Install vela kubectl plugin can help you to ship applications more easily!
|
||||
|
||||
## Installation
|
||||
|
||||
See [advanced-install](../../platform-engineers/advanced-install)
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
$ kubectl vela -h
|
||||
A Highly Extensible Platform Engine based on Kubernetes and Open Application Model.
|
||||
|
||||
Usage:
|
||||
kubectl vela [flags]
|
||||
kubectl vela [command]
|
||||
|
||||
Available Commands:
|
||||
|
||||
comp Show components in capability registry
|
||||
dry-run Dry Run an application, and output the K8s resources as
|
||||
result to stdout, only CUE template supported for now
|
||||
live-diff Dry-run an application, and do diff on a specific app
|
||||
revison. The provided capability definitions will be used
|
||||
during Dry-run. If any capabilities used in the app are not
|
||||
found in the provided ones, it will try to find from
|
||||
cluster.
|
||||
show Show the reference doc for a workload type or trait
|
||||
trait Show traits in capability registry
|
||||
version Prints out build version information
|
||||
|
||||
Flags:
|
||||
-h, --help help for vela
|
||||
|
||||
Use "kubectl vela [command] --help" for more information about a command.
|
||||
```
|
||||
|
|
@ -4,7 +4,7 @@ title: Needs More？
|
|||
|
||||
## 1. Get from capability registry
|
||||
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)。
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../kubectlplugin)。
|
||||
|
||||
### List
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Needs More?
|
|||
|
||||
## 1. Get from capability registry
|
||||
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)。
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../kubectlplugin)。
|
||||
|
||||
### List
|
||||
|
||||
|
|
|
|||
|
|
@ -81,6 +81,6 @@ Welcome onboard and sail Vela!
|
|||
Here are some recommended next steps:
|
||||
|
||||
- Start to [install KubeVela](./install).
|
||||
- Learn KubeVela's [core concepts](core-concepts/application).
|
||||
- Learn KubeVela's [architecture](core-concepts/architecture).
|
||||
- Learn KubeVela's [core concepts](./core-concepts/application).
|
||||
- Learn KubeVela's [architecture](./core-concepts/architecture).
|
||||
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ Kubectl will discover it from your system path automatically.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
For more usage please reference [kubectl plugin](../developers/references/kubectl-plugin).
|
||||
For more usage please reference [kubectl plugin](../kubectlplugin).
|
||||
## Upgrade
|
||||
|
||||
### Step 1. Update Helm repo
|
||||
|
|
|
|||
|
|
@ -115,5 +115,4 @@ $ vela show alibaba-eip
|
|||
```
|
||||
|
||||
If the tables display, the ComponentDefinition should work. To take a step further, you can verify it by provision an actual EIP instance per
|
||||
the doc [Provision cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services#provision-cloud-resources
|
||||
).
|
||||
the doc [Provision cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services#provision-cloud-resources).
|
||||
|
|
|
|||
|
|
@ -1,112 +0,0 @@
|
|||
---
|
||||
title: 功能参考文档
|
||||
---
|
||||
|
||||
在这篇文档中，我们将展示如何查看给定能力的详细文档 (比如 component 或者 trait)。
|
||||
|
||||
这听起来很有挑战，因为每种能力都是 KubeVela 的一个插件(内置能力也是如此)。同时，根据设计， KubeVela 允许平台管理员随时修改功能模板。在这种情况下，我们是否需要为每个新安装的功能手动写文档？ 以及我们如何确保系统的那些文档是最新的？
|
||||
|
||||
## 使用浏览器
|
||||
|
||||
实际上，作为其可扩展设计的重要组成部分， KubeVela 总是会根据模板的定义对每种 workload 类型或者 Kubernetes 集群注册的 trait 自动生成参考文档。此功能适用于任何功能：内置功能或者你自己的 workload 类型/ traits 。
|
||||
因此，作为一个终端用户，你唯一需要做的事情是：
|
||||
|
||||
```console
|
||||
$ vela show COMPONENT_TYPE or TRAIT --web
|
||||
```
|
||||
|
||||
这条命令会自动在你的默认浏览器中打开对应的 component 类型或者 traint 参考文档。
|
||||
|
||||
以 `$ vela show webservice --web` 为例。 `Web Service` component 类型的详细的文档将立即显示如下：
|
||||
|
||||
|
||||
|
||||
注意， 在名为 `Specification` 的部分中，它甚至为你提供了一种使用假名称 `my-service-name` 的这种 workload 类型。
|
||||
|
||||
同样的， 我们可以执行 `$ vela show autoscale`：
|
||||
|
||||
|
||||
|
||||
使用这些自动生成的参考文档，我们可以通过简单的复制粘贴轻松地完成应用程序描述，例如：
|
||||
|
||||
```yaml
|
||||
name: helloworld
|
||||
|
||||
services:
|
||||
backend: # 复制粘贴上面的 webservice 参考文档
|
||||
image: oamdev/testapp:v1
|
||||
cmd: ["node", "server.js"]
|
||||
port: 8080
|
||||
cpu: "0.1"
|
||||
|
||||
autoscale: # 复制粘贴并修改上面的 autoscaler 参考文档
|
||||
min: 1
|
||||
max: 8
|
||||
cron:
|
||||
startAt: "19:00"
|
||||
duration: "2h"
|
||||
days: "Friday"
|
||||
replicas: 4
|
||||
timezone: "America/Los_Angeles"
|
||||
```
|
||||
|
||||
## 使用命令行终端
|
||||
|
||||
此参考文档功能也适用于仅有命令行终端的情况，例如：
|
||||
|
||||
```shell
|
||||
$ vela show webservice
|
||||
# Properties
|
||||
+-------+----------------------------------------------------------------------------------+---------------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+-------+----------------------------------------------------------------------------------+---------------+----------+---------+
|
||||
| cmd | Commands to run in the container | []string | false | |
|
||||
| env | Define arguments by using environment variables | [[]env](#env) | false | |
|
||||
| image | Which image would you like to use for your service | string | true | |
|
||||
| port | Which port do you want customer traffic sent to | int | true | 80 |
|
||||
| cpu | Number of CPU units for the service, like `0.5` (0.5 CPU core), `1` (1 CPU core) | string | false | |
|
||||
+-------+----------------------------------------------------------------------------------+---------------+----------+---------+
|
||||
|
||||
|
||||
## env
|
||||
+-----------+-----------------------------------------------------------+-------------------------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+-----------+-----------------------------------------------------------+-------------------------+----------+---------+
|
||||
| name | Environment variable name | string | true | |
|
||||
| value | The value of the environment variable | string | false | |
|
||||
| valueFrom | Specifies a source the value of this var should come from | [valueFrom](#valueFrom) | false | |
|
||||
+-----------+-----------------------------------------------------------+-------------------------+----------+---------+
|
||||
|
||||
|
||||
### valueFrom
|
||||
+--------------+--------------------------------------------------+-------------------------------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+--------------+--------------------------------------------------+-------------------------------+----------+---------+
|
||||
| secretKeyRef | Selects a key of a secret in the pod's namespace | [secretKeyRef](#secretKeyRef) | true | |
|
||||
+--------------+--------------------------------------------------+-------------------------------+----------+---------+
|
||||
|
||||
|
||||
#### secretKeyRef
|
||||
+------+------------------------------------------------------------------+--------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+------+------------------------------------------------------------------+--------+----------+---------+
|
||||
| name | The name of the secret in the pod's namespace to select from | string | true | |
|
||||
| key | The key of the secret to select from. Must be a valid secret key | string | true | |
|
||||
+------+------------------------------------------------------------------+--------+----------+---------+
|
||||
```
|
||||
|
||||
## 内置功能
|
||||
|
||||
注意，对于所有的内置功能，我们已经将它们的参考文档发布在下面，这些文档遵循同样的文档生成机制。
|
||||
|
||||
|
||||
- Workload Types
|
||||
- [webservice](component-types/webservice)
|
||||
- [task](component-types/task)
|
||||
- [worker](component-types/worker)
|
||||
- Traits
|
||||
- [route](traits/route)
|
||||
- [autoscale](traits/autoscale)
|
||||
- [rollout](traits/rollout)
|
||||
- [metrics](traits/metrics)
|
||||
- [scaler](traits/scaler)
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
title: Task
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
描述运行完成代码或脚本的作业。
|
||||
|
||||
## 规范
|
||||
|
||||
列出 `Task` 类型 workload 的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
type: task
|
||||
image: perl
|
||||
count: 10
|
||||
cmd: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
cmd | 容器中运行的命令 | []string | false |
|
||||
count | 指定并行运行的 task 数量 | int | true | 1
|
||||
restart | 定义作业重启策略，值只能为 Never 或 OnFailure。 | string | true | Never
|
||||
image | 你的服务使用的镜像 | string | true |
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
---
|
||||
title: Webservice
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
描述长期运行的，可伸缩的，容器化的服务，这些服务具有稳定的网络接口，可以接收来自客户的外部网络流量。 如果对于 Appfile 中定义的任何服务，workload type 都被跳过，则默认使用“ webservice”类型。
|
||||
|
||||
## 规范
|
||||
|
||||
列出 `Webservice` workload 类型的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
type: webservice # could be skipped
|
||||
image: oamdev/testapp:v1
|
||||
cmd: ["node", "server.js"]
|
||||
port: 8080
|
||||
cpu: "0.1"
|
||||
env:
|
||||
- name: FOO
|
||||
value: bar
|
||||
- name: FOO
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: bar
|
||||
key: bar
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
cmd | 容器中运行的命令 | []string | false |
|
||||
env | 使用环境变量定义参数 | [[]env](#env) | false |
|
||||
image | 你的服务所使用到的镜像 | string | true |
|
||||
port | 你要将用户流浪发送到哪个端口 | int | true | 80
|
||||
cpu | 用于服务的CPU单元数，例如0.5（0.5 CPU内核），1（1 CPU内核） | string | false |
|
||||
|
||||
|
||||
### env
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
name | 环境变量名 | string | true |
|
||||
value | 环境变量值 | string | false |
|
||||
valueFrom | 指定此变量值的源 | [valueFrom](#valueFrom) | false |
|
||||
|
||||
|
||||
#### valueFrom
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
secretKeyRef | 选择一个 pod 命名空间中的 secret 键 | [secretKeyRef](#secretKeyRef) | true |
|
||||
|
||||
|
||||
##### secretKeyRef
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
name | 要从 pod 的命名空间中选择的 secret 的名字 | string | true |
|
||||
key | 选择的 secret 键。 必须是有效的 secret 键 | string | true |
|
||||
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
title: Worker
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
描述在后台长期运行，可拓展的容器化服务。它们不需要网络端点来接收外部流量。
|
||||
|
||||
## 规格
|
||||
|
||||
列出 `Worker` 类型 workload 的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
type: worker
|
||||
image: oamdev/testapp:v1
|
||||
cmd: ["node", "server.js"]
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
cmd | 容器中运行的命令 | []string | false |
|
||||
image | 你的服务使用的镜像 | string | true |
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
title: Ingress
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Configures K8s ingress and service to enable web traffic for your service. Please use route trait in cap center for advanced usage.
|
||||
|
||||
## Specification
|
||||
|
||||
List of all configuration options for a `Ingress` trait.
|
||||
|
||||
```yaml```
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Description | Type | Required | Default
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
domain | | string | true |
|
||||
http | | map[string]int | true |
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
title: Scaler
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
配置你服务的副本数。
|
||||
|
||||
## 规范
|
||||
|
||||
列出 `Scaler` trait 的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
...
|
||||
scaler:
|
||||
replicas: 100
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
replicas | Workload 的副本数 | int | true | 1
|
||||
|
|
@ -6,7 +6,7 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
|
|||
|
||||
## 1. 从官方或第三方能力中心获取模块化能力
|
||||
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)获取官方能力中心中发布的能力。
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
|
||||
|
||||
### 查看能力中心的模块列表
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
|
|||
|
||||
## 1. 从官方或第三方能力中心获取模块化能力
|
||||
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)获取官方能力中心中发布的能力。
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
|
||||
|
||||
### 查看能力中心的模块列表
|
||||
|
||||
|
|
|
|||
|
|
@ -84,4 +84,4 @@ KubeVela 是一个基于云原生技术栈构建的现代应用交付系统。
|
|||
|
||||
接下来，我们推荐你：
|
||||
- 开始[安装使用 KubeVela](./install)
|
||||
- 了解[系统架构](core-concepts/architecture)和[核心概念](core-concepts/application)
|
||||
- 了解[系统架构](./core-concepts/architecture)和[核心概念](./core-concepts/application)
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: 自定义组件入门
|
||||
---
|
||||
|
||||
> 在阅读本部分之前，请确保你已经了解 KubeVela 中 [组件定义（ComponentDefinition](../oam/x-definition.md##组件定义（ComponentDefinition）) 的概念且学习掌握了 [CUE 的基本知识](../cue/basic)
|
||||
> 在阅读本部分之前，请确保你已经了解 KubeVela 中 [组件定义（ComponentDefinition](../oam/x-definition#组件定义（ComponentDefinition）) 的概念且学习掌握了 [CUE 的基本知识](../cue/basic)
|
||||
|
||||
本节将以组件定义的例子展开说明，介绍如何使用 [CUE](https://cuelang.org/) 通过组件定义 `ComponentDefinition` 来自定义应用部署计划的组件。
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ title: 自定义运维特征
|
|||
|
||||
### 开始之前
|
||||
|
||||
请先阅读和理解 [运维特征定义](../oam/x-definition.md#运维特征定义（traitdefinition）)
|
||||
请先阅读和理解 [运维特征定义](../oam/x-definition#运维特征定义（TraitDefinition）)
|
||||
|
||||
### 如何使用
|
||||
|
||||
|
|
|
|||
|
|
@ -1,112 +0,0 @@
|
|||
---
|
||||
title: 功能参考文档
|
||||
---
|
||||
|
||||
在这篇文档中，我们将展示如何查看给定能力的详细文档 (比如 component 或者 trait)。
|
||||
|
||||
这听起来很有挑战，因为每种能力都是 KubeVela 的一个插件(内置能力也是如此)。同时，根据设计， KubeVela 允许平台管理员随时修改功能模板。在这种情况下，我们是否需要为每个新安装的功能手动写文档？ 以及我们如何确保系统的那些文档是最新的？
|
||||
|
||||
## 使用浏览器
|
||||
|
||||
实际上，作为其可扩展设计的重要组成部分， KubeVela 总是会根据模板的定义对每种 workload 类型或者 Kubernetes 集群注册的 trait 自动生成参考文档。此功能适用于任何功能：内置功能或者你自己的 workload 类型/ traits 。
|
||||
因此，作为一个终端用户，你唯一需要做的事情是：
|
||||
|
||||
```console
|
||||
$ vela show COMPONENT_TYPE or TRAIT --web
|
||||
```
|
||||
|
||||
这条命令会自动在你的默认浏览器中打开对应的 component 类型或者 traint 参考文档。
|
||||
|
||||
以 `$ vela show webservice --web` 为例。 `Web Service` component 类型的详细的文档将立即显示如下：
|
||||
|
||||
|
||||
|
||||
注意， 在名为 `Specification` 的部分中，它甚至为你提供了一种使用假名称 `my-service-name` 的这种 workload 类型。
|
||||
|
||||
同样的， 我们可以执行 `$ vela show autoscale`：
|
||||
|
||||
|
||||
|
||||
使用这些自动生成的参考文档，我们可以通过简单的复制粘贴轻松地完成应用程序描述，例如：
|
||||
|
||||
```yaml
|
||||
name: helloworld
|
||||
|
||||
services:
|
||||
backend: # 复制粘贴上面的 webservice 参考文档
|
||||
image: oamdev/testapp:v1
|
||||
cmd: ["node", "server.js"]
|
||||
port: 8080
|
||||
cpu: "0.1"
|
||||
|
||||
autoscale: # 复制粘贴并修改上面的 autoscaler 参考文档
|
||||
min: 1
|
||||
max: 8
|
||||
cron:
|
||||
startAt: "19:00"
|
||||
duration: "2h"
|
||||
days: "Friday"
|
||||
replicas: 4
|
||||
timezone: "America/Los_Angeles"
|
||||
```
|
||||
|
||||
## 使用命令行终端
|
||||
|
||||
此参考文档功能也适用于仅有命令行终端的情况，例如：
|
||||
|
||||
```shell
|
||||
$ vela show webservice
|
||||
# Properties
|
||||
+-------+----------------------------------------------------------------------------------+---------------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+-------+----------------------------------------------------------------------------------+---------------+----------+---------+
|
||||
| cmd | Commands to run in the container | []string | false | |
|
||||
| env | Define arguments by using environment variables | [[]env](#env) | false | |
|
||||
| image | Which image would you like to use for your service | string | true | |
|
||||
| port | Which port do you want customer traffic sent to | int | true | 80 |
|
||||
| cpu | Number of CPU units for the service, like `0.5` (0.5 CPU core), `1` (1 CPU core) | string | false | |
|
||||
+-------+----------------------------------------------------------------------------------+---------------+----------+---------+
|
||||
|
||||
|
||||
## env
|
||||
+-----------+-----------------------------------------------------------+-------------------------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+-----------+-----------------------------------------------------------+-------------------------+----------+---------+
|
||||
| name | Environment variable name | string | true | |
|
||||
| value | The value of the environment variable | string | false | |
|
||||
| valueFrom | Specifies a source the value of this var should come from | [valueFrom](#valueFrom) | false | |
|
||||
+-----------+-----------------------------------------------------------+-------------------------+----------+---------+
|
||||
|
||||
|
||||
### valueFrom
|
||||
+--------------+--------------------------------------------------+-------------------------------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+--------------+--------------------------------------------------+-------------------------------+----------+---------+
|
||||
| secretKeyRef | Selects a key of a secret in the pod's namespace | [secretKeyRef](#secretKeyRef) | true | |
|
||||
+--------------+--------------------------------------------------+-------------------------------+----------+---------+
|
||||
|
||||
|
||||
#### secretKeyRef
|
||||
+------+------------------------------------------------------------------+--------+----------+---------+
|
||||
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
|
||||
+------+------------------------------------------------------------------+--------+----------+---------+
|
||||
| name | The name of the secret in the pod's namespace to select from | string | true | |
|
||||
| key | The key of the secret to select from. Must be a valid secret key | string | true | |
|
||||
+------+------------------------------------------------------------------+--------+----------+---------+
|
||||
```
|
||||
|
||||
## 内置功能
|
||||
|
||||
注意，对于所有的内置功能，我们已经将它们的参考文档发布在下面，这些文档遵循同样的文档生成机制。
|
||||
|
||||
|
||||
- Workload Types
|
||||
- [webservice](component-types/webservice)
|
||||
- [task](component-types/task)
|
||||
- [worker](component-types/worker)
|
||||
- Traits
|
||||
- [route](traits/route)
|
||||
- [autoscale](traits/autoscale)
|
||||
- [rollout](traits/rollout)
|
||||
- [metrics](traits/metrics)
|
||||
- [scaler](traits/scaler)
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
title: Task
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
描述运行完成代码或脚本的作业。
|
||||
|
||||
## 规范
|
||||
|
||||
列出 `Task` 类型 workload 的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
type: task
|
||||
image: perl
|
||||
count: 10
|
||||
cmd: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
cmd | 容器中运行的命令 | []string | false |
|
||||
count | 指定并行运行的 task 数量 | int | true | 1
|
||||
restart | 定义作业重启策略，值只能为 Never 或 OnFailure。 | string | true | Never
|
||||
image | 你的服务使用的镜像 | string | true |
|
||||
|
|
@ -1,66 +0,0 @@
|
|||
---
|
||||
title: Webservice
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
描述长期运行的，可伸缩的，容器化的服务，这些服务具有稳定的网络接口，可以接收来自客户的外部网络流量。 如果对于 Appfile 中定义的任何服务，workload type 都被跳过，则默认使用“ webservice”类型。
|
||||
|
||||
## 规范
|
||||
|
||||
列出 `Webservice` workload 类型的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
type: webservice # could be skipped
|
||||
image: oamdev/testapp:v1
|
||||
cmd: ["node", "server.js"]
|
||||
port: 8080
|
||||
cpu: "0.1"
|
||||
env:
|
||||
- name: FOO
|
||||
value: bar
|
||||
- name: FOO
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: bar
|
||||
key: bar
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
cmd | 容器中运行的命令 | []string | false |
|
||||
env | 使用环境变量定义参数 | [[]env](#env) | false |
|
||||
image | 你的服务所使用到的镜像 | string | true |
|
||||
port | 你要将用户流浪发送到哪个端口 | int | true | 80
|
||||
cpu | 用于服务的CPU单元数，例如0.5（0.5 CPU内核），1（1 CPU内核） | string | false |
|
||||
|
||||
|
||||
### env
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
name | 环境变量名 | string | true |
|
||||
value | 环境变量值 | string | false |
|
||||
valueFrom | 指定此变量值的源 | [valueFrom](#valueFrom) | false |
|
||||
|
||||
|
||||
#### valueFrom
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
secretKeyRef | 选择一个 pod 命名空间中的 secret 键 | [secretKeyRef](#secretKeyRef) | true |
|
||||
|
||||
|
||||
##### secretKeyRef
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
name | 要从 pod 的命名空间中选择的 secret 的名字 | string | true |
|
||||
key | 选择的 secret 键。 必须是有效的 secret 键 | string | true |
|
||||
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
---
|
||||
title: Worker
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
描述在后台长期运行，可拓展的容器化服务。它们不需要网络端点来接收外部流量。
|
||||
|
||||
## 规格
|
||||
|
||||
列出 `Worker` 类型 workload 的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
type: worker
|
||||
image: oamdev/testapp:v1
|
||||
cmd: ["node", "server.js"]
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
cmd | 容器中运行的命令 | []string | false |
|
||||
image | 你的服务使用的镜像 | string | true |
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
title: Ingress
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Configures K8s ingress and service to enable web traffic for your service. Please use route trait in cap center for advanced usage.
|
||||
|
||||
## Specification
|
||||
|
||||
List of all configuration options for a `Ingress` trait.
|
||||
|
||||
```yaml```
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Description | Type | Required | Default
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
domain | | string | true |
|
||||
http | | map[string]int | true |
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
---
|
||||
title: Scaler
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
配置你服务的副本数。
|
||||
|
||||
## 规范
|
||||
|
||||
列出 `Scaler` trait 的所有配置项。
|
||||
|
||||
```yaml
|
||||
name: my-app-name
|
||||
|
||||
services:
|
||||
my-service-name:
|
||||
...
|
||||
scaler:
|
||||
replicas: 100
|
||||
```
|
||||
|
||||
## 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
replicas | Workload 的副本数 | int | true | 1
|
||||
|
|
@ -6,7 +6,7 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
|
|||
|
||||
## 1. 从官方或第三方能力中心获取模块化能力
|
||||
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)获取官方能力中心中发布的能力。
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
|
||||
|
||||
### 查看能力中心的模块列表
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ KubeVela 中的模块完全都是可定制和可插拔的，所以除了内置
|
|||
|
||||
## 1. 从官方或第三方能力中心获取模块化能力
|
||||
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)获取官方能力中心中发布的能力。
|
||||
可以通过 KubeVela 的 [Kubectl 插件](../../kubectlplugin)获取官方能力中心中发布的能力。
|
||||
|
||||
### 查看能力中心的模块列表
|
||||
|
||||
|
|
|
|||
|
|
@ -84,4 +84,4 @@ KubeVela 是一个基于云原生技术栈构建的现代应用交付系统。
|
|||
|
||||
接下来，我们推荐你：
|
||||
- 开始[安装使用 KubeVela](./install)
|
||||
- 了解[系统架构](core-concepts/architecture)和[核心概念](core-concepts/application)
|
||||
- 了解[系统架构](./core-concepts/architecture)和[核心概念](./core-concepts/application)
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
title: 自定义组件入门
|
||||
---
|
||||
|
||||
> 在阅读本部分之前，请确保你已经了解 KubeVela 中 [组件定义（ComponentDefinition](../oam/x-definition.md##组件定义（ComponentDefinition）) 的概念且学习掌握了 [CUE 的基本知识](../cue/basic)
|
||||
> 在阅读本部分之前，请确保你已经了解 KubeVela 中 [组件定义（ComponentDefinition](../oam/x-definition#组件定义（ComponentDefinition）) 的概念且学习掌握了 [CUE 的基本知识](../cue/basic)
|
||||
|
||||
本节将以组件定义的例子展开说明，介绍如何使用 [CUE](https://cuelang.org/) 通过组件定义 `ComponentDefinition` 来自定义应用部署计划的组件。
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ title: 自定义运维特征
|
|||
|
||||
### 开始之前
|
||||
|
||||
请先阅读和理解 [运维特征定义](../oam/x-definition.md#运维特征定义（traitdefinition）)
|
||||
请先阅读和理解 [运维特征定义](../oam/x-definition#运维特征定义（TraitDefinition）)
|
||||
|
||||
### 如何使用
|
||||
|
||||
|
|
|
|||
|
|
@ -181,7 +181,6 @@ module.exports = {
|
|||
'cli/vela_cap',
|
||||
],
|
||||
},
|
||||
'developers/references/kubectl-plugin'
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
title: Kubectl plugin
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
Install vela kubectl plugin can help you to ship applications more easily!
|
||||
|
||||
## Installation
|
||||
|
||||
See [advanced-install](../../platform-engineers/advanced-install)
|
||||
|
||||
## Usage
|
||||
|
||||
```shell
|
||||
$ kubectl vela -h
|
||||
A Highly Extensible Platform Engine based on Kubernetes and Open Application Model.
|
||||
|
||||
Usage:
|
||||
kubectl vela [flags]
|
||||
kubectl vela [command]
|
||||
|
||||
Available Commands:
|
||||
|
||||
comp Show components in capability registry
|
||||
dry-run Dry Run an application, and output the K8s resources as
|
||||
result to stdout, only CUE template supported for now
|
||||
live-diff Dry-run an application, and do diff on a specific app
|
||||
revison. The provided capability definitions will be used
|
||||
during Dry-run. If any capabilities used in the app are not
|
||||
found in the provided ones, it will try to find from
|
||||
cluster.
|
||||
show Show the reference doc for a workload type or trait
|
||||
trait Show traits in capability registry
|
||||
version Prints out build version information
|
||||
|
||||
Flags:
|
||||
-h, --help help for vela
|
||||
|
||||
Use "kubectl vela [command] --help" for more information about a command.
|
||||
```
|
||||
|
|
@ -4,7 +4,7 @@ title: Needs More？
|
|||
|
||||
## 1. Get from capability registry
|
||||
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)。
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../kubectlplugin)。
|
||||
|
||||
### List
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Needs More?
|
|||
|
||||
## 1. Get from capability registry
|
||||
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../developers/references/kubectl-plugin#install-kubectl-vela-plugin)。
|
||||
You can get more from official capability registry by using KubeVela [plugin](../../kubectlplugin)。
|
||||
|
||||
### List
|
||||
|
||||
|
|
|
|||
|
|
@ -81,6 +81,6 @@ Welcome onboard and sail Vela!
|
|||
Here are some recommended next steps:
|
||||
|
||||
- Start to [install KubeVela](./install).
|
||||
- Learn KubeVela's [core concepts](core-concepts/application).
|
||||
- Learn KubeVela's [architecture](core-concepts/architecture).
|
||||
- Learn KubeVela's [core concepts](./core-concepts/application).
|
||||
- Learn KubeVela's [architecture](./core-concepts/architecture).
|
||||
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ Kubectl will discover it from your system path automatically.
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
For more usage please reference [kubectl plugin](../developers/references/kubectl-plugin).
|
||||
For more usage please reference [kubectl plugin](../kubectlplugin).
|
||||
## Upgrade
|
||||
|
||||
### Step 1. Update Helm repo
|
||||
|
|
|
|||
|
|
@ -115,5 +115,4 @@ $ vela show alibaba-eip
|
|||
```
|
||||
|
||||
If the tables display, the ComponentDefinition should work. To take a step further, you can verify it by provision an actual EIP instance per
|
||||
the doc [Provision cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services#provision-cloud-resources
|
||||
).
|
||||
the doc [Provision cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services#provision-cloud-resources).
|
||||
|
|
|
|||
|
|
@ -428,10 +428,6 @@
|
|||
"id": "version-v1.1/cli/vela_cap"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.1/developers/references/kubectl-plugin"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -451,4 +447,4 @@
|
|||
"id": "version-v1.1/developers/references/devex/faq"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue