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

Update mode docs (#617) 

Signed-off-by: Jianbo Sun <jianbo.sjb@alibaba-inc.com>
This commit is contained in:
Jianbo Sun 2022-04-20 13:32:07 +08:00 committed by GitHub
parent 379c2215c7
commit ee0268d570
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
120 changed files with 1382 additions and 167 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/contributor/overview.md Normal file
View File

@ -0,0 +1,36 @@
---
title: Developer Guide
---
Welcome developers out there! Please check the [Community Membership](https://github.com/oam-dev/community/blob/main/community-membership.md) to start engaging with the community.
## Common Code Contribution Guide
* [Create a pull request](https://github.com/oam-dev/kubevela/blob/master/contribute/create-pull-request.md)
* [Developer guide](https://github.com/oam-dev/kubevela/blob/master/contribute/developer-guide.md)
* [Triage issues](https://github.com/oam-dev/kubevela/blob/master/contribute/triage-issues.md)
* [Code conventions](https://github.com/oam-dev/kubevela/blob/master/contribute/coding-conventions.md)
* [Release Process And Cadence](https://github.com/oam-dev/kubevela/blob/master/contribute/develop-code-flow.pdf)
## Contribute Addons
* [Build Your Own Addon](../platform-engineers/addon/intro)
* [Addon Repository](https://github.com/oam-dev/catalog)
## Contribute to the Docs & Website
* [kubevela.io Developer Guide](https://github.com/oam-dev/kubevela.io/blob/main/README.md)
## Contribute use cases and more samples
* [Credit the community](https://github.com/oam-dev/kubevela/issues/1662)
* [KubeVela Official Samples](https://github.com/oam-dev/samples)
* [Add a blog](https://kubevela.net/blog)
## Other Projects
* [VelaUX Developer Guide](https://github.com/oam-dev/velaux/blob/main/CONTRIBUTING.md)
* [Terraform Controller Developer Guide](https://github.com/oam-dev/terraform-controller/blob/master/CONTRIBUTING.md)
Enjoy coding and collaboration in OSS world!

2
docs/platform-engineers/addon/intro.md
View File

@ -1,5 +1,5 @@
--- ---
title: Customize Addon title: Build Your Own Addon
--- ---
The picture below shows what KubeVela does when an addon is enabled. You can see that the Addon Registry stores the addon's resource files. When an addon is enabled through UX/CLI, it will pull these resource files from the Addon Registry, render them and create a KubeVela application. Finally, the KubeVela controller running in the management cluster completes the delivery of the resources described in the application. The picture below shows what KubeVela does when an addon is enabled. You can see that the Addon Registry stores the addon's resource files. When an addon is enabled through UX/CLI, it will pull these resource files from the Addon Registry, render them and create a KubeVela application. Finally, the KubeVela controller running in the management cluster completes the delivery of the resources described in the application.

4
docs/reference/ui-schema.md
View File

@ -1,8 +1,8 @@
--- ---
title: UI-Schema title: VelaUX Extension
--- ---
KubeVela designs and implements the UI-Schema specification for the scalability of components, workflow steps, and operation and maintenance feature resources, in the case of variable input parameters, to achieve a more native UI experience. VelaUX uses the UI-Schema specification for the extension of components, workflow steps, and operation and maintenance feature resources, in the case of variable input parameters, to achieve a more native UI experience.
At present, the UI-Schema specification mainly acts on the data input side and will be extended to the data visualization side in the future. At present, the UI-Schema specification mainly acts on the data input side and will be extended to the data visualization side in the future.

BIN
docs/resources/vela-overview.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 395 KiB

After

Width:  |  Height:  |  Size: 408 KiB

2
docusaurus.config.js
View File

@ -125,7 +125,7 @@ module.exports = {
], ],
copyright: ` copyright: `
<br /> <br />
<strong>© KubeVela Authors ${new Date().getFullYear()} | Documentation Distributed under <a href="https://creativecommons.org/licenses/by/4.0">CC-BY-4.0</a> </strong> <strong>| Powered by <a href="https://www.netlify.com">Netlify</a></strong> <strong>© KubeVela Authors ${new Date().getFullYear()} | Documentation Distributed under <a href="https://creativecommons.org/licenses/by/4.0">CC-BY-4.0</a> </strong>
<br /> <br />
<br /> <br />
© ${new Date().getFullYear()} The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/"> Trademark Usage</a> page. <a href="https://beian.miit.gov.cn/" target="_blank">浙ICP备12022327号</a> © ${new Date().getFullYear()} The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/"> Trademark Usage</a> page. <a href="https://beian.miit.gov.cn/" target="_blank">浙ICP备12022327号</a>

43
i18n/zh/code.json
View File

@ -72,11 +72,11 @@
"description": "The ARIA label for copy code blocks button" "description": "The ARIA label for copy code blocks button"
}, },
"theme.CodeBlock.copied": { "theme.CodeBlock.copied": {
"message": "Copied", "message": "复制成功",
"description": "The copied button label on code blocks" "description": "The copied button label on code blocks"
}, },
"theme.CodeBlock.copy": { "theme.CodeBlock.copy": {
"message": "Copy", "message": "复制",
"description": "The copy button label on code blocks" "description": "The copy button label on code blocks"
}, },
"theme.docs.sidebar.expandButtonTitle": { "theme.docs.sidebar.expandButtonTitle": {
@ -203,11 +203,11 @@
"KubeVela introduces Open Application Model (OAM) as the consistent yet higher level API to capture and render a full deployment of microservices on top of hybrid environments. Placement strategy, traffic shifting and rolling update are declared at application level. No infrastructure level concern, simply deploy.": { "KubeVela introduces Open Application Model (OAM) as the consistent yet higher level API to capture and render a full deployment of microservices on top of hybrid environments. Placement strategy, traffic shifting and rolling update are declared at application level. No infrastructure level concern, simply deploy.": {
"message": "KubeVela 以开放应用模型（OAM）作为应用交付的顶层抽象，并通过声明式的交付工作流来捕获面向混合环境的微服务应用交付的整个过程，甚至连多集群分发策略、流量调配和滚动更新等运维特征，也都声明在应用级别。用户无需关心任何基础设施细节，只需要专注于定义和部署应用即可。" "message": "KubeVela 以开放应用模型（OAM）作为应用交付的顶层抽象，并通过声明式的交付工作流来捕获面向混合环境的微服务应用交付的整个过程，甚至连多集群分发策略、流量调配和滚动更新等运维特征，也都声明在应用级别。用户无需关心任何基础设施细节，只需要专注于定义和部署应用即可。"
}, },
"Programmable Workflow": { "Out of Box UI Console": {
"message": "可编程式交付工作流" "message": "开箱即用的可视化控制台"
}, },
"KubeVela models application delivery as DAG (Directed Acyclic Graph) and expresses it with CUE - a modern data configuration language. This allows you to design application deployment steps per needs and orchestrate them in programmable approach. No restrictions, natively extensible.": { "KubeVela has an UI Console along with other out-of-box capabilities from a large catalog of addons. It models application delivery as DAG (Directed Acyclic Graph) and expresses it with CUE - a modern data configuration language. This allows you to design application deployment steps per needs and orchestrate them in programmable approach. No restrictions, natively extensible.": {
"message": "KubeVela 会将应用交付流程建模为有向无环图（DAG），并将它通过 CUE（一种源自 Google Borg 系统的数据配置语言）来进行表达和实现。这使得你可以自由的根据自己的需求来设计交付工作流中的每一个步骤，并通过可编程的方式将它们编排起来。没有任何限制，原生高可扩展" "message": "包括可视化控制台在内，KubeVela 有大量开箱即用的插件可以选用。KubeVela 会将应用交付流程建模为有向无环图（DAG），并将它通过 CUE（一种源自 Google Borg 系统的数据配置语言）来进行表达和实现。这使得你可以自由的根据自己的需求来设计和选用交付工作流中的每一个步骤，并通过可编程的方式将它们编排起来。没有任何限制，原生高可扩展"
}, },
"Infrastructure Agnostic": { "Infrastructure Agnostic": {
"message": "基础设施无关" "message": "基础设施无关"
@ -221,23 +221,32 @@
"sandbox project": { "sandbox project": {
"message": "沙箱级项目" "message": "沙箱级项目"
}, },
"KubeVela is a modern application delivery platform that makes deploying and operating applications across today's hybrid, multi-cloud environments": { "KubeVela is a modern application delivery(CD) platform that makes deploying and operating applications across today's hybrid, multi-cloud environments": {
"message": "KubeVela 是一个现代化的应用交付平台，它可以让你的应用交付与管理在当今流行的混合、多云环境中变得更加" "message": "KubeVela 是一个现代化的应用交付（CD）平台，它可以让你的应用交付与管理在当今流行的混合、多云环境中变得更加"
}, },
" easier, faster and more reliable.": { " easier, faster and more reliable.": {
"message": "简单、轻松、可靠。" "message": "简单、轻松、可靠。"
}, },
"KubeVela is infrastructure agnostic, programmable, yet most importantly,": { "KubeVela is an infrastructure agnostic control plane, with an ": {
"message": "KubeVela 是基础设施无关的、可编程的，但最重要的是：" "message": "KubeVela 是一个基础设施无关的控制平面，它具备一个"
}, },
"application-centric,": { "application-centric ": {
"message": "它是完全以应用为中心的。" "message": "以应用为中心、"
},
"UI console, that has rich ": {
"message": ""
}, },
".": { ".": {
"message": "." "message": "."
}, },
" with rich out-of-box capabilities as addons based on it's extensibility.": { "out-of-box": {
"message": "得益于其可扩展性，KubeVela 具备大量开箱即用的插件。" "message": "开箱即用"
},
" addons based on it's extensibility,": {
"message": " 的可视化控制台。得益于其可扩展性，KubeVela 具备丰富的插件，"
},
" allow you to build applications and deploy them anywhere!": {
"message": "使得你的应用可以一次构建、随处运行！"
}, },
"theme.SearchPage.documentsFound.plurals": { "theme.SearchPage.documentsFound.plurals": {
"message": "One document found|{count} documents found", "message": "One document found|{count} documents found",
@ -252,11 +261,11 @@
"description": "The search page title for empty query" "description": "The search page title for empty query"
}, },
"theme.SearchPage.inputPlaceholder": { "theme.SearchPage.inputPlaceholder": {
"message": "Type your search here", "message": "请在这里输入",
"description": "The placeholder for search page input" "description": "The placeholder for search page input"
}, },
"theme.SearchPage.inputLabel": { "theme.SearchPage.inputLabel": {
"message": "Search", "message": "搜索内容",
"description": "The ARIA label for search page input" "description": "The ARIA label for search page input"
}, },
"theme.SearchPage.algoliaLabel": { "theme.SearchPage.algoliaLabel": {
@ -272,7 +281,7 @@
"description": "The paragraph for fetching new search results" "description": "The paragraph for fetching new search results"
}, },
"theme.SearchBar.label": { "theme.SearchBar.label": {
"message": "Search", "message": "搜索",
"description": "The ARIA label and placeholder for search button" "description": "The ARIA label and placeholder for search button"
} }
} }

18
i18n/zh/docusaurus-plugin-content-docs/current.json
View File

@ -1,6 +1,6 @@
{ {
"version.label": { "version.label": {
"message": "next", "message": "预览版",
"description": "The label for version current" "description": "The label for version current"
}, },
"sidebar.docs.category.Getting Started": { "sidebar.docs.category.Getting Started": {
@ -250,5 +250,21 @@
"sidebar.docs.category.Advanced Features": { "sidebar.docs.category.Advanced Features": {
"message": "其他高级功能", "message": "其他高级功能",
"description": "其他高级功能" "description": "其他高级功能"
},
"sidebar.docs.category.Basics": {
"message": "基础内容",
"description": "Basic information"
},
"sidebar.docs.category.Deploy Components": {
"message": "部署组件",
"description": "Deploy Components description"
},
"sidebar.docs.category.VelaUX": {
"message": "可视化交付平台（VelaUX）",
"description": "VelaUX description"
},
"sidebar.docs.category.Vela-Core": {
"message": "核心引擎（Vela-Core）",
"description": "Vela-Core description"
} }
} }

36
i18n/zh/docusaurus-plugin-content-docs/current/contributor/overview.md Normal file
View File

@ -0,0 +1,36 @@
---
title: 贡献者手册
---
非常欢迎贡献者们来到这里！你可以阅读社区[成员资格](https://github.com/oam-dev/community/blob/main/community-membership.md) 然后开启你的社区贡献之旅！
## 基本信息
* [提交代码](https://github.com/oam-dev/kubevela/blob/master/contribute/create-pull-request.md)
* [开发指南](https://github.com/oam-dev/kubevela/blob/master/contribute/developer-guide.md)
* [分类 Issue](https://github.com/oam-dev/kubevela/blob/master/contribute/triage-issues.md)
* [代码规范](https://github.com/oam-dev/kubevela/blob/master/contribute/coding-conventions.md)
* [发布流程和节奏](https://github.com/oam-dev/kubevela/blob/master/contribute/develop-code-flow.pdf)
## 贡献插件
* [开发你的插件](../platform-engineers/addon/intro)
* [官方插件仓库](https://github.com/oam-dev/catalog)
## 贡献文档站
* [文档站开发手册](https://github.com/oam-dev/kubevela.io/blob/main/README.md)
## 贡献案例和 Demo
* [社区登记](https://github.com/oam-dev/kubevela/issues/1662)
* [官方 Demo 库](https://github.com/oam-dev/samples)
* [添加博客](https://kubevela.net/blog)
## 其他项目
* [VelaUX 开发手册](https://github.com/oam-dev/velaux/blob/main/CONTRIBUTING.md)
* [Terraform Controller 开发手册](https://github.com/oam-dev/terraform-controller/blob/master/CONTRIBUTING.md)
开启并享受你的开源贡献之旅吧！

26
i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/system-operation/velaql.md
View File

@ -3,39 +3,39 @@ title: VelaQL
--- ---
## 简介 ## 简介
velaQL(全称vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。 VelaQL(全称Vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。
​ ​
KubeVela 的 Application 对象对底层资源进行封装，虽然给用户带来了屏蔽了底层基础架构的便捷，但是也给平台开发者带来了诸多不便: 对Application创建资源状态的监控，只能依赖Application的状态透出，但状态信息简略、状态实时反馈性差， KubeVela 的 Application 对象对底层资源进行封装，虽然给用户带来了屏蔽了底层基础架构的便捷，但是也给平台开发者带来了诸多不便: 对Application创建资源状态的监控，只能依赖Application的状态透出，但状态信息简略、状态实时反馈性差，
Application 的抽象功能对用户屏蔽了实际创建出的资源，当 Application 的状态和实际部署资源状态出现偏差时，用户也很难排查出问题。 Application 的抽象功能对用户屏蔽了实际创建出的资源，当 Application 的状态和实际部署资源状态出现偏差时，用户也很难排查出问题。
​ ​
velaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 velaQL 查询应用部署状态，或者利用 velaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。 VelaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 VelaQL 查询应用部署状态，或者利用 VelaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。
## 使用 ## 使用
### 安装 ### 安装
目前想要使用 velaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。 目前想要使用 VelaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。
```shell ```shell
vela addon enable velaux vela addon enable velaux
``` ```
确保 velaux 安装成功之后，可以通过访问 apiserver 暴露出的服务接口进行状态查询。假设我们在 `http://127.0.0.1:8000` 启动了 apiserver 服务。通过下面的方式使用 velaQL 确保 velaux 安装成功之后，可以通过访问 apiserver 暴露出的服务接口进行状态查询。假设我们在 `http://127.0.0.1:8000` 启动了 apiserver 服务。通过下面的方式使用 VelaQL
```shell ```shell
http://127.0.0.1:8000/api/v1/query?velaql=此处填写查询语句 http://127.0.0.1:8000/api/v1/query?velaql=此处填写查询语句
``` ```
下面我们讲解如何编写 velaQL，从命名上可以看出 velaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。 下面我们讲解如何编写 VelaQL，从命名上可以看出 VelaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。
在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。velaQL的基本语法如下： 在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。VelaQL的基本语法如下：
``` ```
view{parameter1=value1,parameter2=value2} view{parameter1=value1,parameter2=value2}
``` ```
其中 `view` 代表查询视图，可以类比于数据库中视图的概念，velaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。 其中 `view` 代表查询视图，可以类比于数据库中视图的概念，VelaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。
大括号内是一组kv键值对的集合，使用逗号隔开，代表了进行查询时的过滤条件。目前 value 类型只支持：字符串、整数类型、浮点数、布尔类型。 大括号内是一组kv键值对的集合，使用逗号隔开，代表了进行查询时的过滤条件。目前 value 类型只支持：字符串、整数类型、浮点数、布尔类型。
### 查询视图 ### 查询视图
@ -109,9 +109,9 @@ curl --location -g --request GET \
在很多场景下，内置的视图不能满足我们的需求，Application 下封装的资源也都不仅仅是 k8s 的原生资源。针对很多自定义的资源，用户会有不同的查询需求，这时候你需要自己编写特定的视图来完成查询。本节就来告诉大家如何编写一个自定义的视图。 在很多场景下，内置的视图不能满足我们的需求，Application 下封装的资源也都不仅仅是 k8s 的原生资源。针对很多自定义的资源，用户会有不同的查询需求，这时候你需要自己编写特定的视图来完成查询。本节就来告诉大家如何编写一个自定义的视图。
目前velaQL中的视图依赖 k8s 中的 configMap 作为存储介质，你可以参考：[https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml](https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml)。configMap data 字段中的 template 存储着视图的核心逻辑，template 是一段 cue 语言描述的查询语句。 目前VelaQL中的视图依赖 k8s 中的 configMap 作为存储介质，你可以参考：[https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml](https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml)。configMap data 字段中的 template 存储着视图的核心逻辑，template 是一段 cue 语言描述的查询语句。
每次使用 velaQL 时，系统都会从 vela-system 命名空间下查找和视图同名的 configMap 提取出 template 来进行查询操作，所以请保证你的自定义视图存储在 vela-system 下。 每次使用 VelaQL 时，系统都会从 vela-system 命名空间下查找和视图同名的 configMap 提取出 template 来进行查询操作，所以请保证你的自定义视图存储在 vela-system 下。
​ ​
一个 template 的整体结构如下： 一个 template 的整体结构如下：
``` ```
@ -119,7 +119,7 @@ import (
"vela/ql" "vela/ql"
) )
// parameter 和 velaQL 中的参数一一对应 // parameter 和 VelaQL 中的参数一一对应
parameter: { parameter: {
appName: string appName: string
appNs: string appNs: string
@ -131,7 +131,7 @@ parameter: {
... ...
用 cue 来实现的查询语句 用 cue 来实现的查询语句
// velaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下 // VelaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下
status: podList: {...} status: podList: {...}
``` ```
@ -175,7 +175,7 @@ import (
"vela/ql" "vela/ql"
) )
// parameter 和velaQL中的参数一一对应 // parameter 和VelaQL中的参数一一对应
parameter: { parameter: {
appName: string appName: string
appNs: string appNs: string
@ -202,7 +202,7 @@ resources: ql.#ListResourcesInApp & {
} }
} }
// velaQL 默认返回 status 字段的值 // VelaQL 默认返回 status 字段的值
status: resourcesList: resources.list status: resourcesList: resources.list
``` ```

4
i18n/zh/docusaurus-plugin-content-docs/current/reference/ui-schema.md
View File

@ -1,8 +1,8 @@
--- ---
title: UI-Schema title: UI 扩展
--- ---
KubeVela 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。 VelaUX 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。
目前 UI-Schema 规范主要作用于数据输入侧，未来将扩展到数据可视化侧。 目前 UI-Schema 规范主要作用于数据输入侧，未来将扩展到数据可视化侧。

BIN
i18n/zh/docusaurus-plugin-content-docs/current/resources/vela-overview.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 389 KiB

After

Width:  |  Height:  |  Size: 386 KiB

36
i18n/zh/docusaurus-plugin-content-docs/version-v1.3/contributor/overview.md Normal file
View File

@ -0,0 +1,36 @@
---
title: 贡献者手册
---
非常欢迎贡献者们来到这里！你可以阅读社区[成员资格](https://github.com/oam-dev/community/blob/main/community-membership.md) 然后开启你的社区贡献之旅！
## 基本信息
* [提交代码](https://github.com/oam-dev/kubevela/blob/master/contribute/create-pull-request.md)
* [开发指南](https://github.com/oam-dev/kubevela/blob/master/contribute/developer-guide.md)
* [分类 Issue](https://github.com/oam-dev/kubevela/blob/master/contribute/triage-issues.md)
* [代码规范](https://github.com/oam-dev/kubevela/blob/master/contribute/coding-conventions.md)
* [发布流程和节奏](https://github.com/oam-dev/kubevela/blob/master/contribute/develop-code-flow.pdf)
## 贡献插件
* [开发你的插件](../platform-engineers/addon/intro)
* [官方插件仓库](https://github.com/oam-dev/catalog)
## 贡献文档站
* [文档站开发手册](https://github.com/oam-dev/kubevela.io/blob/main/README.md)
## 贡献案例和 Demo
* [社区登记](https://github.com/oam-dev/kubevela/issues/1662)
* [官方 Demo 库](https://github.com/oam-dev/samples)
* [添加博客](https://kubevela.net/blog)
## 其他项目
* [VelaUX 开发手册](https://github.com/oam-dev/velaux/blob/main/CONTRIBUTING.md)
* [Terraform Controller 开发手册](https://github.com/oam-dev/terraform-controller/blob/master/CONTRIBUTING.md)
开启并享受你的开源贡献之旅吧！

26
i18n/zh/docusaurus-plugin-content-docs/version-v1.3/platform-engineers/system-operation/velaql.md
View File

@ -3,39 +3,39 @@ title: VelaQL
--- ---
## 简介 ## 简介
velaQL(全称vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。 VelaQL(全称Vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。
​ ​
KubeVela 的 Application 对象对底层资源进行封装，虽然给用户带来了屏蔽了底层基础架构的便捷，但是也给平台开发者带来了诸多不便: 对Application创建资源状态的监控，只能依赖Application的状态透出，但状态信息简略、状态实时反馈性差， KubeVela 的 Application 对象对底层资源进行封装，虽然给用户带来了屏蔽了底层基础架构的便捷，但是也给平台开发者带来了诸多不便: 对Application创建资源状态的监控，只能依赖Application的状态透出，但状态信息简略、状态实时反馈性差，
Application 的抽象功能对用户屏蔽了实际创建出的资源，当 Application 的状态和实际部署资源状态出现偏差时，用户也很难排查出问题。 Application 的抽象功能对用户屏蔽了实际创建出的资源，当 Application 的状态和实际部署资源状态出现偏差时，用户也很难排查出问题。
​ ​
velaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 velaQL 查询应用部署状态，或者利用 velaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。 VelaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 VelaQL 查询应用部署状态，或者利用 VelaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。
## 使用 ## 使用
### 安装 ### 安装
目前想要使用 velaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。 目前想要使用 VelaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。
```shell ```shell
vela addon enable velaux vela addon enable velaux
``` ```
确保 velaux 安装成功之后，可以通过访问 apiserver 暴露出的服务接口进行状态查询。假设我们在 `http://127.0.0.1:8000` 启动了 apiserver 服务。通过下面的方式使用 velaQL 确保 velaux 安装成功之后，可以通过访问 apiserver 暴露出的服务接口进行状态查询。假设我们在 `http://127.0.0.1:8000` 启动了 apiserver 服务。通过下面的方式使用 VelaQL
```shell ```shell
http://127.0.0.1:8000/api/v1/query?velaql=此处填写查询语句 http://127.0.0.1:8000/api/v1/query?velaql=此处填写查询语句
``` ```
下面我们讲解如何编写 velaQL，从命名上可以看出 velaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。 下面我们讲解如何编写 VelaQL，从命名上可以看出 VelaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。
在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。velaQL的基本语法如下： 在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。VelaQL的基本语法如下：
``` ```
view{parameter1=value1,parameter2=value2} view{parameter1=value1,parameter2=value2}
``` ```
其中 `view` 代表查询视图，可以类比于数据库中视图的概念，velaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。 其中 `view` 代表查询视图，可以类比于数据库中视图的概念，VelaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。
大括号内是一组kv键值对的集合，使用逗号隔开，代表了进行查询时的过滤条件。目前 value 类型只支持：字符串、整数类型、浮点数、布尔类型。 大括号内是一组kv键值对的集合，使用逗号隔开，代表了进行查询时的过滤条件。目前 value 类型只支持：字符串、整数类型、浮点数、布尔类型。
### 查询视图 ### 查询视图
@ -109,9 +109,9 @@ curl --location -g --request GET \
在很多场景下，内置的视图不能满足我们的需求，Application 下封装的资源也都不仅仅是 k8s 的原生资源。针对很多自定义的资源，用户会有不同的查询需求，这时候你需要自己编写特定的视图来完成查询。本节就来告诉大家如何编写一个自定义的视图。 在很多场景下，内置的视图不能满足我们的需求，Application 下封装的资源也都不仅仅是 k8s 的原生资源。针对很多自定义的资源，用户会有不同的查询需求，这时候你需要自己编写特定的视图来完成查询。本节就来告诉大家如何编写一个自定义的视图。
目前velaQL中的视图依赖 k8s 中的 configMap 作为存储介质，你可以参考：[https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml](https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml)。configMap data 字段中的 template 存储着视图的核心逻辑，template 是一段 cue 语言描述的查询语句。 目前VelaQL中的视图依赖 k8s 中的 configMap 作为存储介质，你可以参考：[https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml](https://github.com/oam-dev/kubevela/blob/master/test/e2e-apiserver-test/testdata/component-pod-view.yaml)。configMap data 字段中的 template 存储着视图的核心逻辑，template 是一段 cue 语言描述的查询语句。
每次使用 velaQL 时，系统都会从 vela-system 命名空间下查找和视图同名的 configMap 提取出 template 来进行查询操作，所以请保证你的自定义视图存储在 vela-system 下。 每次使用 VelaQL 时，系统都会从 vela-system 命名空间下查找和视图同名的 configMap 提取出 template 来进行查询操作，所以请保证你的自定义视图存储在 vela-system 下。
​ ​
一个 template 的整体结构如下： 一个 template 的整体结构如下：
``` ```
@ -119,7 +119,7 @@ import (
"vela/ql" "vela/ql"
) )
// parameter 和 velaQL 中的参数一一对应 // parameter 和 VelaQL 中的参数一一对应
parameter: { parameter: {
appName: string appName: string
appNs: string appNs: string
@ -131,7 +131,7 @@ parameter: {
... ...
用 cue 来实现的查询语句 用 cue 来实现的查询语句
// velaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下 // VelaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下
status: podList: {...} status: podList: {...}
``` ```
@ -175,7 +175,7 @@ import (
"vela/ql" "vela/ql"
) )
// parameter 和velaQL中的参数一一对应 // parameter 和VelaQL中的参数一一对应
parameter: { parameter: {
appName: string appName: string
appNs: string appNs: string
@ -202,7 +202,7 @@ resources: ql.#ListResourcesInApp & {
} }
} }
// velaQL 默认返回 status 字段的值 // VelaQL 默认返回 status 字段的值
status: resourcesList: resources.list status: resourcesList: resources.list
``` ```

4
i18n/zh/docusaurus-plugin-content-docs/version-v1.3/reference/ui-schema.md
View File

@ -1,8 +1,8 @@
--- ---
title: UI-Schema title: UI 扩展
--- ---
KubeVela 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。 VelaUX 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。
目前 UI-Schema 规范主要作用于数据输入侧，未来将扩展到数据可视化侧。 目前 UI-Schema 规范主要作用于数据输入侧，未来将扩展到数据可视化侧。

BIN
i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/config-image-registry.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 315 KiB

After

Width:  |  Height:  |  Size: 321 KiB

BIN
i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/vela-overview.jpg
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 389 KiB

After

Width:  |  Height:  |  Size: 386 KiB

2
i18n/zh/docusaurus-theme-classic/footer.json
View File

@ -48,7 +48,7 @@
"description": "The label of footer link with label=Blog linking to blog" "description": "The label of footer link with label=Blog linking to blog"
}, },
"copyright": { "copyright": {
"message": "\n <br />\n <strong>© KubeVela Authors 2021 | Documentation Distributed under <a herf=\"https://creativecommons.org/licenses/by/4.0\">CC-BY-4.0</a> </strong> <strong>| Powered by <a href=\"https://www.netlify.com\">Netlify</a></strong>\n <br />\n ", "message": "\n <br />\n <strong>© KubeVela Authors 2021 | Documentation Distributed under <a herf=\"https://creativecommons.org/licenses/by/4.0\">CC-BY-4.0</a> </strong> \n <br />\n ",
"description": "The footer copyright" "description": "The footer copyright"
} }
} }

1
sidebars.js
View File

@ -224,6 +224,7 @@ module.exports = {
"platform-engineers/system-operation/performance-finetuning", "platform-engineers/system-operation/performance-finetuning",
], ],
}, },
"contributor/overview",
{ {
type: "category", type: "category",
label: "References", label: "References",

5
src/data/features.js
View File

@ -16,13 +16,14 @@ const features = [
), ),
}, },
{ {
title: <><Translate>Programmable Workflow</Translate></>, title: <><Translate>Out of Box UI Console</Translate></>,
imgUrl: 'img/extending-natively.svg', imgUrl: 'img/extending-natively.svg',
description: ( description: (
<> <>
<p> <p>
<Translate> <Translate>
KubeVela models application delivery as DAG (Directed Acyclic Graph) and expresses it with CUE - a modern data configuration language. This allows you to design application deployment steps per needs and orchestrate them in programmable approach. No restrictions, natively extensible.</Translate> KubeVela has an UI Console along with other out-of-box capabilities from a large catalog of addons. It models application delivery as DAG (Directed Acyclic Graph) and expresses it with CUE - a modern data configuration language. This allows you to design application deployment steps per needs and orchestrate them in programmable approach. No restrictions, natively extensible.
</Translate>
</p> </p>
</> </>
), ),

12
src/pages/index.js
View File

@ -102,13 +102,17 @@ const WhatIs = () => (
<p className="hero__subtitle"> <p className="hero__subtitle">
<small> <small>
<Translate> <Translate>
KubeVela is a modern application delivery platform that makes deploying and operating applications across today's hybrid, multi-cloud environments KubeVela is a modern application delivery(CD) platform that makes deploying and operating applications across today's hybrid, multi-cloud environments
</Translate><i><Translate> easier, faster and more reliable.</Translate></i> </Translate><i><Translate> easier, faster and more reliable.</Translate></i>
<br /> <br />
<br /> <br />
<Translate> <Translate>KubeVela is an infrastructure agnostic control plane, with an </Translate>
KubeVela is infrastructure agnostic, programmable, yet most importantly, <i><b> <Translate>application-centric </Translate></b></i>
</Translate><i><b> <Translate>application-centric,</Translate></b></i><Translate> with rich out-of-box capabilities as addons based on it's extensibility.</Translate> <Translate>UI console, that has rich </Translate>
<i><b><Translate>out-of-box</Translate></b></i>
<Translate> addons based on it's extensibility,</Translate>
<Translate> allow you to build applications and deploy them anywhere!</Translate>
<br /> <br />
</small> </small>
</p> </p>

12
versioned_docs/version-v1.3/cli/vela.md
View File

@ -7,7 +7,13 @@ title: CLI Commands
* [vela env](vela_env) - Manage environments for vela applications to run. * [vela env](vela_env) - Manage environments for vela applications to run.
* [vela init](vela_init) - Create scaffold for vela application. * [vela init](vela_init) - Create scaffold for vela application.
* [vela up](vela_up) - Create or update vela application from file or URL, both appfile or application object format are supported. * [vela up](vela_up) - Deploy one application
Deploy one application based on local files or re-deploy an existing application. With the -n/--namespace flag, you can choose the location of the target application.
To apply application from file, use the -f/--file flag to specify the application file location.
To give a particular version to this deploy, use the -v/--publish-version flag. When you are deploying an existing application, the version name must be different from the current name. You can also use a history revision for the deploy and override the current application by using the -r/--revision flag.
* [vela show](vela_show) - Show the reference doc for component, trait or workflow types. * [vela show](vela_show) - Show the reference doc for component, trait or workflow types.
## Managing Applications ## Managing Applications
@ -18,8 +24,9 @@ title: CLI Commands
* [vela exec](vela_exec) - Execute command inside container based vela application. * [vela exec](vela_exec) - Execute command inside container based vela application.
* [vela port-forward](vela_port-forward) - Forward local ports to container/service port of vela application. * [vela port-forward](vela_port-forward) - Forward local ports to container/service port of vela application.
* [vela logs](vela_logs) - Tail logs for vela application. * [vela logs](vela_logs) - Tail logs for vela application.
* [vela live-diff](vela_live-diff) - Dry-run application locally, and diff with a deployed application version. * [vela live-diff](vela_live-diff) - Compare application and revisions
* [vela dry-run](vela_dry-run) - Dry-run application locally, render the Kubernetes resources as result to stdout. * [vela dry-run](vela_dry-run) - Dry-run application locally, render the Kubernetes resources as result to stdout.
* [vela revision](vela_revision) - Manage KubeVela Application Revisions
## Continuous Delivery ## Continuous Delivery
@ -32,6 +39,7 @@ title: CLI Commands
* [vela uischema](vela_uischema) - Manage UI schema for addons. * [vela uischema](vela_uischema) - Manage UI schema for addons.
* [vela def](vela_def) - Manage X-Definitions for extension. * [vela def](vela_def) - Manage X-Definitions for extension.
* [vela registry](vela_registry) - Manage Registry of X-Definitions for extension. * [vela registry](vela_registry) - Manage Registry of X-Definitions for extension.
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers by managing Terraform Controller Providers with its credential secret
* [vela component](vela_component) - List component types installed and discover more in registry. * [vela component](vela_component) - List component types installed and discover more in registry.
* [vela trait](vela_trait) - List trait types installed and discover more in registry. * [vela trait](vela_trait) - List trait types installed and discover more in registry.

2
versioned_docs/version-v1.3/cli/vela_addon.md
View File

@ -33,4 +33,4 @@ Manage addons for extension.
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

3
versioned_docs/version-v1.3/cli/vela_addon_disable.md
View File

@ -21,6 +21,7 @@ vela addon disable <addon-name>
### Options ### Options
``` ```
-f, --force skip checking if applications are still using this addon
-h, --help help for disable -h, --help help for disable
``` ```
@ -37,4 +38,4 @@ vela addon disable <addon-name>
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

11
versioned_docs/version-v1.3/cli/vela_addon_enable.md
View File

@ -15,13 +15,22 @@ vela addon enable [flags]
### Examples ### Examples
``` ```
\
Enable addon by:
vela addon enable <addon-name> vela addon enable <addon-name>
Enable addon with specify version:
vela addon enable <addon-name> --version <addon-version>
Enable addon for specific clusters, (local means control plane):
vela addon enable <addon-name> --clusters={local,cluster1,cluster2}
``` ```
### Options ### Options
``` ```
-c, --clusters string specify the runtime-clusters to enable
-h, --help help for enable -h, --help help for enable
-v, --version string specify the addon version to enable
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -37,4 +46,4 @@ vela addon enable <addon-name>
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_list.md
View File

@ -31,4 +31,4 @@ vela addon list [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_registry.md
View File

@ -32,4 +32,4 @@ Manage addon registry.
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_registry_add.md
View File

@ -42,4 +42,4 @@ vela addon registry add [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_registry_delete.md
View File

@ -37,4 +37,4 @@ vela addon registry delete <registry-name>
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_registry_get.md
View File

@ -37,4 +37,4 @@ vela addon registry get <registry name>
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_registry_list.md
View File

@ -37,4 +37,4 @@ vela addon registry list
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_registry_update.md
View File

@ -42,4 +42,4 @@ vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_addon_status.md
View File

@ -37,4 +37,4 @@ vela addon status <addon-name>
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

10
versioned_docs/version-v1.3/cli/vela_addon_upgrade.md
View File

@ -15,13 +15,21 @@ vela addon upgrade [flags]
### Examples ### Examples
``` ```
\
Upgrade addon by:
vela addon upgrade <addon-name> vela addon upgrade <addon-name>
Upgrade addon with specify version:
vela addon upgrade <addon-name> --version <addon-version>
Upgrade addon for specific clusters, (local means control plane):
vela addon upgrade <addon-name> --clusters={local,cluster1,cluster2}
``` ```
### Options ### Options
``` ```
-h, --help help for upgrade -h, --help help for upgrade
-v, --version string specify the addon version to upgrade
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -37,4 +45,4 @@ vela addon upgrade <addon-name>
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
versioned_docs/version-v1.3/cli/vela_cluster.md
View File

@ -23,8 +23,10 @@ Manage Kubernetes Clusters for Continuous Delivery.
### SEE ALSO ### SEE ALSO
* [vela cluster alias](vela_cluster_alias) - alias a named cluster.
* [vela cluster detach](vela_cluster_detach) - detach managed cluster. * [vela cluster detach](vela_cluster_detach) - detach managed cluster.
* [vela cluster join](vela_cluster_join) - join managed cluster. * [vela cluster join](vela_cluster_join) - join managed cluster.
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
* [vela cluster list](vela_cluster_list) - list managed clusters * [vela cluster list](vela_cluster_list) - list managed clusters
* [vela cluster probe](vela_cluster_probe) - health probe managed cluster. * [vela cluster probe](vela_cluster_probe) - health probe managed cluster.
* [vela cluster rename](vela_cluster_rename) - rename managed cluster. * [vela cluster rename](vela_cluster_rename) - rename managed cluster.
@ -32,4 +34,4 @@ Manage Kubernetes Clusters for Continuous Delivery.
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

34
versioned_docs/version-v1.3/cli/vela_cluster_alias.md Normal file
View File

@ -0,0 +1,34 @@
---
title: vela cluster alias
---
alias a named cluster.
### Synopsis
alias a named cluster.
```
vela cluster alias CLUSTER_NAME ALIAS [flags]
```
### Options
```
-h, --help help for alias
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_cluster_detach.md
View File

@ -32,4 +32,4 @@ vela cluster detach [CLUSTER_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
versioned_docs/version-v1.3/cli/vela_cluster_join.md
View File

@ -22,8 +22,8 @@ vela cluster join [KUBECONFIG] [flags]
### Options ### Options
``` ```
--create-namespace string Specifies the namespace need to create in managedCluster --create-namespace string Specifies the namespace need to create in managedCluster (default "vela-system")
-t, --engine string Specify the cluster management engine. If empty, it will use cluster-gateway cluster management solution. Default to be empty. -t, --engine string Specify the cluster management engine. If empty, it will use cluster-gateway cluster management solution. Default to be empty. (default "cluster-gateway")
-h, --help help for join -h, --help help for join
--in-cluster-boostrap If true, the registering managed cluster will use the internal endpoint prescribed in the hub cluster's configmap "kube-public/cluster-info to register "itself to the hub cluster. Otherwise use the original endpoint from the hub kubeconfig. (default true) --in-cluster-boostrap If true, the registering managed cluster will use the internal endpoint prescribed in the hub cluster's configmap "kube-public/cluster-info to register "itself to the hub cluster. Otherwise use the original endpoint from the hub kubeconfig. (default true)
-n, --name string Specify the cluster name. If empty, it will use the cluster name in config file. Default to be empty. -n, --name string Specify the cluster name. If empty, it will use the cluster name in config file. Default to be empty.
@ -42,4 +42,4 @@ vela cluster join [KUBECONFIG] [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

32
versioned_docs/version-v1.3/cli/vela_cluster_labels.md Normal file
View File

@ -0,0 +1,32 @@
---
title: vela cluster labels
---
Manage Kubernetes Cluster Labels
### Synopsis
Manage Kubernetes Cluster Labels for Continuous Delivery.
### Options
```
-h, --help help for labels
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster](vela_cluster) - Manage Kubernetes Clusters
* [vela cluster labels add](vela_cluster_labels_add) - add labels to managed cluster
* [vela cluster labels del](vela_cluster_labels_del) - delete labels for managed cluster
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

40
versioned_docs/version-v1.3/cli/vela_cluster_labels_add.md Normal file
View File

@ -0,0 +1,40 @@
---
title: vela cluster labels add
---
add labels to managed cluster
### Synopsis
add labels to managed cluster
```
vela cluster labels add CLUSTER_NAME LABELS [flags]
```
### Examples
```
vela cluster labels add my-cluster project=kubevela,owner=oam-dev
```
### Options
```
-h, --help help for add
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

40
versioned_docs/version-v1.3/cli/vela_cluster_labels_del.md Normal file
View File

@ -0,0 +1,40 @@
---
title: vela cluster labels del
---
delete labels for managed cluster
### Synopsis
delete labels for managed cluster
```
vela cluster labels del CLUSTER_NAME LABELS [flags]
```
### Examples
```
vela cluster labels del my-cluster project,owner
```
### Options
```
-h, --help help for del
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela cluster labels](vela_cluster_labels) - Manage Kubernetes Cluster Labels
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_cluster_list.md
View File

@ -31,4 +31,4 @@ vela cluster list [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_cluster_probe.md
View File

@ -31,4 +31,4 @@ vela cluster probe [CLUSTER_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_cluster_rename.md
View File

@ -31,4 +31,4 @@ vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_completion.md
View File

@ -30,4 +30,4 @@ The shell code must be evaluated to provide interactive completion of vela comma
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_completion_bash.md
View File

@ -41,4 +41,4 @@ vela completion bash
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_completion_zsh.md
View File

@ -38,4 +38,4 @@ vela completion zsh
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_component.md
View File

@ -43,4 +43,4 @@ vela comp
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_component_get.md
View File

@ -40,4 +40,4 @@ vela comp get <component>
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_def.md
View File

@ -36,4 +36,4 @@ Manage X-Definitions for extension.
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_def_apply.md
View File

@ -43,4 +43,4 @@ vela def apply DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
versioned_docs/version-v1.3/cli/vela_def_del.md
View File

@ -24,7 +24,7 @@ vela def del DEFINITION_NAME [flags]
``` ```
-h, --help help for del -h, --help help for del
-n, --namespace string Specify which namespace the definition locates. -n, --namespace string Specify which namespace the definition locates.
-t, --type string Specify the definition type of target. Valid types: workload, scope, workflow-step, component, trait, policy -t, --type string Specify the definition type of target. Valid types: trait, policy, workload, scope, workflow-step, component
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -40,4 +40,4 @@ vela def del DEFINITION_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
versioned_docs/version-v1.3/cli/vela_def_doc-gen.md
View File

@ -17,6 +17,8 @@ vela def doc-gen NAME [flags]
``` ```
1. Generate documentation for ComponentDefinition alibaba-vpc: 1. Generate documentation for ComponentDefinition alibaba-vpc:
> vela def doc-gen alibaba-vpc -n vela-system > vela def doc-gen alibaba-vpc -n vela-system
2. Generate documentation for local ComponentDefinition file alibaba-vpc.yaml:
> vela def doc-gen alibaba-vpc.yaml
``` ```
@ -40,4 +42,4 @@ vela def doc-gen NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
versioned_docs/version-v1.3/cli/vela_def_edit.md
View File

@ -27,7 +27,7 @@ vela def edit NAME [flags]
``` ```
-h, --help help for edit -h, --help help for edit
-n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched. -n, --namespace string Specify which namespace to get. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: policy, workload, scope, workflow-step, component, trait -t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: trait, policy, workload, scope, workflow-step, component
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -43,4 +43,4 @@ vela def edit NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_def_get.md
View File

@ -42,4 +42,4 @@ vela def get NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
versioned_docs/version-v1.3/cli/vela_def_init.md
View File

@ -42,7 +42,7 @@ vela def init DEF_NAME [flags]
--path string Specify which path the configuration(HCL) is stored in the Git repository. Valid when --git is set. --path string Specify which path the configuration(HCL) is stored in the Git repository. Valid when --git is set.
-p, --provider alibaba Specify which provider the cloud resource definition belongs to. Only alibaba, `aws`, `azure` are supported. -p, --provider alibaba Specify which provider the cloud resource definition belongs to. Only alibaba, `aws`, `azure` are supported.
-f, --template-yaml string Specify the template yaml file that definition will use to build the schema. If empty, a default template for the given definition type will be used. -f, --template-yaml string Specify the template yaml file that definition will use to build the schema. If empty, a default template for the given definition type will be used.
-t, --type string Specify the type of the new definition. Valid types: component, trait, policy, workload, scope, workflow-step -t, --type string Specify the type of the new definition. Valid types: workload, scope, workflow-step, component, trait, policy
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -58,4 +58,4 @@ vela def init DEF_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

4
versioned_docs/version-v1.3/cli/vela_def_list.md
View File

@ -26,7 +26,7 @@ vela def list [flags]
``` ```
-h, --help help for list -h, --help help for list
-n, --namespace string Specify which namespace to list. If empty, all namespaces will be searched. -n, --namespace string Specify which namespace to list. If empty, all namespaces will be searched.
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: component, trait, policy, workload, scope, workflow-step -t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: policy, workload, scope, workflow-step, component, trait
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -42,4 +42,4 @@ vela def list [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_def_render.md
View File

@ -43,4 +43,4 @@ vela def render DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_def_vet.md
View File

@ -39,4 +39,4 @@ vela def vet DEFINITION.cue [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_delete.md
View File

@ -42,4 +42,4 @@ vela delete frontend
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_dry-run.md
View File

@ -41,4 +41,4 @@ vela dry-run
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_env.md
View File

@ -31,4 +31,4 @@ Manage environments for vela applications to run.
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_env_delete.md
View File

@ -37,4 +37,4 @@ vela env delete test
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_env_init.md
View File

@ -38,4 +38,4 @@ vela env init test --namespace test
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_env_ls.md
View File

@ -37,4 +37,4 @@ vela env ls [env-name]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_env_set.md
View File

@ -37,4 +37,4 @@ vela env set test
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_exec.md
View File

@ -49,4 +49,4 @@ vela exec [flags] APP_NAME -- COMMAND [args...]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_export.md
View File

@ -34,4 +34,4 @@ vela export
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_help.md
View File

@ -27,4 +27,4 @@ vela help [command]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_init.md
View File

@ -40,4 +40,4 @@ vela init
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_install.md
View File

@ -37,4 +37,4 @@ vela install [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

19
versioned_docs/version-v1.3/cli/vela_live-diff.md
View File

@ -2,11 +2,11 @@
title: vela live-diff title: vela live-diff
--- ---
Dry-run application locally, and diff with a deployed application version Compare application and revisions
### Synopsis ### Synopsis
Dry-run application locally, and diff with a deployed application version. Compare application and revisions
``` ```
vela live-diff vela live-diff
@ -15,19 +15,26 @@ vela live-diff
### Examples ### Examples
``` ```
vela live-diff -f app-v2.yaml -r app-v1 --context 10 # compare the current application and the running revision
> vela live-diff my-app
# compare the current application and the specified revision
> vela live-diff my-app --revision my-app-v1
# compare two application revisions
> vela live-diff --revision my-app-v1,my-app-v2
# compare the application file and the specified revision
> vela live-diff -f my-app.yaml -r my-app-v1 --context 10
``` ```
### Options ### Options
``` ```
-r, --Revision string specify an application Revision name, by default, it will compare with the latest Revision
-c, --context int output number lines of context around changes, by default show all unchanged lines (default -1) -c, --context int output number lines of context around changes, by default show all unchanged lines (default -1)
-d, --definition string specify a file or directory containing capability definitions, they will only be used in dry-run rather than applied to K8s cluster -d, --definition string specify a file or directory containing capability definitions, they will only be used in dry-run rather than applied to K8s cluster
-e, --env string specify environment name for application -e, --env string specify environment name for application
-f, --file string application file name (default "./app.yaml") -f, --file string application file name
-h, --help help for live-diff -h, --help help for live-diff
-n, --namespace string specify the Kubernetes namespace to use -n, --namespace string specify the Kubernetes namespace to use
-r, --revision string specify one or two application revision name(s), by default, it will compare with the latest revision
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -43,4 +50,4 @@ vela live-diff -f app-v2.yaml -r app-v1 --context 10
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

3
versioned_docs/version-v1.3/cli/vela_logs.md
View File

@ -18,6 +18,7 @@ vela logs APP_NAME [flags]
-c, --container string specify container name for output -c, --container string specify container name for output
-e, --env string specify environment name for application -e, --env string specify environment name for application
-h, --help help for logs -h, --help help for logs
--name string specify resource name for output
-n, --namespace string specify the Kubernetes namespace to use -n, --namespace string specify the Kubernetes namespace to use
-o, --output string output format for logs, support: [default, raw, json] (default "default") -o, --output string output format for logs, support: [default, raw, json] (default "default")
``` ```
@ -35,4 +36,4 @@ vela logs APP_NAME [flags]
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_ls.md
View File

@ -40,4 +40,4 @@ vela ls
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_port-forward.md
View File

@ -42,4 +42,4 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

33
versioned_docs/version-v1.3/cli/vela_provider.md Normal file
View File

@ -0,0 +1,33 @@
---
title: vela provider
---
Authenticate Terraform Cloud Providers
### Synopsis
Authenticate Terraform Cloud Providers by managing Terraform Controller Providers with its credential secret
### Options
```
-h, --help help for provider
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
* [vela provider list](vela_provider_list) - List Terraform Cloud Providers
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

47
versioned_docs/version-v1.3/cli/vela_provider_add.md Normal file
View File

@ -0,0 +1,47 @@
---
title: vela provider add
---
Authenticate Terraform Cloud Provider
### Synopsis
Authenticate Terraform Cloud Provider by creating a credential secret and a Terraform Controller Provider
```
vela provider add [flags]
```
### Examples
```
vela provider add <provider-type>
```
### Options
```
-h, --help help for add
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers
* [vela provider add terraform-alibaba](vela_provider_add_terraform-alibaba) - Authenticate Terraform Cloud Provider terraform-alibaba
* [vela provider add terraform-aws](vela_provider_add_terraform-aws) - Authenticate Terraform Cloud Provider terraform-aws
* [vela provider add terraform-azure](vela_provider_add_terraform-azure) - Authenticate Terraform Cloud Provider terraform-azure
* [vela provider add terraform-baidu](vela_provider_add_terraform-baidu) - Authenticate Terraform Cloud Provider terraform-baidu
* [vela provider add terraform-gcp](vela_provider_add_terraform-gcp) - Authenticate Terraform Cloud Provider terraform-gcp
* [vela provider add terraform-tencent](vela_provider_add_terraform-tencent) - Authenticate Terraform Cloud Provider terraform-tencent
* [vela provider add terraform-ucloud](vela_provider_add_terraform-ucloud) - Authenticate Terraform Cloud Provider terraform-ucloud
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

44
versioned_docs/version-v1.3/cli/vela_provider_add_terraform-alibaba.md Normal file
View File

@ -0,0 +1,44 @@
---
title: vela provider add terraform-alibaba
---
Authenticate Terraform Cloud Provider terraform-alibaba
### Synopsis
Authenticate Terraform Cloud Provider terraform-alibaba by creating a credential secret and a Terraform Controller Provider
```
vela provider add terraform-alibaba [flags]
```
### Examples
```
vela provider add terraform-alibaba
```
### Options
```
--ALICLOUD_ACCESS_KEY string Get ALICLOUD_ACCESS_KEY per this guide https://help.aliyun.com/knowledge_detail/38738.html
--ALICLOUD_REGION string Get ALICLOUD_REGION by picking one RegionId from Alibaba Cloud region list https://www.alibabacloud.com/help/doc-detail/72379.htm
--ALICLOUD_SECRET_KEY string Get ALICLOUD_SECRET_KEY per this guide https://help.aliyun.com/knowledge_detail/38738.html
-h, --help help for terraform-alibaba
--name default The name of Terraform Provider for Alibaba Cloud, default is default (default "default")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

45
versioned_docs/version-v1.3/cli/vela_provider_add_terraform-aws.md Normal file
View File

@ -0,0 +1,45 @@
---
title: vela provider add terraform-aws
---
Authenticate Terraform Cloud Provider terraform-aws
### Synopsis
Authenticate Terraform Cloud Provider terraform-aws by creating a credential secret and a Terraform Controller Provider
```
vela provider add terraform-aws [flags]
```
### Examples
```
vela provider add terraform-aws
```
### Options
```
--AWS_ACCESS_KEY_ID string Get AWS_ACCESS_KEY_ID per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/
--AWS_DEFAULT_REGION string Choose one of Code form region list https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions
--AWS_SECRET_ACCESS_KEY string Get AWS_SECRET_ACCESS_KEY per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/
--AWS_SESSION_TOKEN string Get AWS_SESSION_TOKEN per https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html
-h, --help help for terraform-aws
--name default The name of Terraform Provider for AWS, default is default (default "aws")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

45
versioned_docs/version-v1.3/cli/vela_provider_add_terraform-azure.md Normal file
View File

@ -0,0 +1,45 @@
---
title: vela provider add terraform-azure
---
Authenticate Terraform Cloud Provider terraform-azure
### Synopsis
Authenticate Terraform Cloud Provider terraform-azure by creating a credential secret and a Terraform Controller Provider
```
vela provider add terraform-azure [flags]
```
### Examples
```
vela provider add terraform-azure
```
### Options
```
--ARM_CLIENT_ID string
--ARM_CLIENT_SECRET string
--ARM_SUBSCRIPTION_ID string
--ARM_TENANT_ID string
-h, --help help for terraform-azure
--name azure The name of Terraform Provider for Azure, default is azure (default "azure")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

44
versioned_docs/version-v1.3/cli/vela_provider_add_terraform-baidu.md Normal file
View File

@ -0,0 +1,44 @@
---
title: vela provider add terraform-baidu
---
Authenticate Terraform Cloud Provider terraform-baidu
### Synopsis
Authenticate Terraform Cloud Provider terraform-baidu by creating a credential secret and a Terraform Controller Provider
```
vela provider add terraform-baidu [flags]
```
### Examples
```
vela provider add terraform-baidu
```
### Options
```
--BAIDUCLOUD_ACCESS_KEY string Get BAIDUCLOUD_ACCESS_KEY per this guide https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
--BAIDUCLOUD_REGION string Get BAIDUCLOUD_REGION by picking one RegionId from Baidu Cloud region list https://cloud.baidu.com/doc/Reference/s/2jwvz23xx
--BAIDUCLOUD_SECRET_KEY string Get BAIDUCLOUD_SECRET_KEY per this guide https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
-h, --help help for terraform-baidu
--name baidu The name of Terraform Provider for Baidu Cloud, default is baidu (default "baidu")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

44
versioned_docs/version-v1.3/cli/vela_provider_add_terraform-gcp.md Normal file
View File

@ -0,0 +1,44 @@
---
title: vela provider add terraform-gcp
---
Authenticate Terraform Cloud Provider terraform-gcp
### Synopsis
Authenticate Terraform Cloud Provider terraform-gcp by creating a credential secret and a Terraform Controller Provider
```
vela provider add terraform-gcp [flags]
```
### Examples
```
vela provider add terraform-gcp
```
### Options
```
--GOOGLE_CREDENTIALS string Get gcpCredentialsJSON per this guide https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#adding-credentials
--GOOGLE_PROJECT string Set gcpProject per this guide https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#configuring-the-provider
--GOOGLE_REGION string Get GOOGLE_REGION by picking one RegionId from Google Cloud region list https://cloud.google.com/compute/docs/regions-zones
-h, --help help for terraform-gcp
--name default The name of Terraform Provider for GCP, default is default (default "gcp")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

44
versioned_docs/version-v1.3/cli/vela_provider_add_terraform-tencent.md Normal file
View File

@ -0,0 +1,44 @@
---
title: vela provider add terraform-tencent
---
Authenticate Terraform Cloud Provider terraform-tencent
### Synopsis
Authenticate Terraform Cloud Provider terraform-tencent by creating a credential secret and a Terraform Controller Provider
```
vela provider add terraform-tencent [flags]
```
### Examples
```
vela provider add terraform-tencent
```
### Options
```
--TENCENTCLOUD_REGION string Get TENCENTCLOUD_REGION by picking one RegionId from Tencent Cloud region list https://cloud.tencent.com/document/api/1140/40509#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8
--TENCENTCLOUD_SECRET_ID string Get TENCENTCLOUD_SECRET_ID per this guide https://cloud.tencent.com/document/product/1213/67093
--TENCENTCLOUD_SECRET_KEY string Get TENCENTCLOUD_SECRET_KEY per this guide https://cloud.tencent.com/document/product/1213/67093
-h, --help help for terraform-tencent
--name default The name of Terraform Provider for Tencent Cloud, default is default (default "tencent")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

45
versioned_docs/version-v1.3/cli/vela_provider_add_terraform-ucloud.md Normal file
View File

@ -0,0 +1,45 @@
---
title: vela provider add terraform-ucloud
---
Authenticate Terraform Cloud Provider terraform-ucloud
### Synopsis
Authenticate Terraform Cloud Provider terraform-ucloud by creating a credential secret and a Terraform Controller Provider
```
vela provider add terraform-ucloud [flags]
```
### Examples
```
vela provider add terraform-ucloud
```
### Options
```
--UCLOUD_PRIVATE_KEY string Get UCLOUD_PRIVATE_KEY per this guide https://docs.ucloud.cn/terraform/quickstart
--UCLOUD_PROJECT_ID string Get UCLOUD_PROJECT_ID per this guide https://docs.ucloud.cn/terraform/quickstart
--UCLOUD_PUBLIC_KEY string Get UCLOUD_PUBLIC_KEY per this guide https://docs.ucloud.cn/terraform/quickstart
--UCLOUD_REGION string Get UCLOUD_REGION by picking one RegionId from UCloud region list https://docs.ucloud.cn/api/summary/regionlist
-h, --help help for terraform-ucloud
--name default The name of Terraform Provider for Ucloud Cloud, default is default (default "ucloud")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

47
versioned_docs/version-v1.3/cli/vela_provider_delete.md Normal file
View File

@ -0,0 +1,47 @@
---
title: vela provider delete
---
Delete Terraform Cloud Provider
### Synopsis
Delete Terraform Cloud Provider
```
vela provider delete [flags]
```
### Examples
```
vela provider delete <provider-type> -name <provider-name>
```
### Options
```
-h, --help help for delete
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers
* [vela provider delete terraform-alibaba](vela_provider_delete_terraform-alibaba) - Delete Terraform Cloud Provider terraform-alibaba
* [vela provider delete terraform-aws](vela_provider_delete_terraform-aws) - Delete Terraform Cloud Provider terraform-aws
* [vela provider delete terraform-azure](vela_provider_delete_terraform-azure) - Delete Terraform Cloud Provider terraform-azure
* [vela provider delete terraform-baidu](vela_provider_delete_terraform-baidu) - Delete Terraform Cloud Provider terraform-baidu
* [vela provider delete terraform-gcp](vela_provider_delete_terraform-gcp) - Delete Terraform Cloud Provider terraform-gcp
* [vela provider delete terraform-tencent](vela_provider_delete_terraform-tencent) - Delete Terraform Cloud Provider terraform-tencent
* [vela provider delete terraform-ucloud](vela_provider_delete_terraform-ucloud) - Delete Terraform Cloud Provider terraform-ucloud
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

41
versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-alibaba.md Normal file
View File

@ -0,0 +1,41 @@
---
title: vela provider delete terraform-alibaba
---
Delete Terraform Cloud Provider terraform-alibaba
### Synopsis
Delete Terraform Cloud Provider terraform-alibaba
```
vela provider delete terraform-alibaba [flags]
```
### Examples
```
vela provider delete terraform-alibaba
```
### Options
```
-h, --help help for terraform-alibaba
--name default The name of Terraform Provider for Alibaba Cloud, default is default (default "default")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

41
versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-aws.md Normal file
View File

@ -0,0 +1,41 @@
---
title: vela provider delete terraform-aws
---
Delete Terraform Cloud Provider terraform-aws
### Synopsis
Delete Terraform Cloud Provider terraform-aws
```
vela provider delete terraform-aws [flags]
```
### Examples
```
vela provider delete terraform-aws
```
### Options
```
-h, --help help for terraform-aws
--name default The name of Terraform Provider for AWS, default is default (default "aws")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

41
versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-azure.md Normal file
View File

@ -0,0 +1,41 @@
---
title: vela provider delete terraform-azure
---
Delete Terraform Cloud Provider terraform-azure
### Synopsis
Delete Terraform Cloud Provider terraform-azure
```
vela provider delete terraform-azure [flags]
```
### Examples
```
vela provider delete terraform-azure
```
### Options
```
-h, --help help for terraform-azure
--name azure The name of Terraform Provider for Azure, default is azure (default "azure")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

41
versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-baidu.md Normal file
View File

@ -0,0 +1,41 @@
---
title: vela provider delete terraform-baidu
---
Delete Terraform Cloud Provider terraform-baidu
### Synopsis
Delete Terraform Cloud Provider terraform-baidu
```
vela provider delete terraform-baidu [flags]
```
### Examples
```
vela provider delete terraform-baidu
```
### Options
```
-h, --help help for terraform-baidu
--name baidu The name of Terraform Provider for Baidu Cloud, default is baidu (default "baidu")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

41
versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-gcp.md Normal file
View File

@ -0,0 +1,41 @@
---
title: vela provider delete terraform-gcp
---
Delete Terraform Cloud Provider terraform-gcp
### Synopsis
Delete Terraform Cloud Provider terraform-gcp
```
vela provider delete terraform-gcp [flags]
```
### Examples
```
vela provider delete terraform-gcp
```
### Options
```
-h, --help help for terraform-gcp
--name default The name of Terraform Provider for GCP, default is default (default "gcp")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

41
versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-tencent.md Normal file
View File

@ -0,0 +1,41 @@
---
title: vela provider delete terraform-tencent
---
Delete Terraform Cloud Provider terraform-tencent
### Synopsis
Delete Terraform Cloud Provider terraform-tencent
```
vela provider delete terraform-tencent [flags]
```
### Examples
```
vela provider delete terraform-tencent
```
### Options
```
-h, --help help for terraform-tencent
--name default The name of Terraform Provider for Tencent Cloud, default is default (default "tencent")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

41
versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-ucloud.md Normal file
View File

@ -0,0 +1,41 @@
---
title: vela provider delete terraform-ucloud
---
Delete Terraform Cloud Provider terraform-ucloud
### Synopsis
Delete Terraform Cloud Provider terraform-ucloud
```
vela provider delete terraform-ucloud [flags]
```
### Examples
```
vela provider delete terraform-ucloud
```
### Options
```
-h, --help help for terraform-ucloud
--name default The name of Terraform Provider for Ucloud Cloud, default is default (default "ucloud")
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

34
versioned_docs/version-v1.3/cli/vela_provider_list.md Normal file
View File

@ -0,0 +1,34 @@
---
title: vela provider list
---
List Terraform Cloud Providers
### Synopsis
List Terraform Cloud Providers
```
vela provider list [flags]
```
### Options
```
-h, --help help for list
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_registry.md
View File

@ -30,4 +30,4 @@ Manage Registry of X-Definitions for extension.
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_registry_config.md
View File

@ -38,4 +38,4 @@ vela registry config my-registry https://github.com/oam-dev/catalog/tree/master/
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_registry_ls.md
View File

@ -37,4 +37,4 @@ vela registry ls
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_registry_remove.md
View File

@ -37,4 +37,4 @@ vela registry remove mycenter
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

31
versioned_docs/version-v1.3/cli/vela_revision.md Normal file
View File

@ -0,0 +1,31 @@
---
title: vela revision
---
Manage Application Revisions
### Synopsis
Manage KubeVela Application Revisions
### Options
```
-h, --help help for revision
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela revision list](vela_revision_list) - list application revisions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

36
versioned_docs/version-v1.3/cli/vela_revision_list.md Normal file
View File

@ -0,0 +1,36 @@
---
title: vela revision list
---
list application revisions
### Synopsis
list Kubevela application revisions
```
vela revision list [flags]
```
### Options
```
-e, --env string specify environment name for application
-h, --help help for list
-n, --namespace string specify the Kubernetes namespace to use
```
### Options inherited from parent commands
```
-y, --yes Assume yes for all user prompts
```
### SEE ALSO
* [vela revision](vela_revision) - Manage Application Revisions
#### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

2
versioned_docs/version-v1.3/cli/vela_show.md
View File

@ -40,4 +40,4 @@ show webservice
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

6
versioned_docs/version-v1.3/cli/vela_status.md
View File

@ -21,11 +21,15 @@ vela status APP_NAME
### Options ### Options
``` ```
-c, --component string filter service endpoints by component name
-d, --detail display the realtime details of application resources
--detail-format string the format for displaying details. Can be one of inline (default), wide, list, table, raw. (default "inline")
-p, --endpoint show all service endpoints of the application -p, --endpoint show all service endpoints of the application
-e, --env string specify environment name for application -e, --env string specify environment name for application
-h, --help help for status -h, --help help for status
-n, --namespace string specify the Kubernetes namespace to use -n, --namespace string specify the Kubernetes namespace to use
-s, --svc string service name -s, --svc string service name
-t, --tree display the application resources into tree structure
``` ```
### Options inherited from parent commands ### Options inherited from parent commands
@ -41,4 +45,4 @@ vela status APP_NAME
#### Go Back to [CLI Commands](vela) Homepage. #### Go Back to [CLI Commands](vela) Homepage.
###### Auto generated by spf13/cobra on 9-Feb-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen). ###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/oam-dev/kubevela/tree/master/hack/docgen).

Some files were not shown because too many files have changed in this diff Show More