diff --git a/docs/contributor/overview.md b/docs/contributor/overview.md new file mode 100644 index 00000000..1e1f3e14 --- /dev/null +++ b/docs/contributor/overview.md @@ -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! diff --git a/docs/platform-engineers/addon/intro.md b/docs/platform-engineers/addon/intro.md index f72318bd..5624c182 100644 --- a/docs/platform-engineers/addon/intro.md +++ b/docs/platform-engineers/addon/intro.md @@ -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. diff --git a/docs/reference/ui-schema.md b/docs/reference/ui-schema.md index 0413504b..25e1d31b 100644 --- a/docs/reference/ui-schema.md +++ b/docs/reference/ui-schema.md @@ -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. diff --git a/docs/resources/vela-overview.jpg b/docs/resources/vela-overview.jpg index 0ad4d5da..881d5097 100644 Binary files a/docs/resources/vela-overview.jpg and b/docs/resources/vela-overview.jpg differ diff --git a/docusaurus.config.js b/docusaurus.config.js index 77092d23..8f95436b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -125,7 +125,7 @@ module.exports = { ], copyright: `
- © KubeVela Authors ${new Date().getFullYear()} | Documentation Distributed under CC-BY-4.0 | Powered by Netlify + © KubeVela Authors ${new Date().getFullYear()} | Documentation Distributed under CC-BY-4.0

© ${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 Trademark Usage page. 浙ICP备12022327号 diff --git a/i18n/zh/code.json b/i18n/zh/code.json index 5bc23651..96f880ed 100644 --- a/i18n/zh/code.json +++ b/i18n/zh/code.json @@ -72,11 +72,11 @@ "description": "The ARIA label for copy code blocks button" }, "theme.CodeBlock.copied": { - "message": "Copied", + "message": "复制成功", "description": "The copied button label on code blocks" }, "theme.CodeBlock.copy": { - "message": "Copy", + "message": "复制", "description": "The copy button label on code blocks" }, "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.": { "message": "KubeVela 以开放应用模型（OAM）作为应用交付的顶层抽象，并通过声明式的交付工作流来捕获面向混合环境的微服务应用交付的整个过程，甚至连多集群分发策略、流量调配和滚动更新等运维特征，也都声明在应用级别。用户无需关心任何基础设施细节，只需要专注于定义和部署应用即可。" }, - "Programmable Workflow": { - "message": "可编程式交付工作流" + "Out of Box UI Console": { + "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.": { - "message": "KubeVela 会将应用交付流程建模为有向无环图（DAG），并将它通过 CUE（一种源自 Google Borg 系统的数据配置语言）来进行表达和实现。这使得你可以自由的根据自己的需求来设计交付工作流中的每一个步骤，并通过可编程的方式将它们编排起来。没有任何限制，原生高可扩展" + "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 有大量开箱即用的插件可以选用。KubeVela 会将应用交付流程建模为有向无环图（DAG），并将它通过 CUE（一种源自 Google Borg 系统的数据配置语言）来进行表达和实现。这使得你可以自由的根据自己的需求来设计和选用交付工作流中的每一个步骤，并通过可编程的方式将它们编排起来。没有任何限制，原生高可扩展" }, "Infrastructure Agnostic": { "message": "基础设施无关" @@ -221,23 +221,32 @@ "sandbox project": { "message": "沙箱级项目" }, - "KubeVela is a modern application delivery platform that makes deploying and operating applications across today's hybrid, multi-cloud environments": { - "message": "KubeVela 是一个现代化的应用交付平台，它可以让你的应用交付与管理在当今流行的混合、多云环境中变得更加" + "KubeVela is a modern application delivery(CD) platform that makes deploying and operating applications across today's hybrid, multi-cloud environments": { + "message": "KubeVela 是一个现代化的应用交付（CD）平台，它可以让你的应用交付与管理在当今流行的混合、多云环境中变得更加" }, " easier, faster and more reliable.": { "message": "简单、轻松、可靠。" }, - "KubeVela is infrastructure agnostic, programmable, yet most importantly,": { - "message": "KubeVela 是基础设施无关的、可编程的，但最重要的是：" + "KubeVela is an infrastructure agnostic control plane, with an ": { + "message": "KubeVela 是一个基础设施无关的控制平面，它具备一个" }, - "application-centric,": { - "message": "它是完全以应用为中心的。" + "application-centric ": { + "message": "以应用为中心、" + }, + "UI console, that has rich ": { + "message": "" }, ".": { "message": "." }, - " with rich out-of-box capabilities as addons based on it's extensibility.": { - "message": "得益于其可扩展性，KubeVela 具备大量开箱即用的插件。" + "out-of-box": { + "message": "开箱即用" + }, + " addons based on it's extensibility,": { + "message": " 的可视化控制台。得益于其可扩展性，KubeVela 具备丰富的插件，" + }, + " allow you to build applications and deploy them anywhere!": { + "message": "使得你的应用可以一次构建、随处运行！" }, "theme.SearchPage.documentsFound.plurals": { "message": "One document found|{count} documents found", @@ -252,11 +261,11 @@ "description": "The search page title for empty query" }, "theme.SearchPage.inputPlaceholder": { - "message": "Type your search here", + "message": "请在这里输入", "description": "The placeholder for search page input" }, "theme.SearchPage.inputLabel": { - "message": "Search", + "message": "搜索内容", "description": "The ARIA label for search page input" }, "theme.SearchPage.algoliaLabel": { @@ -272,7 +281,7 @@ "description": "The paragraph for fetching new search results" }, "theme.SearchBar.label": { - "message": "Search", + "message": "搜索", "description": "The ARIA label and placeholder for search button" } } \ No newline at end of file diff --git a/i18n/zh/docusaurus-plugin-content-docs/current.json b/i18n/zh/docusaurus-plugin-content-docs/current.json index 18a9b195..ef349c35 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current.json +++ b/i18n/zh/docusaurus-plugin-content-docs/current.json @@ -1,6 +1,6 @@ { "version.label": { - "message": "next", + "message": "预览版", "description": "The label for version current" }, "sidebar.docs.category.Getting Started": { @@ -250,5 +250,21 @@ "sidebar.docs.category.Advanced Features": { "message": "其他高级功能", "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" } } \ No newline at end of file diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contributor/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/contributor/overview.md new file mode 100644 index 00000000..5f78ebb2 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/contributor/overview.md @@ -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) + + +开启并享受你的开源贡献之旅吧！ diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/system-operation/velaql.md b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/system-operation/velaql.md index e7a29353..c665b6b9 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/system-operation/velaql.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/system-operation/velaql.md @@ -3,39 +3,39 @@ title: VelaQL --- ## 简介 -velaQL(全称vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。 +VelaQL(全称Vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。 ​ KubeVela 的 Application 对象对底层资源进行封装，虽然给用户带来了屏蔽了底层基础架构的便捷，但是也给平台开发者带来了诸多不便: 对Application创建资源状态的监控，只能依赖Application的状态透出，但状态信息简略、状态实时反馈性差， Application 的抽象功能对用户屏蔽了实际创建出的资源，当 Application 的状态和实际部署资源状态出现偏差时，用户也很难排查出问题。 ​ -velaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 velaQL 查询应用部署状态，或者利用 velaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。 +VelaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 VelaQL 查询应用部署状态，或者利用 VelaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。 ## 使用 ### 安装 -目前想要使用 velaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。 +目前想要使用 VelaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。 ```shell 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 http://127.0.0.1:8000/api/v1/query?velaql=此处填写查询语句 ``` -下面我们讲解如何编写 velaQL，从命名上可以看出 velaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。 -在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。velaQL的基本语法如下： +下面我们讲解如何编写 VelaQL，从命名上可以看出 VelaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。 +在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。VelaQL的基本语法如下： ``` view{parameter1=value1,parameter2=value2} ``` -其中 `view` 代表查询视图，可以类比于数据库中视图的概念，velaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。 +其中 `view` 代表查询视图，可以类比于数据库中视图的概念，VelaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。 大括号内是一组kv键值对的集合，使用逗号隔开，代表了进行查询时的过滤条件。目前 value 类型只支持：字符串、整数类型、浮点数、布尔类型。 ### 查询视图 @@ -109,9 +109,9 @@ curl --location -g --request GET \ 在很多场景下，内置的视图不能满足我们的需求，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 的整体结构如下： ``` @@ -119,7 +119,7 @@ import ( "vela/ql" ) -// parameter 和 velaQL 中的参数一一对应 +// parameter 和 VelaQL 中的参数一一对应 parameter: { appName: string appNs: string @@ -131,7 +131,7 @@ parameter: { ... 用 cue 来实现的查询语句 -// velaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下 +// VelaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下 status: podList: {...} ``` @@ -175,7 +175,7 @@ import ( "vela/ql" ) -// parameter 和velaQL中的参数一一对应 +// parameter 和VelaQL中的参数一一对应 parameter: { appName: string appNs: string @@ -202,7 +202,7 @@ resources: ql.#ListResourcesInApp & { } } -// velaQL 默认返回 status 字段的值 +// VelaQL 默认返回 status 字段的值 status: resourcesList: resources.list ``` diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/reference/ui-schema.md b/i18n/zh/docusaurus-plugin-content-docs/current/reference/ui-schema.md index 9a2a43e2..e6b6481a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/reference/ui-schema.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/reference/ui-schema.md @@ -1,8 +1,8 @@ --- -title: UI-Schema +title: UI 扩展 --- -KubeVela 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。 +VelaUX 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。 目前 UI-Schema 规范主要作用于数据输入侧，未来将扩展到数据可视化侧。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/resources/vela-overview.jpg b/i18n/zh/docusaurus-plugin-content-docs/current/resources/vela-overview.jpg index 2528f1b6..512d97b8 100644 Binary files a/i18n/zh/docusaurus-plugin-content-docs/current/resources/vela-overview.jpg and b/i18n/zh/docusaurus-plugin-content-docs/current/resources/vela-overview.jpg differ diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/contributor/overview.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/contributor/overview.md new file mode 100644 index 00000000..5f78ebb2 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/contributor/overview.md @@ -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) + + +开启并享受你的开源贡献之旅吧！ diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/platform-engineers/system-operation/velaql.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/platform-engineers/system-operation/velaql.md index e7a29353..c665b6b9 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/platform-engineers/system-operation/velaql.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/platform-engineers/system-operation/velaql.md @@ -3,39 +3,39 @@ title: VelaQL --- ## 简介 -velaQL(全称vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。 +VelaQL(全称Vela Query Language)，是面向 KubeVela 的资源查询语言，用于查询应用级别的资源状态。 ​ KubeVela 的 Application 对象对底层资源进行封装，虽然给用户带来了屏蔽了底层基础架构的便捷，但是也给平台开发者带来了诸多不便: 对Application创建资源状态的监控，只能依赖Application的状态透出，但状态信息简略、状态实时反馈性差， Application 的抽象功能对用户屏蔽了实际创建出的资源，当 Application 的状态和实际部署资源状态出现偏差时，用户也很难排查出问题。 ​ -velaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 velaQL 查询应用部署状态，或者利用 velaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。 +VelaQL的目的是帮用户和平台开发者揭开 Application 的神秘面纱，用户可以通过 VelaQL 查询应用部署状态，或者利用 VelaQL 提供的可扩展接口自定义查询资源信息，提升Application的可观测性，能够在应用出现问题时及时做出响应。 ## 使用 ### 安装 -目前想要使用 velaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。 +目前想要使用 VelaQL 的查询能力，需要安装 velaux，借助 apiserver 的能力进行状态查询，未来我们会提供更多的交互方式。现在只需一个简单的指令就能安装 velaux。 ```shell 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 http://127.0.0.1:8000/api/v1/query?velaql=此处填写查询语句 ``` -下面我们讲解如何编写 velaQL，从命名上可以看出 velaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。 -在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。velaQL的基本语法如下： +下面我们讲解如何编写 VelaQL，从命名上可以看出 VelaQL 对标的是 PromQL ，我们期望能够成为应用监控领域的 Prometheus。 +在查询语法上，我们也和 PromQL 对齐，提供了和 PromQL 类似的查询语句，方便用户简单快捷的查询应用状态。VelaQL的基本语法如下： ``` view{parameter1=value1,parameter2=value2} ``` -其中 `view` 代表查询视图，可以类比于数据库中视图的概念，velaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。 +其中 `view` 代表查询视图，可以类比于数据库中视图的概念，VelaQL 中的 `view` 是一个对 `k8s`这个“数据库”进行资源状态查询的集合。 大括号内是一组kv键值对的集合，使用逗号隔开，代表了进行查询时的过滤条件。目前 value 类型只支持：字符串、整数类型、浮点数、布尔类型。 ### 查询视图 @@ -109,9 +109,9 @@ curl --location -g --request GET \ 在很多场景下，内置的视图不能满足我们的需求，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 的整体结构如下： ``` @@ -119,7 +119,7 @@ import ( "vela/ql" ) -// parameter 和 velaQL 中的参数一一对应 +// parameter 和 VelaQL 中的参数一一对应 parameter: { appName: string appNs: string @@ -131,7 +131,7 @@ parameter: { ... 用 cue 来实现的查询语句 -// velaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下 +// VelaQL 的查询结果会默认返回 status 字段的内容，所以请把需要查询的结果汇总在 status 字段下 status: podList: {...} ``` @@ -175,7 +175,7 @@ import ( "vela/ql" ) -// parameter 和velaQL中的参数一一对应 +// parameter 和VelaQL中的参数一一对应 parameter: { appName: string appNs: string @@ -202,7 +202,7 @@ resources: ql.#ListResourcesInApp & { } } -// velaQL 默认返回 status 字段的值 +// VelaQL 默认返回 status 字段的值 status: resourcesList: resources.list ``` diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/reference/ui-schema.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/reference/ui-schema.md index 9a2a43e2..e6b6481a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/reference/ui-schema.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/reference/ui-schema.md @@ -1,8 +1,8 @@ --- -title: UI-Schema +title: UI 扩展 --- -KubeVela 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。 +VelaUX 针对组件、工作流步骤、运维特征资源的可扩展性，在可变输入参数项的情况下，为了实现较为原生的 UI 体验，设计并实现了 UI-Schema 规范。 目前 UI-Schema 规范主要作用于数据输入侧，未来将扩展到数据可视化侧。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/config-image-registry.jpg b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/config-image-registry.jpg index 9978f3f2..4046cc6d 100644 Binary files a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/config-image-registry.jpg and b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/config-image-registry.jpg differ diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/vela-overview.jpg b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/vela-overview.jpg index 2528f1b6..512d97b8 100644 Binary files a/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/vela-overview.jpg and b/i18n/zh/docusaurus-plugin-content-docs/version-v1.3/resources/vela-overview.jpg differ diff --git a/i18n/zh/docusaurus-theme-classic/footer.json b/i18n/zh/docusaurus-theme-classic/footer.json index 3170ed0d..97ec9e53 100644 --- a/i18n/zh/docusaurus-theme-classic/footer.json +++ b/i18n/zh/docusaurus-theme-classic/footer.json @@ -48,7 +48,7 @@ "description": "The label of footer link with label=Blog linking to blog" }, "copyright": { - "message": "\n
\n © KubeVela Authors 2021 | Documentation Distributed under CC-BY-4.0 | Powered by Netlify\n
\n ", + "message": "\n
\n © KubeVela Authors 2021 | Documentation Distributed under CC-BY-4.0 \n
\n ", "description": "The footer copyright" } } \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 8f7c5abf..e2e0f89a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -224,6 +224,7 @@ module.exports = { "platform-engineers/system-operation/performance-finetuning", ], }, + "contributor/overview", { type: "category", label: "References", diff --git a/src/data/features.js b/src/data/features.js index d30623a2..6c6b224d 100644 --- a/src/data/features.js +++ b/src/data/features.js @@ -9,20 +9,21 @@ const features = [ <>

- 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.

), }, { - title: <>Programmable Workflow, + title: <>Out of Box UI Console, imgUrl: 'img/extending-natively.svg', description: ( <>

- 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. +

), @@ -35,11 +36,11 @@ const features = [ <>

- KubeVela works as an application - delivery control plane that is fully decoupled from runtime - infrastructure. It can deploy any - workload types including containers, cloud services, databases, - or even VM instances to any cloud or Kubernetes cluster, following the + KubeVela works as an application + delivery control plane that is fully decoupled from runtime + infrastructure. It can deploy any + workload types including containers, cloud services, databases, + or even VM instances to any cloud or Kubernetes cluster, following the workflow designed by you.

diff --git a/src/pages/index.js b/src/pages/index.js index 765d0fba..0ad5e2b3 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -102,13 +102,17 @@ const WhatIs = () => (

- 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 easier, faster and more reliable. +

- - KubeVela is infrastructure agnostic, programmable, yet most importantly, - application-centric, with rich out-of-box capabilities as addons based on it's extensibility. + KubeVela is an infrastructure agnostic control plane, with an + application-centric + UI console, that has rich + out-of-box + addons based on it's extensibility, + allow you to build applications and deploy them anywhere!

@@ -123,5 +127,5 @@ const WhatIs = () => ( - + ); \ No newline at end of file diff --git a/versioned_docs/version-v1.3/cli/vela.md b/versioned_docs/version-v1.3/cli/vela.md index a771684c..d4cda77c 100644 --- a/versioned_docs/version-v1.3/cli/vela.md +++ b/versioned_docs/version-v1.3/cli/vela.md @@ -7,7 +7,13 @@ title: CLI Commands * [vela env](vela_env) - Manage environments for vela applications to run. * [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. ## Managing Applications @@ -18,8 +24,9 @@ title: CLI Commands * [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 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 revision](vela_revision) - Manage KubeVela Application Revisions ## Continuous Delivery @@ -32,6 +39,7 @@ title: CLI Commands * [vela uischema](vela_uischema) - Manage UI schema for addons. * [vela def](vela_def) - Manage 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 trait](vela_trait) - List trait types installed and discover more in registry. diff --git a/versioned_docs/version-v1.3/cli/vela_addon.md b/versioned_docs/version-v1.3/cli/vela_addon.md index c4419467..aa9ab7e9 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon.md +++ b/versioned_docs/version-v1.3/cli/vela_addon.md @@ -33,4 +33,4 @@ Manage addons for extension. #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_disable.md b/versioned_docs/version-v1.3/cli/vela_addon_disable.md index 5931966d..ac57efc9 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_disable.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_disable.md @@ -21,7 +21,8 @@ vela addon disable ### Options ``` - -h, --help help for disable + -f, --force skip checking if applications are still using this addon + -h, --help help for disable ``` ### Options inherited from parent commands @@ -37,4 +38,4 @@ vela addon disable #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_enable.md b/versioned_docs/version-v1.3/cli/vela_addon_enable.md index 1c1bdd08..cec0b7da 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_enable.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_enable.md @@ -15,13 +15,22 @@ vela addon enable [flags] ### Examples ``` -vela addon enable +\ +Enable addon by: + vela addon enable +Enable addon with specify version: + vela addon enable --version +Enable addon for specific clusters, (local means control plane): + vela addon enable --clusters={local,cluster1,cluster2} + ``` ### Options ``` - -h, --help help for enable + -c, --clusters string specify the runtime-clusters to enable + -h, --help help for enable + -v, --version string specify the addon version to enable ``` ### Options inherited from parent commands @@ -37,4 +46,4 @@ vela addon enable #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_list.md b/versioned_docs/version-v1.3/cli/vela_addon_list.md index 93cc35eb..82527140 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_list.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_list.md @@ -31,4 +31,4 @@ vela addon list [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_registry.md b/versioned_docs/version-v1.3/cli/vela_addon_registry.md index 24f9efa8..be1abba5 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_registry.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_registry.md @@ -32,4 +32,4 @@ Manage addon registry. #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_registry_add.md b/versioned_docs/version-v1.3/cli/vela_addon_registry_add.md index f90c2409..9bb4dce9 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_registry_add.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_registry_add.md @@ -42,4 +42,4 @@ vela addon registry add [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_registry_delete.md b/versioned_docs/version-v1.3/cli/vela_addon_registry_delete.md index 2aeb5f50..18d4caa0 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_registry_delete.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_registry_delete.md @@ -37,4 +37,4 @@ vela addon registry delete #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_registry_get.md b/versioned_docs/version-v1.3/cli/vela_addon_registry_get.md index b4bf21d3..ee08586d 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_registry_get.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_registry_get.md @@ -37,4 +37,4 @@ vela addon registry get #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_registry_list.md b/versioned_docs/version-v1.3/cli/vela_addon_registry_list.md index 2e066d96..92e3507c 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_registry_list.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_registry_list.md @@ -37,4 +37,4 @@ vela addon registry list #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_registry_update.md b/versioned_docs/version-v1.3/cli/vela_addon_registry_update.md index 0e997661..6ddf7f68 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_registry_update.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_registry_update.md @@ -42,4 +42,4 @@ vela addon registry update --type OSS --endpoint= --bucket= #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_status.md b/versioned_docs/version-v1.3/cli/vela_addon_status.md index 02632759..1a61460c 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_status.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_status.md @@ -37,4 +37,4 @@ vela addon status #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_addon_upgrade.md b/versioned_docs/version-v1.3/cli/vela_addon_upgrade.md index 730c808d..bcb3d2e3 100644 --- a/versioned_docs/version-v1.3/cli/vela_addon_upgrade.md +++ b/versioned_docs/version-v1.3/cli/vela_addon_upgrade.md @@ -15,13 +15,21 @@ vela addon upgrade [flags] ### Examples ``` -vela addon upgrade +\ +Upgrade addon by: + vela addon upgrade +Upgrade addon with specify version: + vela addon upgrade --version +Upgrade addon for specific clusters, (local means control plane): + vela addon upgrade --clusters={local,cluster1,cluster2} + ``` ### 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 @@ -37,4 +45,4 @@ vela addon upgrade #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster.md b/versioned_docs/version-v1.3/cli/vela_cluster.md index 3fc365e5..c4592b3e 100644 --- a/versioned_docs/version-v1.3/cli/vela_cluster.md +++ b/versioned_docs/version-v1.3/cli/vela_cluster.md @@ -23,8 +23,10 @@ Manage Kubernetes Clusters for Continuous Delivery. ### SEE ALSO +* [vela cluster alias](vela_cluster_alias) - alias a named cluster. * [vela cluster detach](vela_cluster_detach) - detach 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 probe](vela_cluster_probe) - health probe 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. -###### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_alias.md b/versioned_docs/version-v1.3/cli/vela_cluster_alias.md new file mode 100644 index 00000000..f5fd5248 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_cluster_alias.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_detach.md b/versioned_docs/version-v1.3/cli/vela_cluster_detach.md index a409effb..10b1f31f 100644 --- a/versioned_docs/version-v1.3/cli/vela_cluster_detach.md +++ b/versioned_docs/version-v1.3/cli/vela_cluster_detach.md @@ -32,4 +32,4 @@ vela cluster detach [CLUSTER_NAME] [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_join.md b/versioned_docs/version-v1.3/cli/vela_cluster_join.md index ec1bc9fd..e5fc9f16 100644 --- a/versioned_docs/version-v1.3/cli/vela_cluster_join.md +++ b/versioned_docs/version-v1.3/cli/vela_cluster_join.md @@ -22,8 +22,8 @@ vela cluster join [KUBECONFIG] [flags] ### Options ``` - --create-namespace string Specifies the namespace need to create in managedCluster - -t, --engine string Specify the cluster management engine. If empty, it will use cluster-gateway cluster management solution. Default to be empty. + --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. (default "cluster-gateway") -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) -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. -###### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_labels.md b/versioned_docs/version-v1.3/cli/vela_cluster_labels.md new file mode 100644 index 00000000..ff569b2c --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_cluster_labels.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_labels_add.md b/versioned_docs/version-v1.3/cli/vela_cluster_labels_add.md new file mode 100644 index 00000000..e7c70568 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_cluster_labels_add.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_labels_del.md b/versioned_docs/version-v1.3/cli/vela_cluster_labels_del.md new file mode 100644 index 00000000..dab8313c --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_cluster_labels_del.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_list.md b/versioned_docs/version-v1.3/cli/vela_cluster_list.md index 04ee7335..7e4fd253 100644 --- a/versioned_docs/version-v1.3/cli/vela_cluster_list.md +++ b/versioned_docs/version-v1.3/cli/vela_cluster_list.md @@ -31,4 +31,4 @@ vela cluster list [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_probe.md b/versioned_docs/version-v1.3/cli/vela_cluster_probe.md index 4d77d2d6..6f922c39 100644 --- a/versioned_docs/version-v1.3/cli/vela_cluster_probe.md +++ b/versioned_docs/version-v1.3/cli/vela_cluster_probe.md @@ -31,4 +31,4 @@ vela cluster probe [CLUSTER_NAME] [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_cluster_rename.md b/versioned_docs/version-v1.3/cli/vela_cluster_rename.md index b8e2e962..6bc7767f 100644 --- a/versioned_docs/version-v1.3/cli/vela_cluster_rename.md +++ b/versioned_docs/version-v1.3/cli/vela_cluster_rename.md @@ -31,4 +31,4 @@ vela cluster rename [OLD_NAME] [NEW_NAME] [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_completion.md b/versioned_docs/version-v1.3/cli/vela_completion.md index fca46d21..00fd3e70 100644 --- a/versioned_docs/version-v1.3/cli/vela_completion.md +++ b/versioned_docs/version-v1.3/cli/vela_completion.md @@ -30,4 +30,4 @@ The shell code must be evaluated to provide interactive completion of vela comma #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_completion_bash.md b/versioned_docs/version-v1.3/cli/vela_completion_bash.md index 0f72f7f6..d5c38b1e 100644 --- a/versioned_docs/version-v1.3/cli/vela_completion_bash.md +++ b/versioned_docs/version-v1.3/cli/vela_completion_bash.md @@ -41,4 +41,4 @@ vela completion bash #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_completion_zsh.md b/versioned_docs/version-v1.3/cli/vela_completion_zsh.md index 2354b09b..6d04ec75 100644 --- a/versioned_docs/version-v1.3/cli/vela_completion_zsh.md +++ b/versioned_docs/version-v1.3/cli/vela_completion_zsh.md @@ -38,4 +38,4 @@ vela completion zsh #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_component.md b/versioned_docs/version-v1.3/cli/vela_component.md index 1263b2a8..3d348488 100644 --- a/versioned_docs/version-v1.3/cli/vela_component.md +++ b/versioned_docs/version-v1.3/cli/vela_component.md @@ -43,4 +43,4 @@ vela comp #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_component_get.md b/versioned_docs/version-v1.3/cli/vela_component_get.md index b36d7b79..35b3fdbd 100644 --- a/versioned_docs/version-v1.3/cli/vela_component_get.md +++ b/versioned_docs/version-v1.3/cli/vela_component_get.md @@ -40,4 +40,4 @@ vela comp get #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def.md b/versioned_docs/version-v1.3/cli/vela_def.md index 0d5614f1..b50cca1f 100644 --- a/versioned_docs/version-v1.3/cli/vela_def.md +++ b/versioned_docs/version-v1.3/cli/vela_def.md @@ -36,4 +36,4 @@ Manage X-Definitions for extension. #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_apply.md b/versioned_docs/version-v1.3/cli/vela_def_apply.md index 2c84b6db..6e238689 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_apply.md +++ b/versioned_docs/version-v1.3/cli/vela_def_apply.md @@ -43,4 +43,4 @@ vela def apply DEFINITION.cue [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_del.md b/versioned_docs/version-v1.3/cli/vela_def_del.md index e7e2ebfa..12766c10 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_del.md +++ b/versioned_docs/version-v1.3/cli/vela_def_del.md @@ -24,7 +24,7 @@ vela def del DEFINITION_NAME [flags] ``` -h, --help help for del -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 @@ -40,4 +40,4 @@ vela def del DEFINITION_NAME [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_doc-gen.md b/versioned_docs/version-v1.3/cli/vela_def_doc-gen.md index 681481bf..c4ea16a3 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_doc-gen.md +++ b/versioned_docs/version-v1.3/cli/vela_def_doc-gen.md @@ -17,6 +17,8 @@ vela def doc-gen NAME [flags] ``` 1. Generate documentation for ComponentDefinition alibaba-vpc: > 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. -###### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_edit.md b/versioned_docs/version-v1.3/cli/vela_def_edit.md index 885a779a..68024935 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_edit.md +++ b/versioned_docs/version-v1.3/cli/vela_def_edit.md @@ -27,7 +27,7 @@ vela def edit NAME [flags] ``` -h, --help help for edit -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 @@ -43,4 +43,4 @@ vela def edit NAME [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_get.md b/versioned_docs/version-v1.3/cli/vela_def_get.md index dbc16c49..5b8be4f7 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_get.md +++ b/versioned_docs/version-v1.3/cli/vela_def_get.md @@ -42,4 +42,4 @@ vela def get NAME [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_init.md b/versioned_docs/version-v1.3/cli/vela_def_init.md index 6839df9a..0034efee 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_init.md +++ b/versioned_docs/version-v1.3/cli/vela_def_init.md @@ -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. -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. - -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 @@ -58,4 +58,4 @@ vela def init DEF_NAME [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_list.md b/versioned_docs/version-v1.3/cli/vela_def_list.md index c20135f3..b0229746 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_list.md +++ b/versioned_docs/version-v1.3/cli/vela_def_list.md @@ -26,7 +26,7 @@ vela def list [flags] ``` -h, --help help for list -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 @@ -42,4 +42,4 @@ vela def list [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_render.md b/versioned_docs/version-v1.3/cli/vela_def_render.md index 71d96434..7d1bdd59 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_render.md +++ b/versioned_docs/version-v1.3/cli/vela_def_render.md @@ -43,4 +43,4 @@ vela def render DEFINITION.cue [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_def_vet.md b/versioned_docs/version-v1.3/cli/vela_def_vet.md index 3a028955..adbb8b4a 100644 --- a/versioned_docs/version-v1.3/cli/vela_def_vet.md +++ b/versioned_docs/version-v1.3/cli/vela_def_vet.md @@ -39,4 +39,4 @@ vela def vet DEFINITION.cue [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_delete.md b/versioned_docs/version-v1.3/cli/vela_delete.md index ec091ba6..86683697 100644 --- a/versioned_docs/version-v1.3/cli/vela_delete.md +++ b/versioned_docs/version-v1.3/cli/vela_delete.md @@ -42,4 +42,4 @@ vela delete frontend #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_dry-run.md b/versioned_docs/version-v1.3/cli/vela_dry-run.md index 6f86f337..76326114 100644 --- a/versioned_docs/version-v1.3/cli/vela_dry-run.md +++ b/versioned_docs/version-v1.3/cli/vela_dry-run.md @@ -41,4 +41,4 @@ vela dry-run #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_env.md b/versioned_docs/version-v1.3/cli/vela_env.md index 17b9fb97..8448c421 100644 --- a/versioned_docs/version-v1.3/cli/vela_env.md +++ b/versioned_docs/version-v1.3/cli/vela_env.md @@ -31,4 +31,4 @@ Manage environments for vela applications to run. #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_env_delete.md b/versioned_docs/version-v1.3/cli/vela_env_delete.md index 01958e15..da14b861 100644 --- a/versioned_docs/version-v1.3/cli/vela_env_delete.md +++ b/versioned_docs/version-v1.3/cli/vela_env_delete.md @@ -37,4 +37,4 @@ vela env delete test #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_env_init.md b/versioned_docs/version-v1.3/cli/vela_env_init.md index 9882e1fd..a413a654 100644 --- a/versioned_docs/version-v1.3/cli/vela_env_init.md +++ b/versioned_docs/version-v1.3/cli/vela_env_init.md @@ -38,4 +38,4 @@ vela env init test --namespace test #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_env_ls.md b/versioned_docs/version-v1.3/cli/vela_env_ls.md index 4c9bb248..2dcf9c9f 100644 --- a/versioned_docs/version-v1.3/cli/vela_env_ls.md +++ b/versioned_docs/version-v1.3/cli/vela_env_ls.md @@ -37,4 +37,4 @@ vela env ls [env-name] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_env_set.md b/versioned_docs/version-v1.3/cli/vela_env_set.md index 2d4c89b0..326d86a7 100644 --- a/versioned_docs/version-v1.3/cli/vela_env_set.md +++ b/versioned_docs/version-v1.3/cli/vela_env_set.md @@ -37,4 +37,4 @@ vela env set test #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_exec.md b/versioned_docs/version-v1.3/cli/vela_exec.md index 88fd199e..b1f6a712 100644 --- a/versioned_docs/version-v1.3/cli/vela_exec.md +++ b/versioned_docs/version-v1.3/cli/vela_exec.md @@ -49,4 +49,4 @@ vela exec [flags] APP_NAME -- COMMAND [args...] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_export.md b/versioned_docs/version-v1.3/cli/vela_export.md index e0c328d0..5a2f3108 100644 --- a/versioned_docs/version-v1.3/cli/vela_export.md +++ b/versioned_docs/version-v1.3/cli/vela_export.md @@ -34,4 +34,4 @@ vela export #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_help.md b/versioned_docs/version-v1.3/cli/vela_help.md index af61cc31..63dd3975 100644 --- a/versioned_docs/version-v1.3/cli/vela_help.md +++ b/versioned_docs/version-v1.3/cli/vela_help.md @@ -27,4 +27,4 @@ vela help [command] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_init.md b/versioned_docs/version-v1.3/cli/vela_init.md index 985d25d4..2890428b 100644 --- a/versioned_docs/version-v1.3/cli/vela_init.md +++ b/versioned_docs/version-v1.3/cli/vela_init.md @@ -40,4 +40,4 @@ vela init #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_install.md b/versioned_docs/version-v1.3/cli/vela_install.md index fd36509a..579b5597 100644 --- a/versioned_docs/version-v1.3/cli/vela_install.md +++ b/versioned_docs/version-v1.3/cli/vela_install.md @@ -37,4 +37,4 @@ vela install [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_live-diff.md b/versioned_docs/version-v1.3/cli/vela_live-diff.md index 2078982d..511f5fa1 100644 --- a/versioned_docs/version-v1.3/cli/vela_live-diff.md +++ b/versioned_docs/version-v1.3/cli/vela_live-diff.md @@ -2,11 +2,11 @@ title: vela live-diff --- -Dry-run application locally, and diff with a deployed application version +Compare application and revisions ### Synopsis -Dry-run application locally, and diff with a deployed application version. +Compare application and revisions ``` vela live-diff @@ -15,19 +15,26 @@ vela live-diff ### 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 ``` - -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) -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 - -f, --file string application file name (default "./app.yaml") + -f, --file string application file name -h, --help help for live-diff -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 @@ -43,4 +50,4 @@ vela live-diff -f app-v2.yaml -r app-v1 --context 10 #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_logs.md b/versioned_docs/version-v1.3/cli/vela_logs.md index 838c5bda..2ce97bbb 100644 --- a/versioned_docs/version-v1.3/cli/vela_logs.md +++ b/versioned_docs/version-v1.3/cli/vela_logs.md @@ -18,6 +18,7 @@ vela logs APP_NAME [flags] -c, --container string specify container name for output -e, --env string specify environment name for application -h, --help help for logs + --name string specify resource name for output -n, --namespace string specify the Kubernetes namespace to use -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. -###### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_ls.md b/versioned_docs/version-v1.3/cli/vela_ls.md index 42c4692e..fb383e68 100644 --- a/versioned_docs/version-v1.3/cli/vela_ls.md +++ b/versioned_docs/version-v1.3/cli/vela_ls.md @@ -40,4 +40,4 @@ vela ls #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_port-forward.md b/versioned_docs/version-v1.3/cli/vela_port-forward.md index f183993f..5361f345 100644 --- a/versioned_docs/version-v1.3/cli/vela_port-forward.md +++ b/versioned_docs/version-v1.3/cli/vela_port-forward.md @@ -42,4 +42,4 @@ port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMO #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider.md b/versioned_docs/version-v1.3/cli/vela_provider.md new file mode 100644 index 00000000..e440d9c8 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add.md b/versioned_docs/version-v1.3/cli/vela_provider_add.md new file mode 100644 index 00000000..75480eaa --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add.md @@ -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 +``` + +### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-alibaba.md b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-alibaba.md new file mode 100644 index 00000000..a2dcc60f --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-alibaba.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-aws.md b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-aws.md new file mode 100644 index 00000000..2fcb6336 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-aws.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-azure.md b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-azure.md new file mode 100644 index 00000000..9e95e559 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-azure.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-baidu.md b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-baidu.md new file mode 100644 index 00000000..75eeacc6 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-baidu.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-gcp.md b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-gcp.md new file mode 100644 index 00000000..b5011f22 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-gcp.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-tencent.md b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-tencent.md new file mode 100644 index 00000000..97c6ad91 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-tencent.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-ucloud.md b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-ucloud.md new file mode 100644 index 00000000..6f1324e4 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_add_terraform-ucloud.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete.md b/versioned_docs/version-v1.3/cli/vela_provider_delete.md new file mode 100644 index 00000000..afc3f4a4 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete.md @@ -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 -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-alibaba.md b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-alibaba.md new file mode 100644 index 00000000..bcefcf18 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-alibaba.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-aws.md b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-aws.md new file mode 100644 index 00000000..726e1c85 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-aws.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-azure.md b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-azure.md new file mode 100644 index 00000000..0bba5a4e --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-azure.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-baidu.md b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-baidu.md new file mode 100644 index 00000000..2dc561ce --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-baidu.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-gcp.md b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-gcp.md new file mode 100644 index 00000000..84ac13c9 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-gcp.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-tencent.md b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-tencent.md new file mode 100644 index 00000000..01bc9ad6 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-tencent.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-ucloud.md b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-ucloud.md new file mode 100644 index 00000000..8d73ee9c --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_delete_terraform-ucloud.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_provider_list.md b/versioned_docs/version-v1.3/cli/vela_provider_list.md new file mode 100644 index 00000000..1cc8b34e --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_provider_list.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_registry.md b/versioned_docs/version-v1.3/cli/vela_registry.md index 30f86c42..5dfaf9e7 100644 --- a/versioned_docs/version-v1.3/cli/vela_registry.md +++ b/versioned_docs/version-v1.3/cli/vela_registry.md @@ -30,4 +30,4 @@ Manage Registry of X-Definitions for extension. #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_registry_config.md b/versioned_docs/version-v1.3/cli/vela_registry_config.md index 8b4f286f..de267767 100644 --- a/versioned_docs/version-v1.3/cli/vela_registry_config.md +++ b/versioned_docs/version-v1.3/cli/vela_registry_config.md @@ -38,4 +38,4 @@ vela registry config my-registry https://github.com/oam-dev/catalog/tree/master/ #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_registry_ls.md b/versioned_docs/version-v1.3/cli/vela_registry_ls.md index 35ca04be..07509e9a 100644 --- a/versioned_docs/version-v1.3/cli/vela_registry_ls.md +++ b/versioned_docs/version-v1.3/cli/vela_registry_ls.md @@ -37,4 +37,4 @@ vela registry ls #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_registry_remove.md b/versioned_docs/version-v1.3/cli/vela_registry_remove.md index f5d5c2c4..e97e123e 100644 --- a/versioned_docs/version-v1.3/cli/vela_registry_remove.md +++ b/versioned_docs/version-v1.3/cli/vela_registry_remove.md @@ -37,4 +37,4 @@ vela registry remove mycenter #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_revision.md b/versioned_docs/version-v1.3/cli/vela_revision.md new file mode 100644 index 00000000..113ad0f9 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_revision.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_revision_list.md b/versioned_docs/version-v1.3/cli/vela_revision_list.md new file mode 100644 index 00000000..6973ed30 --- /dev/null +++ b/versioned_docs/version-v1.3/cli/vela_revision_list.md @@ -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). diff --git a/versioned_docs/version-v1.3/cli/vela_show.md b/versioned_docs/version-v1.3/cli/vela_show.md index 4c7cff40..8a01e8a5 100644 --- a/versioned_docs/version-v1.3/cli/vela_show.md +++ b/versioned_docs/version-v1.3/cli/vela_show.md @@ -40,4 +40,4 @@ show webservice #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_status.md b/versioned_docs/version-v1.3/cli/vela_status.md index d3ecc8e6..397dc07b 100644 --- a/versioned_docs/version-v1.3/cli/vela_status.md +++ b/versioned_docs/version-v1.3/cli/vela_status.md @@ -21,11 +21,15 @@ vela status APP_NAME ### Options ``` - -p, --endpoint show all service endpoints of the application - -e, --env string specify environment name for application - -h, --help help for status - -n, --namespace string specify the Kubernetes namespace to use - -s, --svc string service name + -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 + -e, --env string specify environment name for application + -h, --help help for status + -n, --namespace string specify the Kubernetes namespace to use + -s, --svc string service name + -t, --tree display the application resources into tree structure ``` ### Options inherited from parent commands @@ -41,4 +45,4 @@ vela status APP_NAME #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_trait.md b/versioned_docs/version-v1.3/cli/vela_trait.md index 3d9753b3..8670e942 100644 --- a/versioned_docs/version-v1.3/cli/vela_trait.md +++ b/versioned_docs/version-v1.3/cli/vela_trait.md @@ -43,4 +43,4 @@ vela trait #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_trait_get.md b/versioned_docs/version-v1.3/cli/vela_trait_get.md index 4bf9191c..760fd2a7 100644 --- a/versioned_docs/version-v1.3/cli/vela_trait_get.md +++ b/versioned_docs/version-v1.3/cli/vela_trait_get.md @@ -40,4 +40,4 @@ vela trait get #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_uischema.md b/versioned_docs/version-v1.3/cli/vela_uischema.md index 6969b821..0ae7b9a7 100644 --- a/versioned_docs/version-v1.3/cli/vela_uischema.md +++ b/versioned_docs/version-v1.3/cli/vela_uischema.md @@ -28,4 +28,4 @@ Manage UI schema for addons. #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_uischema_apply.md b/versioned_docs/version-v1.3/cli/vela_uischema_apply.md index 647955f5..492a187d 100644 --- a/versioned_docs/version-v1.3/cli/vela_uischema_apply.md +++ b/versioned_docs/version-v1.3/cli/vela_uischema_apply.md @@ -31,4 +31,4 @@ vela uischema apply [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_uninstall.md b/versioned_docs/version-v1.3/cli/vela_uninstall.md index cd554c31..77fd1293 100644 --- a/versioned_docs/version-v1.3/cli/vela_uninstall.md +++ b/versioned_docs/version-v1.3/cli/vela_uninstall.md @@ -22,6 +22,7 @@ vela uninstall ``` -d, --detail show detail log of installation (default true) + -f, --force force uninstall whole vela include all addons -h, --help help for uninstall -n, --namespace string namespace scope for installing KubeVela Core (default "vela-system") ``` @@ -39,4 +40,4 @@ vela uninstall #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_up.md b/versioned_docs/version-v1.3/cli/vela_up.md index 68439a3e..b61f872b 100644 --- a/versioned_docs/version-v1.3/cli/vela_up.md +++ b/versioned_docs/version-v1.3/cli/vela_up.md @@ -2,23 +2,44 @@ title: vela up --- -Apply an appfile or application from file +Deploy one application ### Synopsis -Create or update vela application from file or URL, both appfile or application object format are supported. +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 up ``` +### Examples + +``` + # Deploy an application from file + vela up -f ./app.yaml + + # Deploy an application with a version name + vela up example-app -n example-ns --publish-version beta + + # Deploy an application using existing revision + vela up example-app -n example-ns --publish-version beta --revision example-app-v2 +``` + ### Options ``` - -e, --env string specify environment name for application - -f, --file string specify file path for appfile or application, it could be a remote url. - -h, --help help for up - -n, --namespace string specify the Kubernetes namespace to use + -e, --env string The environment name for the CLI request + -f, --file string The file path for appfile or application. It could be a remote url. + -h, --help help for up + -n, --namespace string If present, the namespace scope for this CLI request + -v, --publish-version string The publish version for deploying application. + -r, --revision string The revision to use for deploying the application, if empty, the current application configuration will be used. ``` ### Options inherited from parent commands @@ -34,4 +55,4 @@ vela up #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_version.md b/versioned_docs/version-v1.3/cli/vela_version.md index d4c9c375..6d26f558 100644 --- a/versioned_docs/version-v1.3/cli/vela_version.md +++ b/versioned_docs/version-v1.3/cli/vela_version.md @@ -32,4 +32,4 @@ vela version [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_version_list.md b/versioned_docs/version-v1.3/cli/vela_version_list.md index 1a589c2a..44dc8a5f 100644 --- a/versioned_docs/version-v1.3/cli/vela_version_list.md +++ b/versioned_docs/version-v1.3/cli/vela_version_list.md @@ -32,4 +32,4 @@ vela version list [flags] #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_workflow.md b/versioned_docs/version-v1.3/cli/vela_workflow.md index 8db8f452..ace8d357 100644 --- a/versioned_docs/version-v1.3/cli/vela_workflow.md +++ b/versioned_docs/version-v1.3/cli/vela_workflow.md @@ -32,4 +32,4 @@ Operate the Workflow during Application Delivery. #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_workflow_restart.md b/versioned_docs/version-v1.3/cli/vela_workflow_restart.md index 57a77976..00675a0a 100644 --- a/versioned_docs/version-v1.3/cli/vela_workflow_restart.md +++ b/versioned_docs/version-v1.3/cli/vela_workflow_restart.md @@ -39,4 +39,4 @@ vela workflow restart #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_workflow_resume.md b/versioned_docs/version-v1.3/cli/vela_workflow_resume.md index ed71f729..4db4650d 100644 --- a/versioned_docs/version-v1.3/cli/vela_workflow_resume.md +++ b/versioned_docs/version-v1.3/cli/vela_workflow_resume.md @@ -39,4 +39,4 @@ vela workflow resume #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_workflow_rollback.md b/versioned_docs/version-v1.3/cli/vela_workflow_rollback.md index 5546fe47..6355c1dc 100644 --- a/versioned_docs/version-v1.3/cli/vela_workflow_rollback.md +++ b/versioned_docs/version-v1.3/cli/vela_workflow_rollback.md @@ -39,4 +39,4 @@ vela workflow rollback #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_workflow_suspend.md b/versioned_docs/version-v1.3/cli/vela_workflow_suspend.md index ba01ad2d..35bf132f 100644 --- a/versioned_docs/version-v1.3/cli/vela_workflow_suspend.md +++ b/versioned_docs/version-v1.3/cli/vela_workflow_suspend.md @@ -39,4 +39,4 @@ vela workflow suspend #### 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). diff --git a/versioned_docs/version-v1.3/cli/vela_workflow_terminate.md b/versioned_docs/version-v1.3/cli/vela_workflow_terminate.md index 478dd325..eed5a4a9 100644 --- a/versioned_docs/version-v1.3/cli/vela_workflow_terminate.md +++ b/versioned_docs/version-v1.3/cli/vela_workflow_terminate.md @@ -39,4 +39,4 @@ vela workflow terminate #### 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). diff --git a/versioned_docs/version-v1.3/contributor/overview.md b/versioned_docs/version-v1.3/contributor/overview.md new file mode 100644 index 00000000..1e1f3e14 --- /dev/null +++ b/versioned_docs/version-v1.3/contributor/overview.md @@ -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! diff --git a/versioned_docs/version-v1.3/platform-engineers/addon/intro.md b/versioned_docs/version-v1.3/platform-engineers/addon/intro.md index f72318bd..5624c182 100644 --- a/versioned_docs/version-v1.3/platform-engineers/addon/intro.md +++ b/versioned_docs/version-v1.3/platform-engineers/addon/intro.md @@ -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. diff --git a/versioned_docs/version-v1.3/reference/ui-schema.md b/versioned_docs/version-v1.3/reference/ui-schema.md index 0413504b..25e1d31b 100644 --- a/versioned_docs/version-v1.3/reference/ui-schema.md +++ b/versioned_docs/version-v1.3/reference/ui-schema.md @@ -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. diff --git a/versioned_docs/version-v1.3/resources/config-image-registry.jpg b/versioned_docs/version-v1.3/resources/config-image-registry.jpg index 9978f3f2..4046cc6d 100644 Binary files a/versioned_docs/version-v1.3/resources/config-image-registry.jpg and b/versioned_docs/version-v1.3/resources/config-image-registry.jpg differ diff --git a/versioned_docs/version-v1.3/resources/vela-overview.jpg b/versioned_docs/version-v1.3/resources/vela-overview.jpg index 0ad4d5da..881d5097 100644 Binary files a/versioned_docs/version-v1.3/resources/vela-overview.jpg and b/versioned_docs/version-v1.3/resources/vela-overview.jpg differ diff --git a/versioned_sidebars/version-v1.3-sidebars.json b/versioned_sidebars/version-v1.3-sidebars.json index d088b29c..f7adde98 100644 --- a/versioned_sidebars/version-v1.3-sidebars.json +++ b/versioned_sidebars/version-v1.3-sidebars.json @@ -533,6 +533,10 @@ } ] }, + { + "type": "doc", + "id": "version-v1.3/contributor/overview" + }, { "collapsed": true, "type": "category",