Update docs to v1.10 and add versioning of definitions
Signed-off-by: Chaitanya Reddy Onteddu <chaitanyareddy0702@gmail.com>
This commit is contained in:
Shivin Gopalani
Chaitanya Reddy Onteddu
parent
52a72ac601
commit
34d5a0c949
|
|
@ -0,0 +1,145 @@
|
|||
---
|
||||
title: Definition Version Control
|
||||
---
|
||||
|
||||
## Introduction
|
||||
KubeVela supports Semantic Versioning for all types of [Definitions](../getting-started/definition), providing control over which versions of Definitions are used in Applications. This feature enables to specify exact version or version range for Definitions, enforce Semantic Versioning, and manage automatic upgrades of Definitions within KubeVela Applications.
|
||||
|
||||
## Feature Overview
|
||||
1. Semantic Versioning for Definition
|
||||
|
||||
Definition versions are defined using Semantic Versioning, which follows the format MAJOR.MINOR.PATCH. This ensures control over how components evolve.
|
||||
|
||||
2. Auto-Upgrade Control
|
||||
|
||||
KubeVela allows control over whether Applications automatically upgrade to newer Definition versions when they are available. The `app.oam.dev/autoUpdate` annotation is used to enable or disable auto-upgrade behavior.
|
||||
|
||||
- Auto-update enabled: The application automatically uses the latest compatible version of a Definition.
|
||||
- Auto-update disabled: The application sticks to the specified version even if a new version of the Definition is released.
|
||||
|
||||
3. Version Range Control
|
||||
|
||||
You can specify either an exact version or a version range for Definition in your application. If a version range is used, KubeVela will select the latest version that fits within the range.
|
||||
|
||||
```
|
||||
Note: If `app.oam.dev/autoUpdate annotation` is set to `false` or not specified in application, the application will use explicitly specified specified or latest component version.
|
||||
```
|
||||
|
||||
## User Guide
|
||||
1. Create a `configmap-component` ComponentDefinition with `1.2.5` version
|
||||
```
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: ComponentDefinition
|
||||
metadata:
|
||||
name: configmap-component
|
||||
namespace: vela-system
|
||||
spec:
|
||||
version: 1.2.5 # Specify the component version using Semantic Versioning
|
||||
schematic:
|
||||
cue:
|
||||
template: |
|
||||
output: {
|
||||
apiVersion: "v1"
|
||||
kind: "ConfigMap"
|
||||
metadata: {
|
||||
name: "comptest"
|
||||
}
|
||||
data: {
|
||||
version: "125"
|
||||
}
|
||||
}
|
||||
|
||||
workload:
|
||||
definition:
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
```
|
||||
|
||||
2. Create a `configmap-component` ComponentDefinition with `2.0.5` version
|
||||
```apiVersion: core.oam.dev/v1beta1
|
||||
kind: ComponentDefinition
|
||||
metadata:
|
||||
name: configmap-component
|
||||
namespace: vela-system
|
||||
spec:
|
||||
version: 2.5.0 # Specify the component version using Semantic Versioning
|
||||
schematic:
|
||||
cue:
|
||||
template: |
|
||||
output: {
|
||||
apiVersion: "v1"
|
||||
kind: "ConfigMap"
|
||||
metadata: {
|
||||
name: "comptest"
|
||||
}
|
||||
data: {
|
||||
version: "250"
|
||||
}
|
||||
}
|
||||
|
||||
workload:
|
||||
definition:
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
```
|
||||
3. List the DefinitionRevisions.
|
||||
```
|
||||
kubectl get definitionrevision -n vela-system | grep -i my-component
|
||||
my-component-v1.2.5 1 1a4f3ac77e4fcfef Component
|
||||
my-component-v2.5.0 2 e61e9b5e55b01c2b Component
|
||||
```
|
||||
|
||||
4. Create Application using `configmap-component@v1.2` version and enable the Auto Update using `app.oam.dev/autoUpdate` annotation.
|
||||
```apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: test-app
|
||||
namespace: test
|
||||
annotations:
|
||||
app.oam.dev/autoUpdate: "true" # Enable automatic upgrades
|
||||
spec:
|
||||
components:
|
||||
- name: test-configmap
|
||||
type: my-component@v1 # Use the latest version in the 'v1' range
|
||||
```
|
||||
|
||||
Expected Behavior:
|
||||
- Application will use `configmap-component@v1.2.5`, as `1.2.5` is highest version in specified range(`1`).
|
||||
|
||||
6. Create a `configmap-component` ComponentDefinition with `1.2.7` version
|
||||
```
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: ComponentDefinition
|
||||
metadata:
|
||||
name: configmap-component
|
||||
namespace: vela-system
|
||||
spec:
|
||||
version: 1.2.7 # Specify the component version using Semantic Versioning
|
||||
schematic:
|
||||
cue:
|
||||
template: |
|
||||
output: {
|
||||
apiVersion: "v1"
|
||||
kind: "ConfigMap"
|
||||
metadata: {
|
||||
name: "comptest"
|
||||
}
|
||||
data: {
|
||||
version: "127"
|
||||
}
|
||||
}
|
||||
|
||||
workload:
|
||||
definition:
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
```
|
||||
Expected Behavior:
|
||||
- After the Application is reconciled, it will use `configmap-component@v1.2.7`, as `1.2.7` is the latest version within the specified range (1).
|
||||
|
||||
7. List the DefinitionRevisions.
|
||||
```kubectl get definitionrevision -n vela-system | grep -i my-component
|
||||
my-component-v1.2.5 1 1a4f3ac77e4fcfef Component
|
||||
my-component-v1.2.7 3 86d7fb1a36566dea Component
|
||||
my-component-v2.5.0 2 e61e9b5e55b01c2b Component
|
||||
````
|
||||
|
|
@ -31,7 +31,7 @@ module.exports = {
|
|||
id: 'start',
|
||||
content:
|
||||
'<div class="header-item">⭐️ If you like KubeVela, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela">GitHub</a>!⭐️</div>' +
|
||||
'<div class="header-item"><span>KubeVela v1.9.0 is now available.(2023-06-15)</span> <a target="_blank" style="color: var(--ifm-color-primary)" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela/releases/tag/v1.9.0">Read Release Note</a></div>',
|
||||
'<div class="header-item"><span>KubeVela v1.10.0 is now available.(2025-02-06)</span> <a target="_blank" style="color: var(--ifm-color-primary)" rel="noopener noreferrer" href="https://github.com/kubevela/kubevela/releases/tag/v1.10.0">Read Release Note</a></div>',
|
||||
},
|
||||
algolia: {
|
||||
appId: 'PXMFHFWUGZ',
|
||||
|
|
|
|||
|
|
@ -0,0 +1,358 @@
|
|||
{
|
||||
"version.label": {
|
||||
"message": "v1.10",
|
||||
"description": "The label for version current"
|
||||
},
|
||||
"sidebar.docs.category.Getting Started": {
|
||||
"message": "快速开始",
|
||||
"description": "The label for category Getting Started in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Core Concepts": {
|
||||
"message": "核心概念",
|
||||
"description": "The label for Core Concepts in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Manage Definition with CUE": {
|
||||
"message": "使用 CUE 扩展模块定义",
|
||||
"description": "The label for category Learning CUE in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Helm": {
|
||||
"message": "Helm",
|
||||
"description": "The label for category Helm in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Raw Template": {
|
||||
"message": "Raw Template",
|
||||
"description": "The label for category Raw Template in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Traits System": {
|
||||
"message": "运维特征系统",
|
||||
"description": "The label for category Traits System in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Defining Cloud Service": {
|
||||
"message": "定义 Cloud Service",
|
||||
"description": "The label for category Defining Cloud Service in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Hands-on Lab": {
|
||||
"message": "实践实验室",
|
||||
"description": "The label for category Hands-on Lab in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Authentication and Authorization": {
|
||||
"message": "认证和授权",
|
||||
"description": "The label for category Authentication and Authorization in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Conventions": {
|
||||
"message": "开发规约",
|
||||
"description": "KubeVela developer Conventions"
|
||||
},
|
||||
"sidebar.docs.category.Application Deployment": {
|
||||
"message": "Application Deployment",
|
||||
"description": "The label for category Application Deployment in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.More Operations": {
|
||||
"message": "更多操作",
|
||||
"description": "The label for category More Operations in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Platform Operation Guide": {
|
||||
"message": "Platform Operation Guide",
|
||||
"description": "The label for category Platform Operation Guide in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Using KubeVela CLI": {
|
||||
"message": "使用命令行工具",
|
||||
"description": "The label for category Using KubeVela CLI in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Managing Applications": {
|
||||
"message": "管理应用",
|
||||
"description": "The label for category Managing Applications in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.References": {
|
||||
"message": "参考手册",
|
||||
"description": "The label for category References in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Learning OAM": {
|
||||
"message": "开放应用模型",
|
||||
"description": "The label for category Learning OAM in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Environment System": {
|
||||
"message": "交付环境系统",
|
||||
"description": "The label for category Environment System in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Designing Workflow": {
|
||||
"message": "设计交付工作流",
|
||||
"description": "The label for category Workflow End User in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Install": {
|
||||
"message": "安装",
|
||||
"description": "The label for category Install in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.doc.Deliver First Application": {
|
||||
"message": "交付第一个应用",
|
||||
"description": "The label for doc deliver-first-app in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Continuous Delivery": {
|
||||
"message": "持续交付",
|
||||
"description": "The label for category Continuous Delivery in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Manage Your Application": {
|
||||
"message": "管理你的应用",
|
||||
"description": "The label for category Manage Your Application in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Workflow System": {
|
||||
"message": "工作流系统",
|
||||
"description": "The label for category Workflow System in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Patch and Override": {
|
||||
"message": "配置覆盖",
|
||||
"description": "The label for category Patch and Override in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Operator Manual": {
|
||||
"message": "运维手册",
|
||||
"description": "The label for category Operator Manual in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Customize Traits": {
|
||||
"message": "自定义运维特征",
|
||||
"description": "The label for category Customize Traits in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Customize Components": {
|
||||
"message": "自定义组件",
|
||||
"description": "The label for category Customize Traits in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.CLI": {
|
||||
"message": "CLI 命令行",
|
||||
"description": "The label for category CLI in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Capabilities": {
|
||||
"message": "Capabilities",
|
||||
"description": "The label for category Capabilities in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Appendix": {
|
||||
"message": "附录",
|
||||
"description": "The label for category Appendix in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Component System": {
|
||||
"message": "组件系统",
|
||||
"description": "The label for category Component System in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Vela CLI Manuals": {
|
||||
"message": "Vela CLI 手册",
|
||||
"description": "The label for category Vela CLI Manuals in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Deploying Components": {
|
||||
"message": "选择待交付组件",
|
||||
"description": "The label for category Components in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Attaching Traits": {
|
||||
"message": "绑定运维特征",
|
||||
"description": "The label for category Traits in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Defining Policies": {
|
||||
"message": "设定应用策略",
|
||||
"description": "The label for category Policies in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Best Practices": {
|
||||
"message": "最佳实践",
|
||||
"description": "The label for category case studies in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Observability": {
|
||||
"message": "可观测性",
|
||||
"description": "The label for category Observability in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Scaling": {
|
||||
"message": "扩缩容",
|
||||
"description": "The label for category Scaler in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Debugging": {
|
||||
"message": "调试指南",
|
||||
"description": "The label for category Debugging in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Extension": {
|
||||
"message": "平台扩展",
|
||||
"description": "平台扩展参考文档"
|
||||
},
|
||||
"sidebar.docs.category.Contribution Guide": {
|
||||
"message": "贡献指南",
|
||||
"description": "平台扩展参考文档"
|
||||
},
|
||||
"sidebar.docs.category.Simple Template": {
|
||||
"message": "Simple Template",
|
||||
"description": "The label for category Simple Template in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Cloud Services": {
|
||||
"message": "云服务组件",
|
||||
"description": "The label for category Cloud Services in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.CUE": {
|
||||
"message": "CUE 组件",
|
||||
"description": "The label for category CUE Components in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Addons": {
|
||||
"message": "插件系统",
|
||||
"description": "The extended add-ons"
|
||||
},
|
||||
"sidebar.docs.category.Tutorials": {
|
||||
"message": "实践教程",
|
||||
"description": "KubeVela 实践教程"
|
||||
},
|
||||
"sidebar.docs.category.How-to Guides": {
|
||||
"message": "操作手册",
|
||||
"description": "CLI 和 Dashboard 的操作指导手册"
|
||||
},
|
||||
"sidebar.docs.category.Deploy applications": {
|
||||
"message": "交付应用",
|
||||
"description": "通过 Dashboard 对应用的管理操作说明"
|
||||
},
|
||||
"sidebar.docs.category.Manage traits": {
|
||||
"message": "运维特征管理",
|
||||
"description": "通过 Dashboard 对应用的运维特征管理操作说明"
|
||||
},
|
||||
"sidebar.docs.category.Manage workflows": {
|
||||
"message": "工作流管理",
|
||||
"description": "通过 Dashboard 对应用的工作流管理操作说明"
|
||||
},
|
||||
"sidebar.docs.category.Manage triggers": {
|
||||
"message": "触发器管理",
|
||||
"description": "通过 Dashboard 对应用触发器的管理操作说明"
|
||||
},
|
||||
"sidebar.docs.category.Manage Config of Integration": {
|
||||
"message": "集成配置管理",
|
||||
"description": "外部系统集成相关配置的管理说明"
|
||||
},
|
||||
"sidebar.docs.category.Cluster Management": {
|
||||
"message": "资源管理",
|
||||
"description": "管理集群和交付目标等资源"
|
||||
},
|
||||
"sidebar.docs.category.Community Verified Addons": {
|
||||
"message": "社区认证插件",
|
||||
"description": "内置插件说明"
|
||||
},
|
||||
"sidebar.docs.category.Cloud Resources": {
|
||||
"message": "云资源",
|
||||
"description": "云资源"
|
||||
},
|
||||
"sidebar.docs.category.Supported Cloud Resource": {
|
||||
"message": "支持的云资源",
|
||||
"description": "支持的云资源列表"
|
||||
},
|
||||
"sidebar.docs.category.Built-in Component Type": {
|
||||
"message": "内置组件",
|
||||
"description": "内置组件列表"
|
||||
},
|
||||
"sidebar.docs.category.Built-in Trait Type": {
|
||||
"message": "内置运维特征",
|
||||
"description": "内置运维特征列表"
|
||||
},
|
||||
"sidebar.docs.category.Built-in Policy Type": {
|
||||
"message": "内置策略",
|
||||
"description": "内置策略列表"
|
||||
},
|
||||
"sidebar.docs.category.Custom Addons": {
|
||||
"message": "自定义插件",
|
||||
"description": "自定义插件"
|
||||
},
|
||||
"sidebar.docs.category.Multi-Cluster Delivery": {
|
||||
"message": "多集群交付",
|
||||
"description": "多集群交付"
|
||||
},
|
||||
"sidebar.docs.category.Day-2 Operations": {
|
||||
"message": "应用运维",
|
||||
"description": "应用运维"
|
||||
},
|
||||
"sidebar.docs.category.Advanced Features": {
|
||||
"message": "其他高级功能",
|
||||
"description": "其他高级功能"
|
||||
},
|
||||
"sidebar.docs.category.Artifacts": {
|
||||
"message": "交付制品",
|
||||
"description": "多样化交付制品"
|
||||
},
|
||||
"sidebar.docs.category.User Guide": {
|
||||
"message": "用户手册",
|
||||
"description": "引导用户学习使用 KubeVela 各项特性"
|
||||
},
|
||||
"sidebar.docs.category.Install or upgrade": {
|
||||
"message": "平台安装或升级手册",
|
||||
"description": "详细解读平台的各种部署方式"
|
||||
},
|
||||
"sidebar.docs.category.How-to manage the cloud resources": {
|
||||
"message": "云服务管理",
|
||||
"description": "提供云服务的使用和管理相关能力说明"
|
||||
},
|
||||
"sidebar.docs.category.How-to manage the applications": {
|
||||
"message": "应用基础管理",
|
||||
"description": "提供基础管理能力说明"
|
||||
},
|
||||
"sidebar.docs.category.CI Integration": {
|
||||
"message": "CI 集成",
|
||||
"description": "CI 集成"
|
||||
},
|
||||
"sidebar.docs.category.Developer Guide": {
|
||||
"message": "开发者手册",
|
||||
"description": "developer guide for sidebar"
|
||||
},
|
||||
"sidebar.docs.category.User Management": {
|
||||
"message": "用户管理",
|
||||
"description": "User management for sidebar"
|
||||
},
|
||||
"sidebar.docs.category.Advanced Installation": {
|
||||
"message": "高级安装",
|
||||
"description": "Advanced Installation for sidebar"
|
||||
},
|
||||
"sidebar.docs.category.Helm Chart CD": {
|
||||
"message": "Helm Chart 交付"
|
||||
},
|
||||
"sidebar.docs.category.Container Image CD": {
|
||||
"message": "容器镜像交付"
|
||||
},
|
||||
"sidebar.docs.category.Cloud Resources CD": {
|
||||
"message": "云资源交付"
|
||||
},
|
||||
"sidebar.docs.category.Manage Database": {
|
||||
"message": "数据库管理"
|
||||
},
|
||||
"sidebar.docs.category.Kubernetes Manifest CD": {
|
||||
"message": "Kubernetes 资源交付"
|
||||
},
|
||||
"sidebar.docs.category.Application Policies": {
|
||||
"message": "应用管理策略"
|
||||
},
|
||||
"sidebar.docs.category.UX Customization": {
|
||||
"message": "定制 UI"
|
||||
},
|
||||
"sidebar.docs.category.Declarative Workflow": {
|
||||
"message": "声明式工作流"
|
||||
},
|
||||
"sidebar.docs.category.Application Workflow": {
|
||||
"message": "应用工作流"
|
||||
},
|
||||
"sidebar.docs.category.Pipeline": {
|
||||
"message": "流水线"
|
||||
},
|
||||
"sidebar.docs.category.K8S API for Pipeline": {
|
||||
"message": "流水线的 K8S API"
|
||||
},
|
||||
"sidebar.docs.category.Multi Cluster Delivery": {
|
||||
"message": "多集群交付"
|
||||
},
|
||||
"sidebar.docs.doc.Standalone": {
|
||||
"message": "无依赖独立安装"
|
||||
},
|
||||
"sidebar.docs.category.Installation": {
|
||||
"message": "安装"
|
||||
},
|
||||
"sidebar.docs.doc.Kubernetes": {
|
||||
"message": "基于 Kubernetes 安装"
|
||||
},
|
||||
"sidebar.docs.category.Registry Integration": {
|
||||
"message": "注册中心集成"
|
||||
},
|
||||
"sidebar.docs.category.Multi Environment Delivery": {
|
||||
"message": "多环境交付"
|
||||
},
|
||||
"sidebar.docs.category.Automated Observability": {
|
||||
"message": "自动化可观测"
|
||||
},
|
||||
"sidebar.docs.category.Config Management": {
|
||||
"message": "配置管理"
|
||||
},
|
||||
"sidebar.docs.category.Production Precautions": {
|
||||
"message": "生产使用注意点"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,235 @@
|
|||
---
|
||||
title: Application CRD
|
||||
---
|
||||
|
||||
本部分将逐步介绍如何使用 `Application` 对象来定义你的应用，并以声明式的方式进行相应的操作。
|
||||
|
||||
## 示例
|
||||
|
||||
下面的示例应用声明了一个具有 *Worker* 工作负载类型的 `backend` 组件和具有 *Web Service* 工作负载类型的 `frontend` 组件。
|
||||
|
||||
此外，`frontend`组件声明了具有 `sidecar` 和 `autoscaler` 的 `trait` 运维能力，这意味着工作负载将自动注入 `fluentd` 的sidecar，并可以根据CPU使用情况触发1-10个副本进行扩展。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: website
|
||||
spec:
|
||||
components:
|
||||
- name: backend
|
||||
type: worker
|
||||
properties:
|
||||
image: busybox
|
||||
cmd:
|
||||
- sleep
|
||||
- '1000'
|
||||
- name: frontend
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
traits:
|
||||
- type: autoscaler
|
||||
properties:
|
||||
min: 1
|
||||
max: 10
|
||||
cpuPercent: 60
|
||||
- type: sidecar
|
||||
properties:
|
||||
name: "sidecar-test"
|
||||
image: "fluentd"
|
||||
```
|
||||
|
||||
### 部署应用
|
||||
|
||||
部署上述的 application yaml文件, 然后应用启动
|
||||
|
||||
```shell
|
||||
$ kubectl get application -o yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: website
|
||||
....
|
||||
status:
|
||||
components:
|
||||
- apiVersion: core.oam.dev/v1alpha2
|
||||
kind: Component
|
||||
name: backend
|
||||
- apiVersion: core.oam.dev/v1alpha2
|
||||
kind: Component
|
||||
name: frontend
|
||||
....
|
||||
status: running
|
||||
|
||||
```
|
||||
|
||||
你可以看到一个命名为 `frontend` 并带有被注入的容器 `fluentd` 的 Deployment 正在运行。
|
||||
|
||||
```shell
|
||||
$ kubectl get deploy frontend
|
||||
NAME READY UP-TO-DATE AVAILABLE AGE
|
||||
frontend 1/1 1 1 100m
|
||||
```
|
||||
|
||||
另一个命名为 `backend` 的 Deployment 也在运行。
|
||||
|
||||
```shell
|
||||
$ kubectl get deploy backend
|
||||
NAME READY UP-TO-DATE AVAILABLE AGE
|
||||
backend 1/1 1 1 100m
|
||||
```
|
||||
|
||||
同样被 `autoscaler` trait 创建出来的还有一个 HPA 。
|
||||
|
||||
```shell
|
||||
$ kubectl get HorizontalPodAutoscaler frontend
|
||||
NAME REFERENCE TARGETS MINPODS MAXPODS REPLICAS AGE
|
||||
frontend Deployment/frontend <unknown>/50% 1 10 1 101m
|
||||
```
|
||||
|
||||
|
||||
## 背后的原理
|
||||
|
||||
在上面的示例中, `type: worker` 指的是该组件的字段内容（即下面的 `properties` 字段中的内容）将遵从名为 `worker` 的 `ComponentDefinition` 对象中的规范定义，如下所示：
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: ComponentDefinition
|
||||
metadata:
|
||||
name: worker
|
||||
annotations:
|
||||
definition.oam.dev/description: "Describes long-running, scalable, containerized services that running at backend. They do NOT have network endpoint to receive external network traffic."
|
||||
spec:
|
||||
workload:
|
||||
definition:
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
schematic:
|
||||
cue:
|
||||
template: |
|
||||
output: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
spec: {
|
||||
selector: matchLabels: {
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
template: {
|
||||
metadata: labels: {
|
||||
"app.oam.dev/component": context.name
|
||||
}
|
||||
spec: {
|
||||
containers: [{
|
||||
name: context.name
|
||||
image: parameter.image
|
||||
|
||||
if parameter["cmd"] != _|_ {
|
||||
command: parameter.cmd
|
||||
}
|
||||
}]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
parameter: {
|
||||
image: string
|
||||
cmd?: [...string]
|
||||
}
|
||||
```
|
||||
|
||||
因此，`backend` 的 `properties` 部分仅支持两个参数：`image` 和 `cmd`。这是由定义的 `.spec.template` 字段中的 `parameter` 列表执行的。
|
||||
|
||||
类似的可扩展抽象机制也同样适用于 traits(运维能力)。
|
||||
例如，`frontend` 中的 `type：autoscaler` 指的是组件对应的 trait 的字段规范（即 trait 的 `properties` 部分）
|
||||
将由名为 `autoscaler` 的 `TraitDefinition` 对象执行，如下所示：
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: TraitDefinition
|
||||
metadata:
|
||||
annotations:
|
||||
definition.oam.dev/description: "configure k8s HPA for Deployment"
|
||||
name: hpa
|
||||
spec:
|
||||
appliesToWorkloads:
|
||||
- webservice
|
||||
- worker
|
||||
schematic:
|
||||
cue:
|
||||
template: |
|
||||
outputs: hpa: {
|
||||
apiVersion: "autoscaling/v2beta2"
|
||||
kind: "HorizontalPodAutoscaler"
|
||||
metadata: name: context.name
|
||||
spec: {
|
||||
scaleTargetRef: {
|
||||
apiVersion: "apps/v1"
|
||||
kind: "Deployment"
|
||||
name: context.name
|
||||
}
|
||||
minReplicas: parameter.min
|
||||
maxReplicas: parameter.max
|
||||
metrics: [{
|
||||
type: "Resource"
|
||||
resource: {
|
||||
name: "cpu"
|
||||
target: {
|
||||
type: "Utilization"
|
||||
averageUtilization: parameter.cpuUtil
|
||||
}
|
||||
}
|
||||
}]
|
||||
}
|
||||
}
|
||||
parameter: {
|
||||
min: *1 | int
|
||||
max: *10 | int
|
||||
cpuUtil: *50 | int
|
||||
}
|
||||
```
|
||||
|
||||
应用同样有一个`sidecar`的运维能力
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: TraitDefinition
|
||||
metadata:
|
||||
annotations:
|
||||
definition.oam.dev/description: "add sidecar to the app"
|
||||
name: sidecar
|
||||
spec:
|
||||
appliesToWorkloads:
|
||||
- webservice
|
||||
- worker
|
||||
schematic:
|
||||
cue:
|
||||
template: |-
|
||||
patch: {
|
||||
// +patchKey=name
|
||||
spec: template: spec: containers: [parameter]
|
||||
}
|
||||
parameter: {
|
||||
name: string
|
||||
image: string
|
||||
command?: [...string]
|
||||
}
|
||||
```
|
||||
|
||||
在业务用户使用之前，我们认为所有用于定义的对象（Definition Object）都已经由平台团队声明并安装完毕了。所以，业务用户将需要专注于应用（`Application`）本身。
|
||||
|
||||
请注意，KubeVela 的终端用户（业务研发）不需要了解定义对象，他们只需要学习如何使用平台已经安装的能力，这些能力通常还可以被可视化的表单展示出来（或者通过 JSON schema 对接其他方式）。请从[由定义生成前端表单](/docs/platform-engineers/openapi-v3-json-schema)部分的文档了解如何实现。
|
||||
|
||||
### 惯例和"标准协议"
|
||||
|
||||
在应用（`Application` 资源）部署到 Kubernetes 集群后，KubeVela 运行时将遵循以下 “标准协议”和惯例来生成和管理底层资源实例。
|
||||
|
||||
|
||||
| Label | 描述 |
|
||||
| :--: | :---------: |
|
||||
|`workload.oam.dev/type=<component definition name>` | 其对应 `ComponentDefinition` 的名称 |
|
||||
|`trait.oam.dev/type=<trait definition name>` | 其对应 `TraitDefinition` 的名称 |
|
||||
|`app.oam.dev/name=<app name>` | 它所属的应用的名称 |
|
||||
|`app.oam.dev/component=<component name>` | 它所属的组件的名称 |
|
||||
|`trait.oam.dev/resource=<name of trait resource instance>` | 运维能力资源实例的名称 |
|
||||
|`app.oam.dev/appRevision=<name of app revision>` | 它所属的应用revision的名称 |
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: 概览
|
||||
---
|
||||
|
||||
GitOps 是一种现代化的持续交付手段，它允许开发人员通过直接更改 Git 仓库中的代码和配置来自动部署应用，在提高部署生产力的同时也通过分支回滚等能力提高了可靠性。其具体的好处可以查看[这篇文章](https://www.weave.works/blog/what-is-gitops-really)，本文将不再赘述。
|
||||
|
||||
KubeVela 作为一个声明式的应用交付控制平面，天然就可以以 GitOps 的方式进行使用，并且这样做会在 GitOps 的基础上为用户提供更多的益处和端到端的体验，包括：
|
||||
- 应用交付工作流（CD 流水线）
|
||||
- 即：KubeVela 支持在 GitOps 模式中描述过程式的应用交付，而不只是简单的声明终态；
|
||||
- 处理部署过程中的各种[依赖关系](../end-user/workflow/component-dependency-parameter.md)和拓扑结构；
|
||||
- 在现有各种 GitOps 工具的语义之上提供[统一的上层抽象](../getting-started/core-concept.md)，简化应用交付与管理过程；
|
||||
- 统一进行[云服务的声明](../tutorials/consume-cloud-services.md)、部署和服务绑定；
|
||||
- 提供开箱即用的交付策略（金丝雀、蓝绿发布等）；
|
||||
- 提供开箱即用的混合云/多云部署策略（放置规则、集群过滤规则等）；
|
||||
- 在多环境交付中提供 Kustomize 风格的 Patch 来描述部署差异，而无需学习任何 Kustomize 本身的细节；
|
||||
- …… 以及更多。
|
||||
|
||||
在接下来的章节中，我们会介绍使用 KubeVela 做 GitOps 的流程，有可以选择下面的插件之一来做 GitOps：
|
||||
|
||||
- [使用 FluxCD 做 GitOps](../end-user/gitops/fluxcd.md)
|
||||
|
||||
除了使用上述插件，最终用户也可以自己集成任意的 GitOps 工具来监听 Git 仓库中的 KubeVela Application 配置。
|
||||
|
|
@ -0,0 +1,349 @@
|
|||
---
|
||||
title: 一键创建/销毁环境
|
||||
---
|
||||
|
||||
本章将介绍如何使用 KubeVela 在交付应用时对环境进行快速初始化和销毁。
|
||||
|
||||
## 环境指什么？
|
||||
|
||||
一个应用开发团队通常需要做一些初始化工作来满足应用部署时方方面面的需要，即“初始化环境”。
|
||||
这里的环境是一个逻辑概念，既可以表示应用部署时依赖的公共资源，也可以表示应用运行必要的准备工作。
|
||||
|
||||
KubeVela 可以使用 Application 对象做环境的初始化，可以初始化的资源类型包括但不限于下列类型：
|
||||
|
||||
1. 一个或多个 Kubernetes 集群，不同的环境可能需要不同规模和不同版本的 Kubernetes 集群。同时环境初始化还可以将多个 Kubernetes 集群注册到一个中央集群进行统一的多集群管控。
|
||||
|
||||
2. 任意类型的 Kubernetes 自定义资源（CRD）和系统插件，一个环境会拥有很多种不同的自定义资源来提供系统能力，比如不同的工作负载、不同的运维管理功能等等。初始化环境可以包含环境所依赖的一系列功能的初始化安装，比如各类中间件工作负载、流量管理、日志监控等各类运维系统。
|
||||
|
||||
3. 各类共享资源和服务，一个微服务在不同环境中测试验证时，除了自身所开发的组件以外，往往还会包含一系列其他团队维护的组件和一些公共资源。环境初始化功能可以将其他组件和公共资源统一部署，在无需使用时销毁。这些共享资源可以是一个微服务组件、云数据库、缓存、负载均衡、API网关等等。
|
||||
|
||||
4. 各类管理策略和流程，一个环境可能会配备不同的全局策略和流程，举例来说，环境策略可能会包括混沌测试、安全扫描、错误配置检测、SLO指标等等；而流程则可以是初始化一个数据库表、注册一个自动发现配置等。
|
||||
|
||||
不仅如此，KubeVela 的环境初始化能力还可以跟工作流、策略、依赖等功能相结合，做不同环境的差异化部署，依赖管理等。
|
||||
|
||||
若不同环境初始化存在依赖关系，可以初始化的公共资源分离出一个单独的 Application 作为依赖，这样可以形成可以被复用的初始化模块。
|
||||
例如，测试环境和开发环境都依赖了一些相同的控制器，可以将这些控制器提取出来作为单独的环境初始化，在开发环境和测试环境中都指定依赖该环境初始化。
|
||||
|
||||
## 如何使用
|
||||
|
||||
### 直接使用应用部署计划完成环境初始化
|
||||
|
||||
> 请确保你的 KubeVela 版本在 v1.1.6 及以上。
|
||||
|
||||
如果我们希望在环境中使用一个自定义 CRD 控制器(如 [OpenKruise](https://github.com/openkruise/kruise))，那么，我们可以使用 Helm 组件初始化 kruise。
|
||||
|
||||
我们可以直接使用 KubeVela 的应用部署计划来初始化 kruise 的环境，该应用会帮你在集群中部署一个 OpenKruise 的控制器，给集群提供 kruise 的各种能力。
|
||||
|
||||
由于我们使用 Helm 组件完成 kruise 的部署，我们首先要在集群中使用 [`FluxCD` 插件](https://kubevela.net/docs/reference/addons/fluxcd)开启 helm 功能。
|
||||
当环境初始化具备多个模块时，可以对初始化的内容进行拆分，同时使用工作流的 `depends-on-app` 步骤，描述不同初始化模块的依赖关系。
|
||||
比如我们可以在这个例子里，使用 `depends-on-app` 表示环境初始化 kruise 依赖环境初始化 `addon-fluxcd` 提供的能力。同时，使用 `apply-once` 策略来确保资源只会部署一次来完成初始化。
|
||||
|
||||
> `depends-on-app` 会根据 `properties` 中的 `name` 及 `namespace`，去查询集群中是否存在对应的应用。
|
||||
如果应用存在，则当该应用的状态可用时，才会进行下一个步骤；
|
||||
若该应用不存在，则会去查询同名的 configMap，从中读取出应用的配置并部署到集群中。
|
||||
> 更详细的说明，请查看 [depends-on-app](../end-user/workflow/built-in-workflow-defs.md#depends-on-app)。
|
||||
|
||||
部署如下文件：
|
||||
|
||||
```shell
|
||||
cat <<EOF | vela up -f -
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: kruise
|
||||
namespace: vela-system
|
||||
spec:
|
||||
components:
|
||||
- name: kruise
|
||||
type: helm
|
||||
properties:
|
||||
repoType: helm
|
||||
url: https://openkruise.github.io/charts/
|
||||
chart: kruise
|
||||
version: 1.2.0
|
||||
git:
|
||||
branch: master
|
||||
values:
|
||||
featureGates: PreDownloadImageForInPlaceUpdate=true
|
||||
policies:
|
||||
- name: apply-once
|
||||
type: apply-once
|
||||
properties:
|
||||
enable: true
|
||||
workflow:
|
||||
steps:
|
||||
- name: check-flux
|
||||
type: depends-on-app
|
||||
properties:
|
||||
name: addon-fluxcd
|
||||
namespace: vela-system
|
||||
- name: apply-kruise
|
||||
type: apply-component
|
||||
properties:
|
||||
component: kruise
|
||||
EOF
|
||||
```
|
||||
|
||||
查看集群中应用的状态：
|
||||
|
||||
```shell
|
||||
vela status kruise -n vela-system
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>期望输出</summary>
|
||||
|
||||
```console
|
||||
About:
|
||||
|
||||
Name: kruise
|
||||
Namespace: vela-system
|
||||
Created at: 2022-10-31 18:10:27 +0800 CST
|
||||
Status: running
|
||||
|
||||
Workflow:
|
||||
|
||||
mode: StepByStep-DAG
|
||||
finished: true
|
||||
Suspend: false
|
||||
Terminated: false
|
||||
Steps
|
||||
- id: l6apfsi5c2
|
||||
name: check-flux
|
||||
type: depends-on-app
|
||||
phase: succeeded
|
||||
- id: p2nqell47w
|
||||
name: apply-kruise
|
||||
type: apply-component
|
||||
phase: succeeded
|
||||
|
||||
Services:
|
||||
|
||||
- Name: kruise
|
||||
Cluster: local Namespace: vela-system
|
||||
Type: helm
|
||||
Healthy Fetch repository successfully, Create helm release successfully
|
||||
No trait applied
|
||||
```
|
||||
</details>
|
||||
|
||||
kruise 已经成功运行！之后，你可以在环境中使用 kruise 的能力。如果需要配置新的环境初始化，也只需要类似的定义一个部署计划。
|
||||
|
||||
### 在应用部署中加入初始化的工作流
|
||||
|
||||
在环境中，一些通用的 ConfigMap / PVC 等资源是十分常用的。
|
||||
如果你希望在部署应用前内置一些通用资源，可以在应用部署中加入初始化的工作流来完成。
|
||||
|
||||
KubeVela 提供了一个内置的工作流步骤 `apply-object`，可以直接在组件的 `properties` 字段中填写创建到环境中的原生 Kubernetes 资源。
|
||||
这种在 Application 中直接填写 Kubernetes 原生资源的方式，可以避免编写多余的组件定义（ComponentDefinition）。
|
||||
|
||||
部署如下应用，初始化一个带有 ConfigMap / PVC 的环境。同时，部署两个组件，第一个组件会不断向 PVC 中写入数据，第二个组件会读取 PVC 中的数据：
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: server-with-pvc-and-cm
|
||||
namespace: default
|
||||
spec:
|
||||
components:
|
||||
- name: log-gen-worker
|
||||
type: worker
|
||||
properties:
|
||||
image: busybox
|
||||
cmd:
|
||||
- /bin/sh
|
||||
- -c
|
||||
- >
|
||||
i=0;
|
||||
while true;
|
||||
do
|
||||
echo "$i: $(date)" >> /test-pvc/date.log;
|
||||
i=$((i+1));
|
||||
sleep 1;
|
||||
done
|
||||
volumes:
|
||||
- name: "my-pvc"
|
||||
type: "pvc"
|
||||
mountPath: "/test-pvc"
|
||||
claimName: "my-claim"
|
||||
- name: "my-configmap"
|
||||
type: "configMap"
|
||||
mountPath: "/test-cm"
|
||||
cmName: "my-cm"
|
||||
items:
|
||||
- key: test-key
|
||||
path: test-key
|
||||
- name: log-read-worker
|
||||
type: worker
|
||||
properties:
|
||||
name: count-log
|
||||
image: busybox
|
||||
cmd:
|
||||
- /bin/sh
|
||||
- -c
|
||||
- 'tail -n+1 -f /test-pvc/date.log'
|
||||
volumes:
|
||||
- name: "my-pvc"
|
||||
type: "pvc"
|
||||
mountPath: "/test-pvc"
|
||||
claimName: "my-claim"
|
||||
- name: "my-configmap"
|
||||
type: "configMap"
|
||||
mountPath: "/test-cm"
|
||||
cmName: "my-cm"
|
||||
items:
|
||||
- key: test-key
|
||||
path: test-key
|
||||
|
||||
policies:
|
||||
- name: my-policy
|
||||
properties:
|
||||
clusters:
|
||||
- local
|
||||
type: topology
|
||||
- name: apply-once
|
||||
type: apply-once
|
||||
properties:
|
||||
enable: true
|
||||
|
||||
workflow:
|
||||
steps:
|
||||
- name: apply-pvc
|
||||
type: apply-object
|
||||
properties:
|
||||
value:
|
||||
apiVersion: v1
|
||||
kind: PersistentVolumeClaim
|
||||
metadata:
|
||||
name: my-claim
|
||||
namespace: default
|
||||
spec:
|
||||
accessModes:
|
||||
- ReadWriteOnce
|
||||
resources:
|
||||
requests:
|
||||
storage: 8Gi
|
||||
storageClassName: standard
|
||||
- name: apply-cm
|
||||
type: apply-object
|
||||
properties:
|
||||
value:
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: my-cm
|
||||
namespace: default
|
||||
data:
|
||||
test-key: test-value
|
||||
- name: deploy-comp
|
||||
properties:
|
||||
policies:
|
||||
- my-policy
|
||||
type: deploy
|
||||
```
|
||||
|
||||
查看集群中的 PVC 以及 ConfigMap：
|
||||
|
||||
```shell
|
||||
vela status server-with-pvc-and-cm --detail --tree
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>期望输出</summary>
|
||||
|
||||
```console
|
||||
CLUSTER NAMESPACE RESOURCE STATUS APPLY_TIME DETAIL
|
||||
local ─── default ─┬─ ConfigMap/my-cm updated 2022-10-31 18:00:52 Data: 1 Age: 57s
|
||||
├─ PersistentVolumeClaim/my-claim updated 2022-10-31 10:00:52 Status: Bound Volume: pvc-b6f88ada-af98-468d-8cdd-31ca110c5e1a Capacity: 8Gi Access Modes: RWO StorageClass: standard Age: 57s
|
||||
├─ Deployment/log-gen-worker updated 2022-10-31 10:00:52 Ready: 1/1 Up-to-date: 1 Available: 1 Age: 57s
|
||||
└─ Deployment/log-read-worker updated 2022-10-31 10:00:52 Ready: 1/1 Up-to-date: 1 Available: 1 Age: 57s
|
||||
```
|
||||
</details>
|
||||
|
||||
查看集群中应用的状态：
|
||||
|
||||
```shell
|
||||
vela status server-with-pvc-and-cm
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>期望输出</summary>
|
||||
|
||||
```console
|
||||
$ vela status server-with-pvc-and-cm
|
||||
About:
|
||||
|
||||
Name: server-with-pvc-and-cm
|
||||
Namespace: default
|
||||
Created at: 2022-10-31 18:00:51 +0800 CST
|
||||
Status: running
|
||||
|
||||
Workflow:
|
||||
|
||||
mode: StepByStep-DAG
|
||||
finished: true
|
||||
Suspend: false
|
||||
Terminated: false
|
||||
Steps
|
||||
- id: xboizfjo28
|
||||
name: apply-pvc
|
||||
type: apply-object
|
||||
phase: succeeded
|
||||
- id: 4ngx25mrx8
|
||||
name: apply-cm
|
||||
type: apply-object
|
||||
phase: succeeded
|
||||
- id: 1gzzt3mfw1
|
||||
name: deploy-comp
|
||||
type: deploy
|
||||
phase: succeeded
|
||||
|
||||
Services:
|
||||
|
||||
- Name: log-gen-worker
|
||||
Cluster: local Namespace: default
|
||||
Type: worker
|
||||
Healthy Ready:1/1
|
||||
No trait applied
|
||||
|
||||
- Name: log-read-worker
|
||||
Cluster: local Namespace: default
|
||||
Type: worker
|
||||
Healthy Ready:1/1
|
||||
No trait applied
|
||||
```
|
||||
</details>
|
||||
|
||||
检查第二个组件的日志输出：
|
||||
|
||||
```shell
|
||||
vela logs server-with-pvc-and-cm --component log-read-worker
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>期望输出</summary>
|
||||
|
||||
```console
|
||||
+ log-read-worker-7f4bc9d9b5-kb5l6 › log-read-worker
|
||||
log-read-worker 2022-10-31T10:01:15.606903716Z 0: Mon Oct 31 10:01:13 UTC 2022
|
||||
log-read-worker 2022-10-31T10:01:15.606939383Z 1: Mon Oct 31 10:01:14 UTC 2022
|
||||
log-read-worker 2022-10-31T10:01:15.606941883Z 2: Mon Oct 31 10:01:15 UTC 2022
|
||||
log-read-worker 2022-10-31T10:01:16.607006425Z 3: Mon Oct 31 10:01:16 UTC 2022
|
||||
log-read-worker 2022-10-31T10:01:17.607184925Z 4: Mon Oct 31 10:01:17 UTC 2022
|
||||
log-read-worker 2022-10-31T10:01:18.607304426Z 5: Mon Oct 31 10:01:18 UTC 2022
|
||||
...
|
||||
```
|
||||
</details>
|
||||
|
||||
可以看到，应用中的两个组件均已正常运行。同时，这两个组件共享同一个 PVC，并使用相同的 ConfigMap 进行配置。
|
||||
|
||||
## 如何销毁环境
|
||||
|
||||
因为我们已经通过应用（Application）这个统一的模型做了环境初始化，所以销毁环境变得非常简单，只需要删除这个应用即可。
|
||||
|
||||
```
|
||||
vela delete server-with-pvc-and-cm
|
||||
```
|
||||
|
||||
KubeVela 控制器会自动将资源删除。
|
||||
|
|
@ -0,0 +1,154 @@
|
|||
---
|
||||
title: Jenkins CI 集成
|
||||
draft: true
|
||||
---
|
||||
|
||||
本文将介绍如何使用 KubeVela 同已有的 CI 工具（比如 Jenkins）共同协作来进行应用的持续交付，并解释这样集成的好处是什么。
|
||||
|
||||
## 简介
|
||||
|
||||
KubeVela 作为一个普适的应用交付控制平面，只需要一点点集成工作就可以同任何现有的 CI/CD 系统对接起来，并且为它们带来一系列现代云原生应用交付的能力，比如：
|
||||
- 混合云/多云应用交付；
|
||||
- 跨环境发布（Promotion）；
|
||||
- 基于 Service Mesh 的发布与回滚；
|
||||
- 处理部署过程中的各种依赖关系和拓扑结构；
|
||||
- 统一进行云服务的声明、部署和服务绑定；
|
||||
- 无需强迫你的团队采纳完整的 GitOps 协作方式即可享受 GitOps 技术本身的[一系列好处](https://www.weave.works/blog/what-is-gitops-really)；
|
||||
- …… 以及更多。
|
||||
|
||||
|
||||
接下来，本文将会以一个 HTTP 服务的开发部署为例，介绍 KubeVela + Jenkins 方式下应用的持续集成与持续交付步骤。这个应用的具体代码在[这个 GitHub 库中](https://github.com/Somefive/KubeVela-demo-CICD-app)。
|
||||
|
||||
## 准备工作
|
||||
|
||||
在对接之前，用户首先需要确保以下环境。
|
||||
|
||||
1. 已部署好 Jenkins 服务并配置了 Docker 在 Jenkins 中的环境，包括相关插件及镜像仓库的访问权限。
|
||||
2. 已配置好的 Git 仓库并开启 Webhook。确保 Git 仓库对应分支的变化能够通过 Webhook 触发 Jenkins 流水线的运行。
|
||||
3. 准备好需要部署的 Kubernetes 集群环境，并在环境中安装 KubeVela 基础组件及 apiserver，确保 KubeVela apiserver 能够从公网访问到。
|
||||
|
||||
## 对接 Jenkins 与 KubeVela apiserver
|
||||
|
||||
在 Jenkins 中以下面的 Groovy 脚本为例设置部署流水线。可以将流水线中的 Git 地址、镜像地址、apiserver 的地址、应用命名空间及应用替换成自己的配置，同时在自己的代码仓库中存放 Dockerfile 及 app.yaml，用来构建及部署 KubeVela 应用。
|
||||
|
||||
```groovy
|
||||
pipeline {
|
||||
agent any
|
||||
environment {
|
||||
GIT_BRANCH = 'prod'
|
||||
GIT_URL = 'https://github.com/Somefive/KubeVela-demo-CICD-app.git'
|
||||
DOCKER_REGISTRY = 'https://registry.hub.docker.com'
|
||||
DOCKER_CREDENTIAL = 'DockerHubCredential'
|
||||
DOCKER_IMAGE = 'somefive/kubevela-demo-cicd-app'
|
||||
APISERVER_URL = 'http://47.88.24.19'
|
||||
APPLICATION_YAML = 'app.yaml'
|
||||
APPLICATION_NAMESPACE = 'kubevela-demo-namespace'
|
||||
APPLICATION_NAME = 'cicd-demo-app'
|
||||
}
|
||||
stages {
|
||||
stage('Prepare') {
|
||||
steps {
|
||||
script {
|
||||
def checkout = git branch: env.GIT_BRANCH, url: env.GIT_URL
|
||||
env.GIT_COMMIT = checkout.GIT_COMMIT
|
||||
env.GIT_BRANCH = checkout.GIT_BRANCH
|
||||
echo "env.GIT_BRANCH=${env.GIT_BRANCH},env.GIT_COMMIT=${env.GIT_COMMIT}"
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('Build') {
|
||||
steps {
|
||||
script {
|
||||
docker.withRegistry(env.DOCKER_REGISTRY, env.DOCKER_CREDENTIAL) {
|
||||
def customImage = docker.build(env.DOCKER_IMAGE)
|
||||
customImage.push()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
stage('Deploy') {
|
||||
steps {
|
||||
sh 'wget -q "https://github.com/mikefarah/yq/releases/download/v4.12.1/yq_linux_amd64"'
|
||||
sh 'chmod +x yq_linux_amd64'
|
||||
script {
|
||||
def app = sh (
|
||||
script: "./yq_linux_amd64 eval -o=json '.spec' ${env.APPLICATION_YAML} | sed -e 's/GIT_COMMIT/$GIT_COMMIT/g'",
|
||||
returnStdout: true
|
||||
)
|
||||
echo "app: ${app}"
|
||||
def response = httpRequest acceptType: 'APPLICATION_JSON', contentType: 'APPLICATION_JSON', httpMode: 'POST', requestBody: app, url: "${env.APISERVER_URL}/v1/namespaces/${env.APPLICATION_NAMESPACE}/applications/${env.APPLICATION_NAME}"
|
||||
println('Status: '+response.status)
|
||||
println('Response: '+response.content)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
之后向流水线中使用的 Git 仓库的分支推送代码变更，Git 仓库的 Webhook 会触发 Jenkins 中新创建的流水线。该流水线会自动构建代码镜像并推送至镜像仓库，然后对 KubeVela apiserver 发送 POST 请求，将仓库中的应用配置文件部署到 Kubernetes 集群中。其中 app.yaml 可以参照以下样例。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: kubevela-demo-app
|
||||
spec:
|
||||
components:
|
||||
- name: kubevela-demo-app-web
|
||||
type: webservice
|
||||
properties:
|
||||
image: somefive/kubevela-demo-cicd-app
|
||||
imagePullPolicy: Always
|
||||
port: 8080
|
||||
traits:
|
||||
- type: rollout
|
||||
properties:
|
||||
rolloutBatches:
|
||||
- replicas: 2
|
||||
- replicas: 3
|
||||
batchPartition: 0
|
||||
targetSize: 5
|
||||
- type: labels
|
||||
properties:
|
||||
jenkins-build-commit: GIT_COMMIT
|
||||
- type: ingress
|
||||
properties:
|
||||
domain: <your domain>
|
||||
http:
|
||||
"/": 8088
|
||||
```
|
||||
|
||||
其中 GIT_COMMIT 会在 Jenkins 流水线中被替换为当前的 git commit id。这时可以通过 kubectl 命令查看 Kubernetes 集群中应用的部署情况。
|
||||
|
||||
```bash
|
||||
$ kubectl get app -n kubevela-demo-namespace
|
||||
NAME COMPONENT TYPE PHASE HEALTHY STATUS AGE
|
||||
cicd-demo-app kubevela-demo-app-web webservice running true 102s
|
||||
$ kubectl get deployment -n kubevela-demo-namespace
|
||||
NAME READY UP-TO-DATE AVAILABLE AGE
|
||||
kubevela-demo-app-web-v1 2/2 2 2 111s
|
||||
$ kubectl get ingress -n kubevela-demo-namespace
|
||||
NAME CLASS HOSTS ADDRESS PORTS AGE
|
||||
kubevela-demo-app-web <none> <your domain> 198.11.175.125 80 117s
|
||||
```
|
||||
|
||||
在部署的应用文件中，我们使用了灰度发布(Rollout)的特性，应用初始发布先创建 2 个 Pod，以便进行金丝雀验证。待验证完毕，你可以将应用配置中 Rollout 特性的 `batchPatition: 0` 删去，以便完成剩余实例的更新发布。这个机制大大提高发布的安全性和稳定性，同时你也可以根据实际需要，调整 Rollout 发布策略。
|
||||
|
||||
```bash
|
||||
$ kubectl edit app -n kubevela-demo-namespace
|
||||
application.core.oam.dev/cicd-demo-app edited
|
||||
$ kubectl get deployment -n kubevela-demo-namespace
|
||||
NAME READY UP-TO-DATE AVAILABLE AGE
|
||||
kubevela-demo-app-web-v1 5/5 5 5 4m16s
|
||||
$ curl http://<your domain>/
|
||||
Version: 0.1.2
|
||||
```
|
||||
|
||||
## 更多
|
||||
|
||||
详细的环境部署流程以及更加完整的应用滚动更新可以参考[博客](/blog/2021/09/02/kubevela-jenkins-cicd)。
|
||||
|
||||
## 下一步
|
||||
|
||||
- 学习 KubeVela 在 [GitOps](./gitops.md) 场景下的对接和使用方式。
|
||||
|
|
@ -0,0 +1,607 @@
|
|||
---
|
||||
title: 多集群应用交付
|
||||
---
|
||||
|
||||
本章节将会介绍如何使用 KubeVela 分发多集群应用。
|
||||
|
||||
## 简介
|
||||
|
||||
如今，在越来越多的场景下，开发者和系统运维人员开始将应用部署在多个集群中：
|
||||
|
||||
* 由于 Kubernetes 集群存在着部署规模的局限性（单一集群最多容纳 5k 节点），需要应用多集群技术来部署、管理海量的应用。
|
||||
* 考虑到稳定性及高可用性，同一个应用可以部署在多个集群中，以实现容灾、异地多活等需求。
|
||||
* 应用可能需要部署在不同的区域来满足不同政府对于数据安全性的政策需求。
|
||||
|
||||
## 架构
|
||||
|
||||
|
||||
|
||||
KubeVela 的多集群依赖于 [Cluster-Gateway](https://github.com/oam-dev/cluster-gateway) 组件，在 KubeVela 的 Helm Chart 中自动安装。 默认情况下，KubeVela 管理多集群的方式是通过 `kubeconfig` 直连集群，你也可以使用 [Open Cluster Management](../platform-engineers/system-operation/working-with-ocm.md) 组件来使用拉取（PULL）模式。
|
||||
|
||||
下文将会介绍如何在 KubeVela 中进行使用管理多集群应用。
|
||||
|
||||
## 准备工作
|
||||
|
||||
在使用多集群应用部署之前，你需要将子集群通过 KubeConfig 加入到 KubeVela 的管控中来。Vela CLI 可以帮你实现这一点。
|
||||
|
||||
```shell script
|
||||
vela cluster join <your kubeconfig path>
|
||||
```
|
||||
|
||||
该命令会自动使用 KubeConfig 中的 `context.cluster` 字段作为集群名称，你也可以使用 `--name` 参数来指定，如
|
||||
|
||||
```shell
|
||||
$ vela cluster join beijing.kubeconfig --name beijing
|
||||
$ vela cluster join hangzhou-1.kubeconfig --name hangzhou-1
|
||||
$ vela cluster join hangzhou-2.kubeconfig --name hangzhou-2
|
||||
```
|
||||
|
||||
在子集群加入 KubeVela 中后，你同样可以使用 CLI 命令来查看当前正在被 KubeVela 管控的所有集群。
|
||||
|
||||
```bash
|
||||
$ vela cluster list
|
||||
CLUSTER TYPE ENDPOINT ACCEPTED LABELS
|
||||
local Internal - true
|
||||
cluster-beijing X509Certificate <ENDPOINT_BEIJING> true
|
||||
cluster-hangzhou-1 X509Certificate <ENDPOINT_HANGZHOU_1> true
|
||||
cluster-hangzhou-2 X509Certificate <ENDPOINT_HANGZHOU_2> true
|
||||
```
|
||||
|
||||
> 默认情况下，KubeVela 控制面所在的管控集群会被作为 `local` 集群进行注册。你可以通过它将应用资源部署在管控集群中。该 `local` 集群不能被修改或者删除。
|
||||
|
||||
如果你不需要某个子集群了，还可以将子集群从 KubeVela 管控中移除。
|
||||
|
||||
|
||||
```shell script
|
||||
$ vela cluster detach beijing
|
||||
```
|
||||
|
||||
> 移除一个正在使用的集群是危险行为。不过如果你想要对集群的认证信息做修改，比如轮转证书，你可以强行删除它。
|
||||
|
||||
你也可以给你的集群打标签，帮助你选择要部署的集群。
|
||||
|
||||
```bash
|
||||
$ vela cluster labels add cluster-hangzhou-1 region=hangzhou
|
||||
$ vela cluster labels add cluster-hangzhou-2 region=hangzhou
|
||||
$ vela cluster list
|
||||
CLUSTER TYPE ENDPOINT ACCEPTED LABELS
|
||||
local Internal - true
|
||||
cluster-beijing X509Certificate <ENDPOINT_BEIJING> true
|
||||
cluster-hangzhou-1 X509Certificate <ENDPOINT_HANGZHOU_1> true region=hangzhou
|
||||
cluster-hangzhou-2 X509Certificate <ENDPOINT_HANGZHOU_2> true region=hangzhou
|
||||
```
|
||||
|
||||
## 部署多集群应用
|
||||
|
||||
你只需要使用 `topology` 策略来声明要部署的集群，就可以部署多集群应用了。例如，你可以使用下面这个样例将 nginx webservice 部署在两个杭州集群中，
|
||||
|
||||
```bash
|
||||
$ cat <<EOF | vela up -f -
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: basic-topology
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-basic
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
traits:
|
||||
- type: expose
|
||||
properties:
|
||||
port: [80]
|
||||
policies:
|
||||
- name: topology-hangzhou-clusters
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["cluster-hangzhou-1", "cluster-hangzhou-2"]
|
||||
EOF
|
||||
```
|
||||
|
||||
你可以通过运行 `vela status` 来查看部署状态。
|
||||
|
||||
```bash
|
||||
$ vela status basic-topology -n examples
|
||||
About:
|
||||
|
||||
Name: basic-topology
|
||||
Namespace: examples
|
||||
Created at: 2022-04-08 14:37:54 +0800 CST
|
||||
Status: workflowFinished
|
||||
|
||||
Workflow:
|
||||
|
||||
mode: DAG
|
||||
finished: true
|
||||
Suspend: false
|
||||
Terminated: false
|
||||
Steps
|
||||
- id:3mvz5i8elj
|
||||
name:deploy-topology-hangzhou-clusters
|
||||
type:deploy
|
||||
phase:succeeded
|
||||
message:
|
||||
|
||||
Services:
|
||||
|
||||
- Name: nginx-basic
|
||||
Cluster: cluster-hangzhou-1 Namespace: examples
|
||||
Type: webservice
|
||||
Healthy Ready:1/1
|
||||
Traits:
|
||||
✅ expose
|
||||
- Name: nginx-basic
|
||||
Cluster: cluster-hangzhou-2 Namespace: examples
|
||||
Type: webservice
|
||||
Healthy Ready:1/1
|
||||
Traits:
|
||||
✅ expose
|
||||
```
|
||||
|
||||
### 调试多集群应用
|
||||
|
||||
你可以运行以下 CLI 命令调试上述的多集群应用。通过这些 CLI 命令，你可以在管控集群上直接操纵子集群中的资源，而不需要切换 KubeConfig 等集群配置。如果你的应用使用了多个集群，CLI 向你询问你希望操纵的集群。
|
||||
- `vela status` 如上文所示，为你展示多集群应用的整体部署情况。
|
||||
- `vela logs` 查询子集群中的 Pod 日志。
|
||||
|
||||
```bash
|
||||
$ vela logs basic-topology -n examples
|
||||
? You have 2 deployed resources in your app. Please choose one: Cluster: cluster-hangzhou-1 | Namespace: examples | Kind: Deployment | Name: nginx-basic
|
||||
+ nginx-basic-dfb6dcf8d-km5vk › nginx-basic
|
||||
nginx-basic-dfb6dcf8d-km5vk nginx-basic 2022-04-08T06:38:10.540430392Z /docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration
|
||||
nginx-basic-dfb6dcf8d-km5vk nginx-basic 2022-04-08T06:38:10.540742240Z /docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/
|
||||
```
|
||||
|
||||
- `vela exec` 帮助你在子集群的 Pod 里执行命令。
|
||||
|
||||
```bash
|
||||
$ vela exec basic-topology -n examples -it -- ls
|
||||
? You have 2 deployed resources in your app. Please choose one: Cluster: cluster-hangzhou-1 | Namespace: examples | Kind: Deployment | Name: nginx-basic
|
||||
bin docker-entrypoint.d home media proc sbin tmp
|
||||
boot docker-entrypoint.sh lib mnt root srv usr
|
||||
dev etc lib64 opt run sys var
|
||||
```
|
||||
|
||||
- `vela port-forward` 将子集群中的 Pod 或者 Service 通过端口映射到本地使其可以在本地被访问。
|
||||
|
||||
```bash
|
||||
$ vela port-forward basic-topology -n examples 8080:80
|
||||
? You have 4 deployed resources in your app. Please choose one: Cluster: cluster-hangzhou-1 | Namespace: examples | Kind: Deployment | Name: nginx-basic
|
||||
Forwarding from 127.0.0.1:8080 -> 80
|
||||
Forwarding from [::1]:8080 -> 80
|
||||
|
||||
Forward successfully! Opening browser ...
|
||||
Handling connection for 8080
|
||||
```
|
||||
|
||||
|
||||
|
||||
## 进阶使用
|
||||
|
||||
|
||||
### 理解多集群应用
|
||||
|
||||
下图为多集群应用的整体结构图。如图所示，所有的配置信息（包括应用、策略和工作流）都处于管控集群中。只有资源（如 deployment 或者 service）会被下发到子集群之中。
|
||||
|
||||
策略主要负责描述资源的位置以及它们应该如何被差异化配置。资源下发真正的执行者是工作流。在工作流中，`deploy` 步骤会根据引用的策略对资源进行差异化配置，然后再将它们分发到对应的集群中。
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 配置部署目标
|
||||
|
||||
选择部署目标的最直接的方法就是在 `topology` 策略中声明你想要部署的集群名称。有的时候，使用标签来筛选要部署的集群会更方便，比如下面这个例子通过标签筛选出所有的杭州集群：
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: label-selector-topology
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-label-selector
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
policies:
|
||||
- name: topology-hangzhou-clusters
|
||||
type: topology
|
||||
properties:
|
||||
clusterLabelSelector:
|
||||
region: hangzhou
|
||||
```
|
||||
|
||||
如果你想要在管控集群中部署应用，你也可以使用 `local` 集群。除此之外，你还可以选择希望部署的命名空间，取代应用原有的命名空间。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: local-ns-topology
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-local-ns
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
policies:
|
||||
- name: topology-local
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["local"]
|
||||
namespace: examples-alternative
|
||||
```
|
||||
|
||||
> 有时，出于安全考虑，你可能希望限制应用使其只能在自己的命名空间中部署资源。你可以通过在 KubeVela 控制器的启动参数中配置 `--allow-cross-namespace-resource=false` 来禁用跨命名空间部署。
|
||||
|
||||
|
||||
### 控制部署工作流
|
||||
|
||||
默认情况下，如果你在应用中声明了多个 `topology` 策略，应用组件将会依次分发到这些目标位置上。
|
||||
|
||||
如果你想要控制整个部署流程，比如更改默认的部署顺序，或者是添加人工审核步骤，你可以显式使用 `deploy` 工作流步骤来实现。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: deploy-workflowstep
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-deploy-workflowstep
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
policies:
|
||||
- name: topology-hangzhou-clusters
|
||||
type: topology
|
||||
properties:
|
||||
clusterLabelSelector:
|
||||
region: hangzhou
|
||||
- name: topology-local
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["local"]
|
||||
namespace: examples-alternative
|
||||
workflow:
|
||||
steps:
|
||||
- type: deploy
|
||||
name: deploy-local
|
||||
properties:
|
||||
policies: ["topology-local"]
|
||||
- type: deploy
|
||||
name: deploy-hangzhou
|
||||
properties:
|
||||
# require manual approval before running this step
|
||||
auto: false
|
||||
policies: ["topology-hangzhou-clusters"]
|
||||
```
|
||||
|
||||
如果你希望并行地部署所有集群，你可以在一个 `deploy` 工作流步骤中使用所有的 `topology` 策略。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: deploy-concurrently
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-deploy-concurrently
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
policies:
|
||||
- name: topology-hangzhou-clusters
|
||||
type: topology
|
||||
properties:
|
||||
clusterLabelSelector:
|
||||
region: hangzhou
|
||||
- name: topology-local
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["local"]
|
||||
namespace: examples-alternative
|
||||
workflow:
|
||||
steps:
|
||||
- type: deploy
|
||||
name: deploy-all
|
||||
properties:
|
||||
policies: ["topology-local", "topology-hangzhou-clusters"]
|
||||
```
|
||||
|
||||
|
||||
### 使用差异化配置
|
||||
|
||||
在一些情况下，你可能希望应用在不同的集群中有不一样的配置，而不是全都使用完全相同的默认配置。比如使用不同的镜像或者配置不同的副本数量。
|
||||
|
||||
`override` 策略可以帮助你实现差异化配置。你可以在 `deploy` 工作流步骤中，配合 `topology` 策略来使用它。
|
||||
|
||||
在下面的样例中，应用会在 `local` 集群中部署一个默认的 nginx webservcie，然后在杭州集群中部署含有 3 副本的高可用 nginx webservice，并且使用 `nginx:1.20` 镜像。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: deploy-with-override
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-with-override
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
policies:
|
||||
- name: topology-hangzhou-clusters
|
||||
type: topology
|
||||
properties:
|
||||
clusterLabelSelector:
|
||||
region: hangzhou
|
||||
- name: topology-local
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["local"]
|
||||
namespace: examples-alternative
|
||||
- name: override-nginx-legacy-image
|
||||
type: override
|
||||
properties:
|
||||
components:
|
||||
- name: nginx-with-override
|
||||
properties:
|
||||
image: nginx:1.20
|
||||
- name: override-high-availability
|
||||
type: override
|
||||
properties:
|
||||
components:
|
||||
- type: webservice
|
||||
traits:
|
||||
- type: scaler
|
||||
properties:
|
||||
replicas: 3
|
||||
workflow:
|
||||
steps:
|
||||
- type: deploy
|
||||
name: deploy-local
|
||||
properties:
|
||||
policies: ["topology-local"]
|
||||
- type: deploy
|
||||
name: deploy-hangzhou
|
||||
properties:
|
||||
policies: ["topology-hangzhou-clusters", "override-nginx-legacy-image", "override-high-availability"]
|
||||
```
|
||||
|
||||
> 注意：override 策略是用来修改基础配置的策略，因此**它被设计成必须需要和 topology 策略一同使用**。如果你不想要使用 topology 策略，你可以直接将配置写在组件声明中，而不是使用 override 策略。*如果你错误的在 deploy 工作流步骤中使用了 override 策略，而没有使用 topology 策略，应用不会发生错误，但是也不会下发任何资源。*
|
||||
|
||||
差异化配置有一些高级配置能力，比如添加额外的组件，或者选择部分组件。下面的样例中，应用会首先在 `local` 集群中部署一个镜像为 `nginx:1.20` 的 webservice，然后再将 `nginx` 和 `nginx:stable` 两个 webservice 部署到杭州集群中
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: advance-override
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-advance-override-legacy
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx:1.20
|
||||
- name: nginx-advance-override-latest
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
policies:
|
||||
- name: topology-hangzhou-clusters
|
||||
type: topology
|
||||
properties:
|
||||
clusterLabelSelector:
|
||||
region: hangzhou
|
||||
- name: topology-local
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["local"]
|
||||
namespace: examples-alternative
|
||||
- name: override-nginx-legacy
|
||||
type: override
|
||||
properties:
|
||||
selector: ["nginx-advance-override-legacy"]
|
||||
- name: override-nginx-latest
|
||||
type: override
|
||||
properties:
|
||||
selector: ["nginx-advance-override-latest", "nginx-advance-override-stable"]
|
||||
components:
|
||||
- name: nginx-advance-override-stable
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx:stable
|
||||
workflow:
|
||||
steps:
|
||||
- type: deploy
|
||||
name: deploy-local
|
||||
properties:
|
||||
policies: ["topology-local", "override-nginx-legacy"]
|
||||
- type: deploy
|
||||
name: deploy-hangzhou
|
||||
properties:
|
||||
policies: ["topology-hangzhou-clusters", "override-nginx-latest"]
|
||||
```
|
||||
|
||||
|
||||
### 使用外置策略和工作流
|
||||
|
||||
有时，你可能希望在不同的应用之间使用相同的策略，或者在部署资源的时候复用之前的工作流配置。
|
||||
为了减少重复的配置，你可以使用外置的策略和工作流，并在应用中引用它们。
|
||||
|
||||
> 注意：你只能在应用中引用相同命名空间下的策略和工作流。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1alpha1
|
||||
kind: Policy
|
||||
metadata:
|
||||
name: topology-hangzhou-clusters
|
||||
namespace: examples
|
||||
type: topology
|
||||
properties:
|
||||
clusterLabelSelector:
|
||||
region: hangzhou
|
||||
---
|
||||
apiVersion: core.oam.dev/v1alpha1
|
||||
kind: Policy
|
||||
metadata:
|
||||
name: override-high-availability-webservice
|
||||
namespace: examples
|
||||
type: override
|
||||
properties:
|
||||
components:
|
||||
- type: webservice
|
||||
traits:
|
||||
- type: scaler
|
||||
properties:
|
||||
replicas: 3
|
||||
---
|
||||
apiVersion: core.oam.dev/v1alpha1
|
||||
kind: Workflow
|
||||
metadata:
|
||||
name: make-release-in-hangzhou
|
||||
namespace: examples
|
||||
steps:
|
||||
- type: deploy
|
||||
name: deploy-hangzhou
|
||||
properties:
|
||||
auto: false
|
||||
policies: ["override-high-availability-webservice", "topology-hangzhou-clusters"]
|
||||
```
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: external-policies-and-workflow
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-external-policies-and-workflow
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx
|
||||
workflow:
|
||||
ref: make-release-in-hangzhou
|
||||
```
|
||||
|
||||
> 注意：内置的策略会被优先使用。只有当工作流使用的策略不存在于内置策略中时才会使用外置策略。在下面的样例中，你可以复用 `topology-hangzhou-clusters` 策略以及 `make-release-in-hangzhou` 工作流，但是通过在应用中声明 `override-high-availability-webservice` 策略来覆盖同名的外置策略。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: nginx-stable-ultra
|
||||
namespace: examples
|
||||
spec:
|
||||
components:
|
||||
- name: nginx-stable-ultra
|
||||
type: webservice
|
||||
properties:
|
||||
image: nginx:stable
|
||||
policies:
|
||||
- name: override-high-availability-webservice
|
||||
type: override
|
||||
properties:
|
||||
components:
|
||||
- type: webservice
|
||||
traits:
|
||||
- type: scaler
|
||||
properties:
|
||||
replicas: 5
|
||||
workflow:
|
||||
ref: make-release-in-hangzhou
|
||||
```
|
||||
|
||||
### 通过自定义工作流步骤实现多集群调度
|
||||
|
||||
多集群部署的功能可以结合[自定义工作流步骤](../end-user/workflow/overview.md) 实现功能多样的多集群调度能力.
|
||||
|
||||
如下示例所示，我们会部署一个任务到 `local` 集群的 `default` 命名空间，然后通过 `read-object` 步骤检查部署状态，最后根据状态将任务部署到 `prod` 命名空间。
|
||||
|
||||
```yaml
|
||||
apiVersion: core.oam.dev/v1beta1
|
||||
kind: Application
|
||||
metadata:
|
||||
name: deploy-with-override
|
||||
spec:
|
||||
components:
|
||||
- name: mytask
|
||||
type: task
|
||||
properties:
|
||||
image: bash
|
||||
count: 1
|
||||
cmd: ["echo", "hello world"]
|
||||
policies:
|
||||
- name: target-default
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["local"]
|
||||
namespace: "default"
|
||||
- name: target-prod
|
||||
type: topology
|
||||
properties:
|
||||
clusters: ["local"]
|
||||
namespace: "prod"
|
||||
- name: override-annotations-1
|
||||
type: override
|
||||
properties:
|
||||
components:
|
||||
- type: task
|
||||
traits:
|
||||
- type: annotations
|
||||
properties:
|
||||
"description": "01 cron task - 1"
|
||||
- name: override-annotations-2
|
||||
type: override
|
||||
properties:
|
||||
components:
|
||||
- type: task
|
||||
traits:
|
||||
- type: annotations
|
||||
properties:
|
||||
"description": "02 cron task - 2"
|
||||
workflow:
|
||||
steps:
|
||||
- type: deploy
|
||||
name: deploy-01
|
||||
properties:
|
||||
policies: ["target-default", "override-annotations-1"]
|
||||
- name: read-object
|
||||
type: read-object
|
||||
outputs:
|
||||
- name: ready
|
||||
valueFrom: output.value.status["ready"]
|
||||
properties:
|
||||
apiVersion: batch/v1
|
||||
kind: Job
|
||||
name: mytask
|
||||
namespace: default
|
||||
cluster: local
|
||||
- type: deploy
|
||||
name: deploy-02
|
||||
inputs:
|
||||
- from: ready
|
||||
if: inputs["ready"] == 0
|
||||
properties:
|
||||
policies: ["target-prod", "override-annotations-2"]
|
||||
```
|
||||
|
||||
## 兼容性
|
||||
|
||||
KubeVela 的 v1.3 应用相较于之前的版本使用了不同的策略和工作流步骤来分发、管理多集群应用。
|
||||
|
||||
旧版本中的 `env-binding` 策略以及 `deploy2env` 工作流步骤在目前版本中仍保留并兼容，但可能会在未来的版本中逐步废弃。
|
||||
|
||||
新的策略和工作流步骤可以完全覆盖旧版本中多集群应用的所有使用场景，而且提供了更强的能力。自动化升级工具将会在废弃旧版本之前提供给用户。
|
||||
|
||||
如果你已经在生产环境中使用了旧版本的多集群应用，并且不希望改变他们，KubeVela v1.3 可以完全兼容它们，而不需要对应用进行升级。
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
---
|
||||
title: CLI Commands
|
||||
---
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
* [vela init](vela_init.md) - Create scaffold for vela application.
|
||||
* [vela up](vela_up.md) - 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 status](vela_status.md) - Show status of vela application.
|
||||
* [vela ls](vela_ls.md) - List all vela applications.
|
||||
* [vela delete](vela_delete.md) - Delete applications
|
||||
|
||||
Delete KubeVela applications. KubeVela application deletion is associated with the recycle of underlying resources. By default, the resources created by the KubeVela application will be deleted once it is not in use or the application is deleted. There is garbage-collect policy in KubeVela application that you can use to configure customized recycle rules.
|
||||
|
||||
This command supports delete application in various modes. Natively, you can use it like "kubectl delete app [app-name]". In the cases you only want to delete the application but leave the resources there, you can use the --orphan parameter. In the cases the server-side controller is uninstalled, or you want to manually skip some errors in the deletion process (like lack privileges or handle cluster disconnection), you can use the --force parameter.
|
||||
* [vela env](vela_env.md) - Manage environments for vela applications to run.
|
||||
* [vela show](vela_show.md) - Show the reference doc for component, trait, policy or workflow types. 'vela show' equals with 'vela def show'.
|
||||
|
||||
## Managing Applications
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
* [vela dry-run](vela_dry-run.md) - Dry-run application locally, render the Kubernetes resources as result to stdout.
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml
|
||||
|
||||
You can also specify a remote url for app:
|
||||
vela dry-run -d /definition/directory/or/file/ -f https://remote-host/app.yaml
|
||||
|
||||
And more, you can specify policy and workflow with application file:
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml -f /path/to/policy.yaml -f /path/to/workflow.yaml, OR
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml
|
||||
|
||||
Additionally, if the provided policy and workflow files are not referenced by application file, warning message will show up
|
||||
and those files will be ignored. You can use "merge" flag to make those standalone files effective:
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml --merge
|
||||
|
||||
Limitation:
|
||||
1. Only support one object per file(yaml) for "-f" flag. More support will be added in the future improvement.
|
||||
2. Dry Run with policy and workflow will only take override/topology policies and deploy workflow step into considerations. Other workflow step will be ignored.
|
||||
|
||||
* [vela live-diff](vela_live-diff.md) - Compare application and revisions.
|
||||
* [vela logs](vela_logs.md) - Tail logs for vela application.
|
||||
* [vela port-forward](vela_port-forward.md) - Forward local ports to container/service port of vela application.
|
||||
* [vela exec](vela_exec.md) - Execute command inside container based vela application.
|
||||
* [vela revision](vela_revision.md) - Manage KubeVela Application Revisions
|
||||
* [vela debug](vela_debug.md) - Debug running application with debug policy.
|
||||
|
||||
## Continuous Delivery
|
||||
|
||||
* [vela workflow](vela_workflow.md) - Operate the Workflow during Application Delivery. Note that workflow command is both valid for Application Workflow and WorkflowRun(expect for [restart, rollout] command, they're only valid for Application Workflow). The command will try to find the Application first, if not found, it will try to find WorkflowRun. You can also specify the resource type by using --type flag.
|
||||
* [vela adopt](vela_adopt.md) - Adopt resources into applications
|
||||
|
||||
Adopt resources into a KubeVela application. This command is useful when you already have resources applied in your Kubernetes cluster. These resources could be applied natively or with other tools, such as Helm. This command will automatically find out the resources to be adopted and assemble them into a new application which won't trigger any damage such as restart on the adoption.
|
||||
|
||||
There are two types of adoption supported by far, 'native' Kubernetes resources (by default) and 'helm' releases. 1. For 'native' type, you can specify a list of resources you want to adopt in the application. Only resources in local cluster are supported for now. 2. For 'helm' type, you can specify a helm release name. This helm release should be already published in the local cluster. The command will find the resources managed by the helm release and convert them into an adoption application.
|
||||
|
||||
There are two working mechanism (called 'modes' here) for the adoption by far, 'read-only' mode (by default) and 'take-over' mode. 1. In 'read-only' mode, adopted resources will not be touched. You can leverage vela tools (like Vela CLI or VelaUX) to observe those resources and attach traits to add new capabilities. The adopted resources will not be recycled or updated. This mode is recommended if you still want to keep using other tools to manage resources updates or deletion, like Helm. 2. In 'take-over' mode, adopted resources are completely managed by application which means they can be modified. You can use traits or directly modify the component to make edits to those resources. This mode can be helpful if you want to migrate existing resources into KubeVela system and let KubeVela to handle the life-cycle of target resources.
|
||||
|
||||
The adopted application can be customized. You can provide a CUE template file to the command and make your own assemble rules for the adoption application. You can refer to https://github.com/kubevela/kubevela/blob/master/references/cli/adopt-templates/default.cue to see the default implementation of adoption rules.
|
||||
|
||||
If you want to adopt all resources with resource topology rule to Applications, you can use: 'vela adopt --all'. The resource topology rule can be customized by '--resource-topology-rule' flag.
|
||||
|
||||
## Managing Extensions
|
||||
|
||||
* [vela uischema](vela_uischema.md) - Manage UI schema for addons.
|
||||
* [vela component](vela_component.md) - List component types installed and discover more in registry.
|
||||
* [vela trait](vela_trait.md) - List trait types installed and discover more in registry.
|
||||
* [vela def](vela_def.md) - Manage X-Definitions for extension.
|
||||
|
||||
## System Tools
|
||||
|
||||
* [vela install](vela_install.md) - The Kubevela CLI allows installing Kubevela on any Kubernetes derivative to which your kube config is pointing to.
|
||||
* [vela uninstall](vela_uninstall.md) - Uninstalls KubeVela from a Kubernetes cluster.
|
||||
* [vela system](vela_system.md) - Manage system, including printing the system deployment information in vela-system namespace and diagnosing the system's health.
|
||||
* [vela version](vela_version.md) - Prints vela build version information.
|
||||
|
||||
###### Auto generated by [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: vela addon
|
||||
---
|
||||
|
||||
Manage addons for extension.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage addons for extension.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for addon
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela addon disable](vela_addon_disable.md) - disable an addon
|
||||
* [vela addon enable](vela_addon_enable.md) - enable an addon
|
||||
* [vela addon init](vela_addon_init.md) - create an addon scaffold
|
||||
* [vela addon list](vela_addon_list.md) - List addons
|
||||
* [vela addon package](vela_addon_package.md) - package an addon directory
|
||||
* [vela addon push](vela_addon_push.md) - uploads an addon package to ChartMuseum
|
||||
* [vela addon registry](vela_addon_registry.md) - Manage addon registry.
|
||||
* [vela addon status](vela_addon_status.md) - get an addon's status.
|
||||
* [vela addon upgrade](vela_addon_upgrade.md) - upgrade an addon
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: vela addon disable
|
||||
---
|
||||
|
||||
disable an addon
|
||||
|
||||
### Synopsis
|
||||
|
||||
disable an addon in cluster.
|
||||
|
||||
```
|
||||
vela addon disable [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela addon disable <addon-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --force skip checking if applications are still using this addon
|
||||
-h, --help help for disable
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
title: vela addon enable
|
||||
---
|
||||
|
||||
enable an addon
|
||||
|
||||
### Synopsis
|
||||
|
||||
enable an addon in cluster.
|
||||
|
||||
```
|
||||
vela addon enable [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
Enable addon by:
|
||||
vela addon enable <addon-name>
|
||||
Enable addon with specify version:
|
||||
vela addon enable <addon-name> --version <addon-version>
|
||||
Enable addon for specific clusters, (local means control plane):
|
||||
vela addon enable <addon-name> --clusters={local,cluster1,cluster2}
|
||||
Enable addon locally:
|
||||
vela addon enable <your-local-addon-path>
|
||||
Enable addon with specified args (the args should be defined in addon's parameters):
|
||||
vela addon enable <addon-name> <my-parameter-of-addon>=<my-value>
|
||||
Enable addon with specified registry:
|
||||
vela addon enable <registryName>/<addonName>
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-c, --clusters string specify the runtime-clusters to enable
|
||||
--dry-run render all yaml files out without real execute it
|
||||
-h, --help help for enable
|
||||
--override-definitions override existing definitions if conflict with those contained in this addon
|
||||
-s, --skip-version-validating skip validating system version requirement
|
||||
-v, --version string specify the addon version to enable
|
||||
-y, --yes all checks will be skipped and the default answer is yes for all validation check.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
---
|
||||
title: vela addon init
|
||||
---
|
||||
|
||||
create an addon scaffold
|
||||
|
||||
### Synopsis
|
||||
|
||||
Create an addon scaffold for quick starting.
|
||||
|
||||
```
|
||||
vela addon init [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
Store the scaffold in a different directory:
|
||||
vela addon init mongodb -p path/to/addon
|
||||
|
||||
Add a Helm component:
|
||||
vela addon init mongodb --helm-repo https://marketplace.azurecr.io/helm/v1/repo --chart mongodb --chart-version 12.1.16
|
||||
|
||||
Add resources from URL using ref-objects component
|
||||
vela addon init my-addon --url https://domain.com/resource.yaml
|
||||
|
||||
Use --no-samples options to skip creating sample files
|
||||
vela addon init my-addon --no-sample
|
||||
|
||||
You can combine all the options together.
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--chart string Helm Chart name
|
||||
--chart-version string version of the Chart
|
||||
-f, --force overwrite existing addon files
|
||||
--helm-repo string URL that points to a Helm repo
|
||||
-h, --help help for init
|
||||
--no-samples do not generate sample files
|
||||
-p, --path string path to the addon directory (default is ./<addon-name>)
|
||||
-u, --url stringArray add URL resources using ref-object component
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: vela addon list
|
||||
---
|
||||
|
||||
List addons
|
||||
|
||||
### Synopsis
|
||||
|
||||
List addons in KubeVela
|
||||
|
||||
```
|
||||
vela addon list [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
List addon by:
|
||||
vela addon ls
|
||||
List addons in a specific registry, useful to reveal addons with duplicated names:
|
||||
vela addon ls --registry <registry-name>
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
-r, --registry string specify the registry name to list
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela addon package
|
||||
---
|
||||
|
||||
package an addon directory
|
||||
|
||||
### Synopsis
|
||||
|
||||
package an addon directory into a helm chart archive.
|
||||
|
||||
```
|
||||
vela addon package [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela addon package <addon directory>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for package
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,80 @@
|
|||
---
|
||||
title: vela addon push
|
||||
---
|
||||
|
||||
uploads an addon package to ChartMuseum
|
||||
|
||||
### Synopsis
|
||||
|
||||
Uploads an addon package to ChartMuseum.
|
||||
|
||||
Two arguments are needed <addon directory/package> and <name/URL of ChartMuseum>.
|
||||
|
||||
The first argument <addon directory/package> can be:
|
||||
- your conventional addon directory (containing metadata.yaml). We will package it for you.
|
||||
- packaged addon (.tgz) generated by 'vela addon package' command
|
||||
|
||||
The second argument <name/URL of ChartMuseum> can be:
|
||||
- registry name (helm type). You can add your ChartMuseum registry using 'vela addon registry add'.
|
||||
- ChartMuseum URL, e.g. http://localhost:8080
|
||||
|
||||
```
|
||||
vela addon push [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Push the addon in directory <your-addon> to a ChartMuseum registry named <localcm>
|
||||
$ vela addon push your-addon localcm
|
||||
|
||||
# Push packaged addon mongo-1.0.0.tgz to a ChartMuseum registry at http://localhost:8080
|
||||
$ vela addon push mongo-1.0.0.tgz http://localhost:8080
|
||||
|
||||
# Force push, overwriting existing ones
|
||||
$ vela addon push your-addon localcm -f
|
||||
|
||||
# If you already written your own Chart.yaml and don't want us to generate it for you:
|
||||
$ vela addon push your-addon localcm --keep-chartmeta
|
||||
# Note: when using .tgz packages, we will always keep the original Chart.yaml
|
||||
|
||||
# In addition to cli flags, you can also use environment variables
|
||||
$ HELM_REPO_USERNAME=name HELM_REPO_PASSWORD=pswd vela addon push mongo-1.0.0.tgz http://localhost:8080
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--access-token string send token in Authorization header [$HELM_REPO_ACCESS_TOKEN]
|
||||
-a, --app-version string override app version pre-push
|
||||
--auth-header string alternative header to use for token auth [$HELM_REPO_AUTH_HEADER]
|
||||
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle [$HELM_REPO_CA_FILE]
|
||||
--cert-file string identify HTTPS client using this SSL certificate file [$HELM_REPO_CERT_FILE]
|
||||
--context-path string ChartMuseum context path [$HELM_REPO_CONTEXT_PATH]
|
||||
-f, --force force upload even if chart version exists
|
||||
-h, --help help for push
|
||||
--insecure connect to server with an insecure way by skipping certificate verification [$HELM_REPO_INSECURE]
|
||||
--keep-chartmeta do not update Chart.yaml automatically according to addon metadata (only when addon dir provided)
|
||||
--key-file string identify HTTPS client using this SSL key file [$HELM_REPO_KEY_FILE]
|
||||
-p, --password string override HTTP basic auth password [$HELM_REPO_PASSWORD]
|
||||
-t, --timeout int The duration (in seconds) vela cli will wait to get response from ChartMuseum (default 30)
|
||||
--use-http use HTTP
|
||||
-u, --username string override HTTP basic auth username [$HELM_REPO_USERNAME]
|
||||
-v, --version string override chart version pre-push
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: vela addon registry
|
||||
---
|
||||
|
||||
Manage addon registry.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage addon registry.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for registry
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
* [vela addon registry add](vela_addon_registry_add.md) - Add an addon registry.
|
||||
* [vela addon registry delete](vela_addon_registry_delete.md) - Delete an addon registry
|
||||
* [vela addon registry get](vela_addon_registry_get.md) - Get an addon registry.
|
||||
* [vela addon registry list](vela_addon_registry_list.md) - List addon registries.
|
||||
* [vela addon registry update](vela_addon_registry_update.md) - Update an addon registry.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
title: vela addon registry add
|
||||
---
|
||||
|
||||
Add an addon registry.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Add an addon registry.
|
||||
|
||||
```
|
||||
vela addon registry add [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
add a helm repo registry: vela addon registry add --type=helm my-repo --endpoint=<URL>
|
||||
add a github registry: vela addon registry add my-repo --type git --endpoint=<URL> --path=<path> --gitToken=<git token>
|
||||
add a specified github registry: vela addon registry add my-repo --type git --endpoint=https://github.com/kubevela/catalog --path=addons --gitToken=<git token>
|
||||
add a gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=<URL> --gitlabRepoName=<repoName> --path=<path> --gitToken=<git token>
|
||||
add a specified gitlab registry: vela addon registry add my-repo --type gitlab --endpoint=http://gitlab.xxx.com/xxx/catalog --path=addons --gitlabRepoName=catalog --gitToken=<git token>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--bucket string specify the OSS bucket name
|
||||
--endpoint string specify the addon registry endpoint
|
||||
--gitToken string specify the github repo token
|
||||
--gitlabRepoName string specify the gitlab addon registry repoName, must be set when registry is gitlab
|
||||
-h, --help help for add
|
||||
--insecureSkipTLS specify the Helm addon registry skip tls verify
|
||||
--password string specify the Helm addon registry password
|
||||
--path string specify the addon registry path, must be set when addons are not in root of registry
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon registry](vela_addon_registry.md) - Manage addon registry.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela addon registry delete
|
||||
---
|
||||
|
||||
Delete an addon registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
Delete an addon registry
|
||||
|
||||
```
|
||||
vela addon registry delete [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela addon registry delete <registry-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon registry](vela_addon_registry.md) - Manage addon registry.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela addon registry get
|
||||
---
|
||||
|
||||
Get an addon registry.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Get an addon registry.
|
||||
|
||||
```
|
||||
vela addon registry get [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela addon registry get <registry name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for get
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon registry](vela_addon_registry.md) - Manage addon registry.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela addon registry list
|
||||
---
|
||||
|
||||
List addon registries.
|
||||
|
||||
### Synopsis
|
||||
|
||||
List addon registries.
|
||||
|
||||
```
|
||||
vela addon registry list [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela addon registry list
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon registry](vela_addon_registry.md) - Manage addon registry.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: vela addon registry update
|
||||
---
|
||||
|
||||
Update an addon registry.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Update an addon registry.
|
||||
|
||||
```
|
||||
vela addon registry update [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela addon registry update <registry-name> --type OSS --endpoint=<URL> --bucket=<bucket name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--bucket string specify the OSS bucket name
|
||||
--endpoint string specify the addon registry endpoint
|
||||
--gitToken string specify the github repo token
|
||||
--gitlabRepoName string specify the gitlab addon registry repoName, must be set when registry is gitlab
|
||||
-h, --help help for update
|
||||
--insecureSkipTLS specify the Helm addon registry skip tls verify
|
||||
--password string specify the Helm addon registry password
|
||||
--path string specify the addon registry path, must be set when addons are not in root of registry
|
||||
--type string specify the addon registry type
|
||||
--username string specify the Helm addon registry username
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon registry](vela_addon_registry.md) - Manage addon registry.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: vela addon status
|
||||
---
|
||||
|
||||
get an addon's status.
|
||||
|
||||
### Synopsis
|
||||
|
||||
get an addon's status from cluster.
|
||||
|
||||
```
|
||||
vela addon status [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela addon status <addon-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for status
|
||||
-v, --verbose show addon descriptions and parameters in addition to status
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
title: vela addon upgrade
|
||||
---
|
||||
|
||||
upgrade an addon
|
||||
|
||||
### Synopsis
|
||||
|
||||
upgrade an addon in cluster.
|
||||
|
||||
```
|
||||
vela addon upgrade [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
|
||||
Upgrade addon by:
|
||||
vela addon upgrade <addon-name>
|
||||
Upgrade addon with specify version:
|
||||
vela addon upgrade <addon-name> --version <addon-version>
|
||||
Upgrade addon for specific clusters, (local means control plane):
|
||||
vela addon upgrade <addon-name> --clusters={local,cluster1,cluster2}
|
||||
Upgrade addon locally:
|
||||
vela addon upgrade <your-local-addon-path>
|
||||
Upgrade addon with specified args (the args should be defined in addon's parameters):
|
||||
vela addon upgrade <addon-name> <my-parameter-of-addon>=<my-value>
|
||||
The specified args will be merged with legacy args, what user specified in 'vela addon enable', and non-empty legacy arg will be overridden by
|
||||
non-empty new arg
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-c, --clusters string specify the runtime-clusters to upgrade
|
||||
-h, --help help for upgrade
|
||||
--override-definitions override existing definitions if conflict with those contained in this addon
|
||||
-s, --skip-version-validating skip validating system version requirement
|
||||
-v, --version string specify the addon version to upgrade
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela addon](vela_addon.md) - Manage addons for extension.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,113 @@
|
|||
---
|
||||
title: vela adopt
|
||||
---
|
||||
|
||||
Adopt resources into new application.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Adopt resources into applications
|
||||
|
||||
Adopt resources into a KubeVela application. This command is useful when you already have resources applied in your Kubernetes cluster. These resources could be applied natively or with other tools, such as Helm. This command will automatically find out the resources to be adopted and assemble them into a new application which won't trigger any damage such as restart on the adoption.
|
||||
|
||||
There are two types of adoption supported by far, 'native' Kubernetes resources (by default) and 'helm' releases. 1. For 'native' type, you can specify a list of resources you want to adopt in the application. Only resources in local cluster are supported for now. 2. For 'helm' type, you can specify a helm release name. This helm release should be already published in the local cluster. The command will find the resources managed by the helm release and convert them into an adoption application.
|
||||
|
||||
There are two working mechanism (called 'modes' here) for the adoption by far, 'read-only' mode (by default) and 'take-over' mode. 1. In 'read-only' mode, adopted resources will not be touched. You can leverage vela tools (like Vela CLI or VelaUX) to observe those resources and attach traits to add new capabilities. The adopted resources will not be recycled or updated. This mode is recommended if you still want to keep using other tools to manage resources updates or deletion, like Helm. 2. In 'take-over' mode, adopted resources are completely managed by application which means they can be modified. You can use traits or directly modify the component to make edits to those resources. This mode can be helpful if you want to migrate existing resources into KubeVela system and let KubeVela to handle the life-cycle of target resources.
|
||||
|
||||
The adopted application can be customized. You can provide a CUE template file to the command and make your own assemble rules for the adoption application. You can refer to https://github.com/kubevela/kubevela/blob/master/references/cli/adopt-templates/default.cue to see the default implementation of adoption rules.
|
||||
|
||||
If you want to adopt all resources with resource topology rule to Applications, you can use: 'vela adopt --all'. The resource topology rule can be customized by '--resource-topology-rule' flag.
|
||||
|
||||
```
|
||||
vela adopt [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Native Resources Adoption
|
||||
|
||||
## Adopt resources into new application
|
||||
|
||||
## Adopt all resources to Applications with resource topology rule
|
||||
## Use: vela adopt <resources-type> --all
|
||||
vela adopt --all
|
||||
vela adopt deployment --all --resource-topology-rule myrule.cue
|
||||
|
||||
## Use: vela adopt <resources-type>[/<resource-cluster>][/<resource-namespace>]/<resource-name> <resources-type>[/<resource-cluster>][/<resource-namespace>]/<resource-name> ...
|
||||
vela adopt deployment/my-app configmap/my-app
|
||||
|
||||
## Adopt resources into new application with specified app name
|
||||
vela adopt deployment/my-deploy configmap/my-config --app-name my-app
|
||||
|
||||
## Adopt resources into new application in specified namespace
|
||||
vela adopt deployment/my-app configmap/my-app -n demo
|
||||
|
||||
## Adopt resources into new application across multiple namespace
|
||||
vela adopt deployment/ns-1/my-app configmap/ns-2/my-app
|
||||
|
||||
## Adopt resources into new application with take-over mode
|
||||
vela adopt deployment/my-app configmap/my-app --mode take-over
|
||||
|
||||
## Adopt resources into new application and apply it into cluster
|
||||
vela adopt deployment/my-app configmap/my-app --apply
|
||||
|
||||
-----------------------------------------------------------
|
||||
|
||||
# Helm Chart Adoption
|
||||
|
||||
## Adopt all helm releases to Applications with resource topology rule
|
||||
## Use: vela adopt <resources-type> --all
|
||||
vela adopt --all --type helm
|
||||
vela adopt my-chart --all --resource-topology-rule myrule.cue --type helm
|
||||
|
||||
## Adopt resources in a deployed helm chart
|
||||
vela adopt my-chart -n my-namespace --type helm
|
||||
|
||||
## Adopt resources in a deployed helm chart with take-over mode
|
||||
vela adopt my-chart --type helm --mode take-over
|
||||
|
||||
## Adopt resources in a deployed helm chart in an application and apply it into cluster
|
||||
vela adopt my-chart --type helm --apply
|
||||
|
||||
## Adopt resources in a deployed helm chart in an application, apply it into cluster, and recycle the old helm release after the adoption application successfully runs
|
||||
vela adopt my-chart --type helm --apply --recycle
|
||||
|
||||
-----------------------------------------------------------
|
||||
|
||||
## Customize your adoption rules
|
||||
vela adopt my-chart -n my-namespace --type helm --adopt-template my-rules.cue
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--adopt-template string The CUE template for adoption. If not provided, the default template will be used when --auto is switched on.
|
||||
--all Adopt all resources in the namespace
|
||||
--app-name string The name of application for adoption. If empty for helm type adoption, it will inherit the helm chart's name.
|
||||
--apply If true, the application for adoption will be applied. Otherwise, it will only be printed.
|
||||
-d, --driver string The storage backend of helm adoption. Only take effect when --type=helm.
|
||||
-e, --env string The environment name for the CLI request
|
||||
-h, --help help for adopt
|
||||
-m, --mode string The mode of adoption. Available values: [read-only, take-over] (default "read-only")
|
||||
-n, --namespace string If present, the namespace scope for this CLI request
|
||||
--recycle If true, when the adoption application is successfully applied, the old storage (like Helm secret) will be recycled.
|
||||
--resource-topology-rule string The CUE template for specify the rule of the resource topology. If not provided, the default rule will be used.
|
||||
-t, --type string The type of adoption. Available values: [native, helm] (default "native")
|
||||
-y, --yes Skip confirmation prompt
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
title: vela auth
|
||||
---
|
||||
|
||||
Manage identity and authorizations.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for auth
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela auth gen-kubeconfig](vela_auth_gen-kubeconfig.md) - Generate kubeconfig for user
|
||||
* [vela auth grant-privileges](vela_auth_grant-privileges.md) - Grant privileges for user/group/serviceaccount
|
||||
* [vela auth list-privileges](vela_auth_list-privileges.md) - List privileges for user/group/serviceaccount
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
title: vela auth gen-kubeconfig
|
||||
---
|
||||
|
||||
Generate kubeconfig for user
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate kubeconfig for user
|
||||
|
||||
Generate a new kubeconfig with specified identity. By default, the generated kubeconfig will reuse the certificate-authority-data in the cluster config from the current used kubeconfig. All contexts, clusters and users that are not in use will not be included in the generated kubeconfig.
|
||||
|
||||
To generate a new kubeconfig for given user and groups, use the --user and --group flag. Multiple --group flags is allowed. The group kubevela:client is added to the groups by default. The identity in the current kubeconfig should be able to approve CertificateSigningRequest in the kubernetes cluster. See https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/ for details.
|
||||
|
||||
To generate a kubeconfig based on existing ServiceAccount in your cluster, use the --serviceaccount flag. The corresponding secret token and ca data will be embedded in the generated kubeconfig, which allows you to act as the serviceaccount.
|
||||
|
||||
```
|
||||
vela auth gen-kubeconfig
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Generate a kubeconfig with provided user
|
||||
vela auth gen-kubeconfig --user new-user
|
||||
|
||||
# Generate a kubeconfig with provided user and group
|
||||
vela auth gen-kubeconfig --user new-user --group kubevela:developer
|
||||
|
||||
# Generate a kubeconfig with provided user and groups
|
||||
vela auth gen-kubeconfig --user new-user --group kubevela:developer --group my-org:my-team
|
||||
|
||||
# Generate a kubeconfig with provided serviceaccount
|
||||
vela auth gen-kubeconfig --serviceaccount default -n demo
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string The environment name for the CLI request
|
||||
-g, --group --user The groups of the generated kubeconfig. This flag only works when --user is set. It will be embedded as the Organization in the X509 certificate.
|
||||
-h, --help help for gen-kubeconfig
|
||||
-n, --namespace --serviceaccount The namespace of the serviceaccount. This flag only works when --serviceaccount is set.
|
||||
--serviceaccount --user The serviceaccount of the generated kubeconfig. If set, a kubeconfig will be generated based on the secret token of the serviceaccount. Cannot be set when --user presents.
|
||||
-u, --user string The user of the generated kubeconfig. If set, an X509-based kubeconfig will be intended to create. It will be embedded as the Subject in the X509 certificate.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela auth](vela_auth.md) - Manage identity and authorizations.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
---
|
||||
title: vela auth grant-privileges
|
||||
---
|
||||
|
||||
Grant privileges for user/group/serviceaccount
|
||||
|
||||
### Synopsis
|
||||
|
||||
Grant privileges for user
|
||||
|
||||
Grant privileges to user/group/serviceaccount. By using --for-namespace and --for-cluster, you can grant all read/write privileges for all resources in the specified namespace and cluster. If --for-namespace is not set, the privileges will be granted cluster-wide.
|
||||
|
||||
Setting --create-namespace will automatically create namespace if the namespace of the granted privilege does not exists. By default, this flag is not enabled and errors will be returned if the namespace is not found in the corresponding cluster.
|
||||
|
||||
Setting --readonly will only grant read privileges for all resources in the destination. This can be useful if you want to give somebody the privileges to view resources but do not want to allow them to edit any resource.
|
||||
|
||||
If multiple identity information are set, all the identity information will be bond to the intended privileges respectively.
|
||||
|
||||
If --kubeconfig is set, the user/serviceaccount information in the kubeconfig will be used as the identity to grant privileges. Groups will be ignored.
|
||||
|
||||
```
|
||||
vela auth grant-privileges
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Grant privileges for User alice in the namespace demo of the control plane
|
||||
vela auth grant-privileges --user alice --for-namespace demo
|
||||
|
||||
# Grant privileges for User alice in the namespace demo in cluster-1, create demo namespace if not exist
|
||||
vela auth grant-privileges --user alice --for-namespace demo --for-cluster cluster-1 --create-namespace
|
||||
|
||||
# Grant cluster-scoped privileges for Group org:dev-team in the control plane
|
||||
vela auth grant-privileges --group org:dev-team
|
||||
|
||||
# Grant privileges for Group org:dev-team and org:test-team in the namespace test on the control plane and managed cluster example-cluster
|
||||
vela auth grant-privileges --group org:dev-team --group org:test-team --for-namespace test --for-cluster local --for-cluster example-cluster
|
||||
|
||||
# Grant read privileges for ServiceAccount observer in test namespace on the control plane
|
||||
vela auth grant-privileges --serviceaccount observer -n test --for-namespace test --readonly
|
||||
|
||||
# Grant privileges for identity in kubeconfig in cluster-1
|
||||
vela auth grant-privileges --kubeconfig ./example.kubeconfig --for-cluster cluster-1
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--create-namespace If set, non-exist namespace will be created automatically.
|
||||
-e, --env string The environment name for the CLI request
|
||||
--for-cluster strings The clusters privileges to grant. If empty, the control plane will be used.
|
||||
--for-namespace strings The namespaces privileges to grant. If empty, cluster-scoped privileges will be granted.
|
||||
-g, --group strings The group to grant privileges.
|
||||
-h, --help help for grant-privileges
|
||||
--kubeconfig string The kubeconfig to grant privileges. If set, it will override all the other identity flags.
|
||||
-n, --namespace --serviceaccount The namespace of the serviceaccount. This flag only works when --serviceaccount is set.
|
||||
--readonly If set, only read privileges of resources will be granted. Otherwise, read/write privileges will be granted.
|
||||
--serviceaccount string The serviceaccount to grant privileges.
|
||||
-u, --user string The user to grant privileges.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela auth](vela_auth.md) - Manage identity and authorizations.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
title: vela auth list-privileges
|
||||
---
|
||||
|
||||
List privileges for user/group/serviceaccount
|
||||
|
||||
### Synopsis
|
||||
|
||||
List privileges for user
|
||||
|
||||
List privileges that user has in clusters. Use --user/--group to check the privileges for specified user and group. They can be jointly configured to see the union of privileges. Use --serviceaccount and -n/--namespace to see the privileges for ServiceAccount. You can also use --kubeconfig to use the identity inside implicitly. The privileges will be shown in tree format.
|
||||
|
||||
This command supports listing privileges across multiple clusters, by using --cluster. If not set, the control plane will be used. This feature requires cluster-gateway to be properly setup to use.
|
||||
|
||||
The privileges are collected through listing all ClusterRoleBinding and RoleBinding, following the Kubernetes RBAC Authorization. Other authorization mechanism is not supported now. See https://kubernetes.io/docs/reference/access-authn-authz/rbac/ for details.
|
||||
|
||||
The ClusterRoleBinding and RoleBinding that matches the specified identity will be tracked. Related ClusterRoles and Roles are retrieved and the contained PolicyRules are demonstrated.
|
||||
|
||||
```
|
||||
vela auth list-privileges
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# List privileges for User alice in the control plane
|
||||
vela auth list-privileges --user alice
|
||||
|
||||
# List privileges for Group org:dev-team in the control plane
|
||||
vela auth list-privileges --group org:dev-team
|
||||
|
||||
# List privileges for User bob with Groups org:dev-team and org:test-team in the control plane and managed cluster example-cluster
|
||||
vela auth list-privileges --user bob --group org:dev-team --group org:test-team --cluster local --cluster example-cluster
|
||||
|
||||
# List privileges for ServiceAccount example-sa in demo namespace in multiple managed clusters
|
||||
vela auth list-privileges --serviceaccount example-sa -n demo --cluster cluster-1 --cluster cluster-2
|
||||
|
||||
# List privileges for identity in kubeconfig
|
||||
vela auth list-privileges --kubeconfig ./example.kubeconfig --cluster local --cluster cluster-1
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-c, --cluster strings The cluster to list privileges. If not set, the command will list privileges in the control plane. (default [local])
|
||||
-e, --env string The environment name for the CLI request
|
||||
-g, --group strings The group to list privileges. Can be set together with --user.
|
||||
-h, --help help for list-privileges
|
||||
--kubeconfig string The kubeconfig to list privileges. If set, it will override all the other identity flags.
|
||||
-n, --namespace --serviceaccount The namespace of the serviceaccount. This flag only works when --serviceaccount is set.
|
||||
--serviceaccount string The serviceaccount to list privileges. Cannot be set with --user and --group.
|
||||
-u, --user string The user to list privileges.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela auth](vela_auth.md) - Manage identity and authorizations.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: vela cluster
|
||||
---
|
||||
|
||||
Manage Kubernetes clusters.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage Kubernetes clusters for continuous delivery.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for cluster
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela cluster alias](vela_cluster_alias.md) - alias a named cluster.
|
||||
* [vela cluster detach](vela_cluster_detach.md) - detach managed cluster.
|
||||
* [vela cluster export-config](vela_cluster_export-config.md) - Export multi-cluster kubeconfig.
|
||||
* [vela cluster join](vela_cluster_join.md) - join managed cluster.
|
||||
* [vela cluster labels](vela_cluster_labels.md) - Manage Kubernetes Cluster Labels.
|
||||
* [vela cluster list](vela_cluster_list.md) - list managed clusters.
|
||||
* [vela cluster probe](vela_cluster_probe.md) - health probe managed cluster.
|
||||
* [vela cluster rename](vela_cluster_rename.md) - rename managed cluster.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
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
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: vela cluster detach
|
||||
---
|
||||
|
||||
detach managed cluster.
|
||||
|
||||
### Synopsis
|
||||
|
||||
detach managed cluster.
|
||||
|
||||
```
|
||||
vela cluster detach [CLUSTER_NAME] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for detach
|
||||
-p, --kubeconfig-path string Specify the kubeconfig path of managed cluster. If you use ocm to manage your cluster, you must set the kubeconfig-path.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
title: vela cluster export-config
|
||||
---
|
||||
|
||||
Export multi-cluster kubeconfig.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Export multi-cluster kubeconfig
|
||||
|
||||
Load existing cluster kubeconfig and list clusters registered in KubeVela. Export the proxy access of these clusters to KubeConfig and print it out.
|
||||
|
||||
```
|
||||
vela cluster export-config [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Export all clusters to kubeconfig
|
||||
vela cluster export-config
|
||||
|
||||
# Export clusters with specified kubeconfig
|
||||
KUBECONFIG=./my-hub-cluster.kubeconfig vela cluster export-config
|
||||
|
||||
# Export clusters with specified labels
|
||||
vela cluster export-config -l gpu-cluster=true
|
||||
|
||||
# Export clusters to kubeconfig and save in file
|
||||
vela cluster export-config > my-vela.kubeconfig
|
||||
|
||||
# Use the exported kubeconfig in kubectl
|
||||
KUBECONFIG=my-vela.kubeconfig kubectl get namespaces --cluster c2
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for export-config
|
||||
-l, --selector string LabelSelector for select clusters to export.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: vela cluster join
|
||||
---
|
||||
|
||||
join managed cluster.
|
||||
|
||||
### Synopsis
|
||||
|
||||
join managed cluster by kubeconfig.
|
||||
|
||||
```
|
||||
vela cluster join [KUBECONFIG] [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Join cluster declared in my-child-cluster.kubeconfig
|
||||
> vela cluster join my-child-cluster.kubeconfig --name example-cluster
|
||||
> vela cluster join my-child-cluster.kubeconfig --name example-cluster --labels project=kubevela,owner=oam-dev
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--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)
|
||||
--labels string Specifies the labels need to create in managedCluster
|
||||
-n, --name string Specify the cluster name. If empty, it will use the cluster name in config file. Default to be empty.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
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
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
* [vela cluster labels add](vela_cluster_labels_add.md) - add labels to managed cluster.
|
||||
* [vela cluster labels del](vela_cluster_labels_del.md) - Delete labels for managed cluster.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
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
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster labels](vela_cluster_labels.md) - Manage Kubernetes Cluster Labels.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
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
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster labels](vela_cluster_labels.md) - Manage Kubernetes Cluster Labels.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: vela cluster list
|
||||
---
|
||||
|
||||
list managed clusters.
|
||||
|
||||
### Synopsis
|
||||
|
||||
list worker clusters managed by KubeVela.
|
||||
|
||||
```
|
||||
vela cluster list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for list
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: vela cluster probe
|
||||
---
|
||||
|
||||
health probe managed cluster.
|
||||
|
||||
### Synopsis
|
||||
|
||||
health probe managed cluster.
|
||||
|
||||
```
|
||||
vela cluster probe [CLUSTER_NAME] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for probe
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: vela cluster rename
|
||||
---
|
||||
|
||||
rename managed cluster.
|
||||
|
||||
### Synopsis
|
||||
|
||||
rename managed cluster.
|
||||
|
||||
```
|
||||
vela cluster rename [OLD_NAME] [NEW_NAME] [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for rename
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cluster](vela_cluster.md) - Manage Kubernetes clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: vela completion
|
||||
---
|
||||
|
||||
Output shell completion code for the specified shell (bash or zsh).
|
||||
|
||||
### Synopsis
|
||||
|
||||
Output shell completion code for the specified shell (bash or zsh).
|
||||
The shell code must be evaluated to provide interactive completion of vela commands.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for completion
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela completion bash](vela_completion_bash.md) - generate autocompletions script for bash
|
||||
* [vela completion zsh](vela_completion_zsh.md) - generate autocompletions script for zsh
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: vela completion bash
|
||||
---
|
||||
|
||||
generate autocompletions script for bash
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for Vela for the bash shell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
$ source <(vela completion bash)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
Linux:
|
||||
$ vela completion bash > /etc/bash_completion.d/vela
|
||||
MacOS:
|
||||
$ vela completion bash > /usr/local/etc/bash_completion.d/vela
|
||||
|
||||
|
||||
```
|
||||
vela completion bash
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for bash
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela completion](vela_completion.md) - Output shell completion code for the specified shell (bash or zsh).
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: vela completion zsh
|
||||
---
|
||||
|
||||
generate autocompletions script for zsh
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate the autocompletion script for Vela for the zsh shell.
|
||||
|
||||
To load completions in your current shell session:
|
||||
$ source <(vela completion zsh)
|
||||
|
||||
To load completions for every new session, execute once:
|
||||
$ vela completion zsh > "${fpath[1]}/_vela"
|
||||
|
||||
|
||||
```
|
||||
vela completion zsh
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for zsh
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela completion](vela_completion.md) - Output shell completion code for the specified shell (bash or zsh).
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: vela component
|
||||
---
|
||||
|
||||
List/get components.
|
||||
|
||||
### Synopsis
|
||||
|
||||
List component types installed and discover more in registry.
|
||||
|
||||
```
|
||||
vela component [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela comp
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--discover discover traits in registries
|
||||
-h, --help help for component
|
||||
--label --label type=terraform a label to filter components, the format is --label type=terraform
|
||||
--registry string specify the registry name (default "default")
|
||||
--token string specify token when using --url to specify registry url
|
||||
--url string specify the registry URL
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela component get](vela_component_get.md) - get component from registry
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: vela component get
|
||||
---
|
||||
|
||||
get component from registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
get/download/install component from registry.
|
||||
|
||||
```
|
||||
vela component get <component> [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela comp get <component>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for get
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
--registry string specify the registry name (default "default")
|
||||
--token string specify token when using --url to specify registry url
|
||||
--url string specify the registry URL
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela component](vela_component.md) - List/get components.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: vela config-template
|
||||
---
|
||||
|
||||
Manage the template of config.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config-template
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela config-template apply](vela_config-template_apply.md) - Apply a config template.
|
||||
* [vela config-template delete](vela_config-template_delete.md) - Delete a config template.
|
||||
* [vela config-template list](vela_config-template_list.md) - List the config templates.
|
||||
* [vela config-template show](vela_config-template_show.md) - Show the documents of the template properties
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: vela config-template apply
|
||||
---
|
||||
|
||||
Apply a config template.
|
||||
|
||||
```
|
||||
vela config-template apply [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --file string specify the template file name
|
||||
-h, --help help for apply
|
||||
--name string specify the config template name
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template.md) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: vela config-template delete
|
||||
---
|
||||
|
||||
Delete a config template.
|
||||
|
||||
```
|
||||
vela config-template delete [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config template delete <name> [-n vela-system]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template.md) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: vela config-template list
|
||||
---
|
||||
|
||||
List the config templates.
|
||||
|
||||
```
|
||||
vela config-template list [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config template list [-A]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-h, --help help for list
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template.md) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: vela config-template show
|
||||
---
|
||||
|
||||
Show the documents of the template properties
|
||||
|
||||
```
|
||||
vela config-template show [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela config-template show <name> [-n]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for show
|
||||
-n, --namespace string specify the namespace of the template (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config-template](vela_config-template.md) - Manage the template of config.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: vela config
|
||||
---
|
||||
|
||||
Manage the configs.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage the configs, such as the terraform provider, image registry, helm repository, etc.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela config create](vela_config_create.md) - Create a config.
|
||||
* [vela config delete](vela_config_delete.md) - Delete a config.
|
||||
* [vela config distribute](vela_config_distribute.md) - Distribute a config
|
||||
* [vela config list](vela_config_list.md) - List the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
title: vela config create
|
||||
---
|
||||
|
||||
Create a config.
|
||||
|
||||
```
|
||||
vela config create [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Generate a config with the args
|
||||
vela config create test-registry --template=image-registry registry=index.docker.io auth.username=test auth.password=test
|
||||
|
||||
# Generate a config with the file
|
||||
vela config create test-config --template=image-registry -f config.yaml
|
||||
|
||||
# Generate a config without the template
|
||||
vela config create test-vela -f config.yaml
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--alias string specify the alias of the config
|
||||
--description string specify the description of the config
|
||||
--dry-run Dry run to apply the config
|
||||
-f, --file string specify the file name of the config properties
|
||||
-h, --help help for create
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
--target stringArray this config will be distributed if this flag is set
|
||||
-t, --template string specify the config template name and namespace
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config.md) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: vela config delete
|
||||
---
|
||||
|
||||
Delete a config.
|
||||
|
||||
```
|
||||
vela config delete [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
--not-recall means only deleting the config from the local and do not recall from targets.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config.md) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: vela config distribute
|
||||
---
|
||||
|
||||
Distribute a config
|
||||
|
||||
```
|
||||
vela config distribute [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# distribute the config(test-registry) from the vela-system namespace to the default namespace in the local cluster.
|
||||
vela config d test-registry -t default
|
||||
|
||||
# distribute the config(test-registry) from the vela-system namespace to the other clusters.
|
||||
vela config d test-registry -t cluster1/default -t cluster2/default
|
||||
|
||||
# recall the config
|
||||
vela config d test-registry --recall
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for distribute
|
||||
-n, --namespace string specify the namespace of the distribution (default "vela-system")
|
||||
-r, --recall this field means recalling the configs from all targets.
|
||||
-t, --target stringArray specify the targets that want to distribute,the format is: <clusterName>/<namespace>
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config.md) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: vela config list
|
||||
---
|
||||
|
||||
List the configs.
|
||||
|
||||
```
|
||||
vela config list [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-h, --help help for list
|
||||
-n, --namespace string specify the namespace of the config (default "vela-system")
|
||||
-t, --template string specify the template of the config
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela config](vela_config.md) - Manage the configs.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
title: vela cuex
|
||||
---
|
||||
|
||||
Manage CueX engine for compile.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for cuex
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela cuex eval](vela_cuex_eval.md) - Eval cue file with CueX engine.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: vela cuex eval
|
||||
---
|
||||
|
||||
Eval cue file with CueX engine.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Eval cue file with CueX engine.
|
||||
|
||||
Evaluate your cue file with the CueX engine. When your cue file does not use KubeVela's extension, it will work similarly to the native CUE CLI. When using KubeVela's extensions, this command will execute the extension functions and resolve values, in addition to the native CUE compile process.
|
||||
|
||||
```
|
||||
vela cuex eval [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Evaluate a cue file
|
||||
vela cuex eval -f my.cue
|
||||
|
||||
# Evaluate a cue file into json format
|
||||
vela cuex eval -f my.cue -o json
|
||||
|
||||
# Evaluate a cue file and output the target path
|
||||
vela cuex eval -f my.cue -p key.path
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --file string file for eval
|
||||
-o, --format string format of the output (default "cue")
|
||||
-h, --help help for eval
|
||||
-p, --path string path for eval
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela cuex](vela_cuex.md) - Manage CueX engine for compile.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: vela debug
|
||||
---
|
||||
|
||||
Debug running application.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Debug running application with debug policy.
|
||||
|
||||
```
|
||||
vela debug [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela debug <application-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
-f, --focus string specify the focus value to debug, only valid for application with workflow
|
||||
-h, --help help for debug
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-s, --step string specify the step or component to debug
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: vela def
|
||||
---
|
||||
|
||||
Manage definitions.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage X-Definitions for extension.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for def
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela def apply](vela_def_apply.md) - Apply X-Definition.
|
||||
* [vela def del](vela_def_del.md) - Delete X-Definition.
|
||||
* [vela def edit](vela_def_edit.md) - Edit X-Definition.
|
||||
* [vela def gen-api](vela_def_gen-api.md) - Generate SDK from X-Definition.
|
||||
* [vela def gen-cue](vela_def_gen-cue.md) - Generate CUE schema from Go code.
|
||||
* [vela def gen-doc](vela_def_gen-doc.md) - Generate documentation for non component, trait, policy and workflow definitions
|
||||
* [vela def get](vela_def_get.md) - Get definition
|
||||
* [vela def init](vela_def_init.md) - Init a new definition
|
||||
* [vela def list](vela_def_list.md) - List definitions.
|
||||
* [vela def render](vela_def_render.md) - Render X-Definition.
|
||||
* [vela def show](vela_def_show.md) - Show the reference doc for a component, trait, policy or workflow.
|
||||
* [vela def vet](vela_def_vet.md) - Validate X-Definition.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
title: vela def apply
|
||||
---
|
||||
|
||||
Apply X-Definition.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Apply X-Definition from local storage to kubernetes cluster. It will apply file to vela-system namespace by default.
|
||||
|
||||
```
|
||||
vela def apply DEFINITION.cue [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below will apply the local my-webservice.cue file to kubernetes vela-system namespace
|
||||
> vela def apply my-webservice.cue
|
||||
# Apply the local directory including all files(YAML and CUE definition) to kubernetes vela-system namespace
|
||||
> vela def apply def/
|
||||
# Command below will apply the ./defs/my-trait.cue file to kubernetes default namespace
|
||||
> vela def apply ./defs/my-trait.cue --namespace default# Command below will convert the ./defs/my-trait.cue file to kubernetes CRD object and print it without applying it to kubernetes
|
||||
> vela def apply ./defs/my-trait.cue --dry-run# Apply a CUE from URL
|
||||
> vela def apply https://my-host-to-def/my-trait.cue --dry-run# Apply a CUE from stdin
|
||||
> vela def apply -
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--dry-run only build definition from CUE into CRB object without applying it to kubernetes clusters
|
||||
-h, --help help for apply
|
||||
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: vela def del
|
||||
---
|
||||
|
||||
Delete X-Definition.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Delete X-Definition in kubernetes cluster.
|
||||
|
||||
```
|
||||
vela def del DEFINITION_NAME [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below will delete TraitDefinition of annotations in default namespace
|
||||
> vela def del annotations -t trait -n default
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for del
|
||||
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
|
||||
-t, --type string Specify the definition type of target. Valid types: trait, policy, workload, workflow-step, component
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: vela def doc-gen
|
||||
---
|
||||
|
||||
Generate documentation of definitions (Only Terraform typed definitions are supported)
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate documentation of definitions
|
||||
|
||||
```
|
||||
vela def doc-gen NAME [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
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
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for doc-gen
|
||||
-n, --namespace string Specify the namespace of the definition.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage Definitions
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: vela def edit
|
||||
---
|
||||
|
||||
Edit X-Definition.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Edit X-Definition in kubernetes. If type and namespace are not specified, the command will automatically search all possible results.
|
||||
By default, this command will use the vi editor and can be altered by setting EDITOR environment variable.
|
||||
|
||||
```
|
||||
vela def edit NAME [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below will edit the ComponentDefinition (and other definitions if exists) of webservice in kubernetes
|
||||
> vela def edit webservice
|
||||
# Command below will edit the TraitDefinition of ingress in vela-system namespace
|
||||
> vela def edit ingress --type trait --namespace vela-system
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for edit
|
||||
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
|
||||
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: workflow-step, component, trait, policy, workload
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
title: vela def gen-api
|
||||
---
|
||||
|
||||
Generate SDK from X-Definition.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate SDK from X-definition file.
|
||||
* This command leverage openapi-generator project. Therefore demands "docker" exist in PATH
|
||||
* Currently, this function is still working in progress and not all formats of parameter in X-definition are supported yet.
|
||||
|
||||
```
|
||||
vela def gen-api DEFINITION.cue [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Generate SDK for golang with scaffold initialized
|
||||
> vela def gen-api --init --language go -f /path/to/def -o /path/to/sdk
|
||||
# Generate incremental definition files to existing sdk directory
|
||||
> vela def gen-api --language go -f /path/to/def -o /path/to/sdk
|
||||
# Generate definitions to a sub-module
|
||||
> vela def gen-api --language go -f /path/to/def -o /path/to/sdk --submodule --api-dir path/relative/to/output --language-args arg1=val1,arg2=val2
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--api-dir string API directory path to put definition API files, relative to output directory. Default value: go: pkg/apis
|
||||
-f, --file strings File name of definitions, can be specified multiple times, or use comma to separate multiple files. If directory specified, all files found recursively in the directory will be used
|
||||
-h, --help help for gen-api
|
||||
--init Init the whole SDK project, if not set, only the API file will be generated
|
||||
-g, --language string Language to generate code. Valid languages: go (default "go")
|
||||
--language-args strings language-specific arguments to pass to the go generator, available options:
|
||||
go:
|
||||
MainModuleVersion: MainModuleVersion(default: cd431bb25a9a)
|
||||
GoProxy: GoProxy(default: https://goproxy.cn,direct)
|
||||
|
||||
-o, --output string Output directory path (default "./apis")
|
||||
-p, --package string Package name of generated code (default "github.com/kubevela/vela-go-sdk")
|
||||
--submodule api-dir Whether the generated code is a submodule of the project. If set, the directory specified by api-dir will be treated as a submodule of the project
|
||||
-t, --template string Template file path, if not specified, the default template will be used
|
||||
-v, --verbose Print verbose logs
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: vela def gen-cue
|
||||
---
|
||||
|
||||
Generate CUE schema from Go code.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate CUE schema from Go code.
|
||||
* This command provide a way to generate CUE schema from Go code,
|
||||
* Which can be used to keep consistency between Go code and CUE schema automatically.
|
||||
|
||||
|
||||
```
|
||||
vela def gen-cue [flags] SOURCE.go
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Generate CUE schema for provider type
|
||||
> vela def gen-cue -t provider /path/to/myprovider.go > /path/to/myprovider.cue
|
||||
# Generate CUE schema for provider type with custom types
|
||||
> vela def gen-cue -t provider --types *k8s.io/apimachinery/pkg/apis/meta/v1/unstructured.Unstructured=ellipsis /path/to/myprovider.go > /path/to/myprovider.cue
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for gen-cue
|
||||
--nullable Whether to generate null enum for pointer type
|
||||
-t, --type string Type of the definition to generate. Valid types: [provider]
|
||||
--types stringToString Special types to generate, format: <package+struct>=[any|ellipsis]. e.g. --types=*k8s.io/apimachinery/pkg/apis/meta/v1/unstructured.Unstructured=ellipsis (default [])
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: vela def gen-doc
|
||||
---
|
||||
|
||||
Generate documentation for non component, trait, policy and workflow definitions
|
||||
|
||||
### Synopsis
|
||||
|
||||
Generate documentation for non component, trait, policy and workflow definitions
|
||||
|
||||
```
|
||||
vela def gen-doc [flags] SOURCE.cue...
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
1. Generate documentation for provider definitions
|
||||
> vela def gen-doc -t provider provider1.cue provider2.cue > provider.md
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for gen-doc
|
||||
-t, --type string Type of the definition to generate. Valid types: [provider]
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
title: vela def get
|
||||
---
|
||||
|
||||
Get definition
|
||||
|
||||
### Synopsis
|
||||
|
||||
Get definition from kubernetes cluster
|
||||
|
||||
```
|
||||
vela def get NAME [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below will get the ComponentDefinition(or other definitions if exists) of webservice in all namespaces
|
||||
> vela def get webservice
|
||||
# Command below will get the TraitDefinition of annotations in namespace vela-system
|
||||
> vela def get annotations --type trait --namespace vela-system
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for get
|
||||
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
|
||||
-r, --revision string Get the specified version of a definition.
|
||||
--revisions List revisions of the specified definition.
|
||||
-t, --type string Specify which definition type to get. If empty, all types will be searched. Valid types: component, trait, policy, workload, workflow-step
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
title: vela def init
|
||||
---
|
||||
|
||||
Init a new definition
|
||||
|
||||
### Synopsis
|
||||
|
||||
Init a new definition with given arguments or interactively
|
||||
* We support parsing a single YAML file (like kubernetes objects) into the cue-style template.
|
||||
However, we do not support variables in YAML file currently, which prevents users from directly feeding files like helm chart directly.
|
||||
We may introduce such features in the future.
|
||||
|
||||
```
|
||||
vela def init DEF_NAME [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below initiate an empty TraitDefinition named my-ingress
|
||||
> vela def init my-ingress -t trait --desc "My ingress trait definition." > ./my-ingress.cue
|
||||
# Command below initiate a definition named my-def interactively and save it to ./my-def.cue
|
||||
> vela def init my-def -i --output ./my-def.cue
|
||||
# Command below initiate a ComponentDefinition named my-webservice with the template parsed from ./template.yaml.
|
||||
> vela def init my-webservice -i --template-yaml ./template.yaml
|
||||
# Initiate a Terraform ComponentDefinition named vswitch from Github for Alibaba Cloud.
|
||||
> vela def init vswitch --type component --provider alibaba --desc xxx --git https://github.com/kubevela-contrib/terraform-modules.git --path alibaba/vswitch
|
||||
# Initiate a Terraform ComponentDefinition named redis from local file for AWS.
|
||||
> vela def init redis --type component --provider aws --desc "Terraform configuration for AWS Redis" --local redis.tf
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-a, --alias string Specify the alias of the new definition.
|
||||
-d, --desc string Specify the description of the new definition.
|
||||
--git string Specify which git repository the configuration(HCL) is stored in. Valid when --provider/-p is set.
|
||||
-h, --help help for init
|
||||
-i, --interactive Specify whether use interactive process to help generate definitions.
|
||||
--local string Specify the local path of the configuration(HCL) file. Valid when --provider/-p is set.
|
||||
-o, --output string Specify the output path of the generated definition. If empty, the definition will be printed in the console.
|
||||
--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`, `gcp`, `baidu`, `tencent`, `elastic`, `ucloud`, `vsphere` 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: workload, workflow-step, component, trait, policy
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: vela def list
|
||||
---
|
||||
|
||||
List definitions.
|
||||
|
||||
### Synopsis
|
||||
|
||||
List definitions in kubernetes cluster.
|
||||
|
||||
```
|
||||
vela def list [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below will list all definitions in all namespaces
|
||||
> vela def list
|
||||
# Command below will list all definitions in the vela-system namespace
|
||||
> vela def get annotations --type trait --namespace vela-system
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--from string Filter definitions by which addon installed them.
|
||||
-h, --help help for list
|
||||
-n, --namespace string Specify which namespace the definition locates. (default "vela-system")
|
||||
-t, --type string Specify which definition type to list. If empty, all types will be searched. Valid types: trait, policy, workload, workflow-step, component
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: vela def render
|
||||
---
|
||||
|
||||
Render X-Definition.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Render X-Definition with cue format into kubernetes YAML format. Could be used to check whether the cue format definition is working as expected. If a directory is used as input, all cue definitions in the directory will be rendered.
|
||||
|
||||
```
|
||||
vela def render DEFINITION.cue [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below will render my-webservice.cue into YAML format and print it out.
|
||||
> vela def render my-webservice.cue
|
||||
# Command below will render my-webservice.cue and save it in my-webservice.yaml.
|
||||
> vela def render my-webservice.cue -o my-webservice.yaml# Command below will render all cue format definitions in the ./defs/cue/ directory and save the YAML objects in ./defs/yaml/.
|
||||
> vela def render ./defs/cue/ -o ./defs/yaml/
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for render
|
||||
--message string Specify the header message of the generated YAML file. For example, declaring author information.
|
||||
-o, --output string Specify the output path of the rendered definition YAML. If empty, the definition will be printed in the console. If input is a directory, the output path is expected to be a directory as well.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
---
|
||||
title: vela def show
|
||||
---
|
||||
|
||||
Show the reference doc for a component, trait, policy or workflow.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Show the reference doc for component, trait, policy or workflow types. 'vela show' equals with 'vela def show'.
|
||||
|
||||
```
|
||||
vela def show [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
0. Run 'vela show' directly to start a web server for all reference docs.
|
||||
1. Generate documentation for ComponentDefinition webservice:
|
||||
> vela show webservice -n vela-system
|
||||
2. Generate documentation for local CUE Definition file webservice.cue:
|
||||
> vela show webservice.cue
|
||||
3. Generate documentation for local Cloud Resource Definition YAML alibaba-vpc.yaml:
|
||||
> vela show alibaba-vpc.yaml
|
||||
4. Specify output format, markdown supported:
|
||||
> vela show webservice --format markdown
|
||||
5. Specify a language for output, by default, it's english. You can also load your own translation script:
|
||||
> vela show webservice --location zh
|
||||
> vela show webservice --location zh --i18n https://kubevela.io/reference-i18n.json
|
||||
6. Show doc for a specified revision, it must exist in control plane cluster:
|
||||
> vela show webservice --revision v1
|
||||
7. Generate docs for all capabilities into folder $HOME/.vela/reference/docs/
|
||||
> vela show
|
||||
8. Generate all docs and start a doc server
|
||||
> vela show --web
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
--format string specify format of output data, by default it's a pretty human readable format, you can specify markdown(md)
|
||||
-h, --help help for show
|
||||
--i18n string specify the location for of the doc generated from definition, now supported options 'zh', 'en'. (default "https://kubevela.io/reference-i18n.json")
|
||||
-l, --location string specify the location for of the doc generated from definition, now supported options 'zh', 'en'.
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-p, --path string Specify the path for of the doc generated from definition.
|
||||
-r, --revision string Get the specified revision of a definition. Use def get to list revisions.
|
||||
--web start web doc site
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: vela def vet
|
||||
---
|
||||
|
||||
Validate X-Definition.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Validate definition file by checking whether it has the valid cue format with fields set correctly
|
||||
* Currently, this command only checks the cue format. This function is still working in progress and we will support more functional validation mechanism in the future.
|
||||
|
||||
```
|
||||
vela def vet DEFINITION.cue [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Command below will validate the my-def.cue file.
|
||||
> vela def vet my-def.cue
|
||||
# Validate every cue file provided
|
||||
> vela def vet my-def1.cue my-def2.cue my-def3.cue
|
||||
# Validate every cue file in the specified directories> vela def vet ./test1/ ./test2/
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for vet
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela def](vela_def.md) - Manage definitions.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
---
|
||||
title: vela delete
|
||||
---
|
||||
|
||||
Delete an application.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Delete applications
|
||||
|
||||
Delete KubeVela applications. KubeVela application deletion is associated with the recycle of underlying resources. By default, the resources created by the KubeVela application will be deleted once it is not in use or the application is deleted. There is garbage-collect policy in KubeVela application that you can use to configure customized recycle rules.
|
||||
|
||||
This command supports delete application in various modes. Natively, you can use it like "kubectl delete app [app-name]". In the cases you only want to delete the application but leave the resources there, you can use the --orphan parameter. In the cases the server-side controller is uninstalled, or you want to manually skip some errors in the deletion process (like lack privileges or handle cluster disconnection), you can use the --force parameter.
|
||||
|
||||
```
|
||||
vela delete
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Delete an application
|
||||
vela delete my-app
|
||||
|
||||
# Delete multiple applications in a namespace
|
||||
vela delete app-1 app-2 -n example
|
||||
|
||||
# Delete all applications in one namespace
|
||||
vela delete -n example --all
|
||||
|
||||
# Delete application without waiting to be deleted
|
||||
vela delete my-app --wait=false
|
||||
|
||||
# Delete application without confirmation
|
||||
vela delete my-app -y
|
||||
|
||||
# Force delete application at client-side
|
||||
vela delete my-app -f
|
||||
|
||||
# Delete application by orphaning resources and skip recycling them
|
||||
vela delete my-app --orphan
|
||||
|
||||
# Delete application interactively
|
||||
vela delete my-app -i
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--all delete all the application under the given namespace
|
||||
-e, --env string The environment name for the CLI request
|
||||
-f, --force force delete the application
|
||||
-h, --help help for delete
|
||||
-i, --interactive delete the application interactively
|
||||
-n, --namespace string If present, the namespace scope for this CLI request
|
||||
-o, --orphan delete the application and orphan managed resources
|
||||
-w, --wait wait util the application is deleted completely (default true)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
---
|
||||
title: vela dry-run
|
||||
---
|
||||
|
||||
Dry Run an application, and output the K8s resources as result to stdout.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Dry-run application locally, render the Kubernetes resources as result to stdout.
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml
|
||||
|
||||
You can also specify a remote url for app:
|
||||
vela dry-run -d /definition/directory/or/file/ -f https://remote-host/app.yaml
|
||||
|
||||
And more, you can specify policy and workflow with application file:
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml -f /path/to/policy.yaml -f /path/to/workflow.yaml, OR
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml
|
||||
|
||||
Additionally, if the provided policy and workflow files are not referenced by application file, warning message will show up
|
||||
and those files will be ignored. You can use "merge" flag to make those standalone files effective:
|
||||
vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml,/path/to/policy.yaml,/path/to/workflow.yaml --merge
|
||||
|
||||
Limitation:
|
||||
1. Only support one object per file(yaml) for "-f" flag. More support will be added in the future improvement.
|
||||
2. Dry Run with policy and workflow will only take override/topology policies and deploy workflow step into considerations. Other workflow step will be ignored.
|
||||
|
||||
|
||||
```
|
||||
vela dry-run
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
|
||||
# dry-run application
|
||||
vela dry-run -f app.yaml
|
||||
|
||||
# dry-run application with policy and workflow
|
||||
vela dry-run -f app.yaml -f policy.yaml -f workflow.yaml
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-d, --definition string specify a definition file or directory, it will only be used in dry-run rather than applied to K8s cluster
|
||||
-x, --definition-namespace string Specify which namespace the definition locates. (default "vela-system")
|
||||
-e, --env string specify environment name for application
|
||||
-f, --file strings application related file names (default [app.yaml])
|
||||
-h, --help help for dry-run
|
||||
--merge Merge standalone files to produce dry-run results
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
--offline dry-run Run dry-run in offline / local mode, all validation steps will be skipped
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: vela env
|
||||
---
|
||||
|
||||
Manage environments for vela applications to run.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage environments for vela applications to run.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for env
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela env delete](vela_env_delete.md) - Delete an environment.
|
||||
* [vela env init](vela_env_init.md) - Create environment for vela applications to run.
|
||||
* [vela env ls](vela_env_ls.md) - List environments for vela applications to run.
|
||||
* [vela env set](vela_env_set.md) - Set an environment.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela env delete
|
||||
---
|
||||
|
||||
Delete an environment.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Delete an environment.
|
||||
|
||||
```
|
||||
vela env delete
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela env delete test
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments for vela applications to run.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: vela env init
|
||||
---
|
||||
|
||||
Create environment for vela applications to run.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Create environment for vela applications to run.
|
||||
|
||||
```
|
||||
vela env init <envName>
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela env init test --namespace test
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for init
|
||||
--namespace string specify K8s namespace for env
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments for vela applications to run.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela env ls
|
||||
---
|
||||
|
||||
List environments for vela applications to run.
|
||||
|
||||
### Synopsis
|
||||
|
||||
List all environments for vela applications to run.
|
||||
|
||||
```
|
||||
vela env ls
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela env ls [env-name]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for ls
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments for vela applications to run.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: vela env set
|
||||
---
|
||||
|
||||
Set an environment.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Set an environment as the default one for running vela applications.
|
||||
|
||||
```
|
||||
vela env set
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela env set test
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for set
|
||||
--labels string set labels for namespace
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela env](vela_env.md) - Manage environments for vela applications to run.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
---
|
||||
title: vela exec
|
||||
---
|
||||
|
||||
Execute command in a container.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Execute command inside container based vela application.
|
||||
|
||||
```
|
||||
vela exec [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
|
||||
exec [flags] APP_NAME -- COMMAND [args...]
|
||||
|
||||
# Get output from running 'date' command from app pod, using the first container by default
|
||||
vela exec my-app -- date
|
||||
|
||||
# Switch to raw terminal mode, sends stdin to 'bash' in containers of application my-app
|
||||
# and sends stdout/stderr from 'bash' back to the client
|
||||
vela exec my-app -i -t -- bash -il
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--cluster string filter the pod by the cluster name
|
||||
-c, --component string filter the pod by the component name
|
||||
--container string specify the container name
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for exec
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-p, --pod string specify the pod name
|
||||
--pod-running-timeout duration The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running (default 1m0s)
|
||||
-i, --stdin Pass stdin to the container (default true)
|
||||
-t, --tty Stdin is a TTY (default true)
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: vela export
|
||||
---
|
||||
|
||||
Export deploy manifests from appfile
|
||||
|
||||
### Synopsis
|
||||
|
||||
Export deploy manifests from appfile or application.
|
||||
|
||||
```
|
||||
vela export
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
-f, --file string specify file path for appfile
|
||||
-h, --help help for export
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
title: vela help
|
||||
---
|
||||
|
||||
Help about any command.
|
||||
|
||||
```
|
||||
vela help
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
help [command] | STRING_TO_SEARCH
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for help
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
---
|
||||
title: vela init
|
||||
---
|
||||
|
||||
Create scaffold for an application.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Create scaffold for vela application.
|
||||
|
||||
```
|
||||
vela init
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela init
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for init
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
--render-only Rendering vela.yaml in current dir and do not deploy
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela install
|
||||
---
|
||||
|
||||
Installs or Upgrades Kubevela control plane on a Kubernetes cluster.
|
||||
|
||||
### Synopsis
|
||||
|
||||
The Kubevela CLI allows installing Kubevela on any Kubernetes derivative to which your kube config is pointing to.
|
||||
|
||||
```
|
||||
vela install [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-d, --detail show detail log of installation (default true)
|
||||
-f, --file string custom the chart path of KubeVela control plane
|
||||
-h, --help help for install
|
||||
-n, --namespace string namespace scope for installing KubeVela Core (default "vela-system")
|
||||
-r, --reuse will re-use the user's last supplied values. (default true)
|
||||
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
|
||||
-v, --version string (default "UNKNOWN")
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: vela kube
|
||||
---
|
||||
|
||||
Managing native Kubernetes resources across clusters.
|
||||
|
||||
```
|
||||
vela kube [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for kube
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela kube apply](vela_kube_apply.md) - Apply resources in Kubernetes YAML file to clusters.
|
||||
* [vela kube delete](vela_kube_delete.md) - Delete resources in clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
---
|
||||
title: vela kube apply
|
||||
---
|
||||
|
||||
Apply resources in Kubernetes YAML file to clusters.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Apply Kubernetes objects in clusters
|
||||
|
||||
Apply Kubernetes objects in multiple clusters. Use --clusters to specify which clusters to apply. If -n/--namespace is used, the original object namespace will be overridden.
|
||||
|
||||
You can use -f/--file to specify the object file/folder to apply. Multiple file inputs are allowed. Directory input and web url input is supported as well. File format can be in YAML, JSON or CUE.
|
||||
|
||||
```
|
||||
vela kube apply [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Apply single object file in managed cluster
|
||||
vela kube apply -f my.yaml --cluster cluster-1
|
||||
|
||||
# Apply object in CUE, the whole CUE file MUST follow the kubernetes API and contain only one object.
|
||||
vela kube apply -f my.cue --cluster cluster-1
|
||||
|
||||
# Apply object in JSON, the whole JSON file MUST follow the kubernetes API and contain only one object.
|
||||
vela kube apply -f my.json --cluster cluster-1
|
||||
|
||||
# Apply multiple object files in multiple managed clusters
|
||||
vela kube apply -f my-1.yaml -f my-2.cue --cluster cluster-1 --cluster cluster-2
|
||||
|
||||
# Apply object file with web url in control plane
|
||||
vela kube apply -f https://raw.githubusercontent.com/kubevela/kubevela/master/docs/examples/app-with-probe/app-with-probe.yaml
|
||||
|
||||
# Apply object files in directory to specified namespace in managed clusters
|
||||
vela kube apply -f ./resources -n demo --cluster cluster-1 --cluster cluster-2
|
||||
|
||||
# Use dry-run to see what will be rendered out in YAML
|
||||
vela kube apply -f my.cue --cluster cluster-1 --dry-run
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-c, --cluster strings The cluster to apply objects. Setting multiple clusters will apply objects in order. (default [local])
|
||||
--dry-run Setting this flag will not apply resources in clusters. It will print out the resource to be applied.
|
||||
-f, --file strings Files that include native Kubernetes objects to apply.
|
||||
-h, --help help for apply
|
||||
-n, --namespace string The namespace to apply objects. If empty, the namespace declared in the YAML will be used.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela kube](vela_kube.md) - Managing native Kubernetes resources across clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
---
|
||||
title: vela kube delete
|
||||
---
|
||||
|
||||
Delete resources in clusters.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Delete Kubernetes objects in clusters
|
||||
|
||||
Delete Kubernetes objects in multiple clusters. Use --clusters to specify which clusters to delete. Use -n/--namespace flags to specify which cluster the target resource locates.
|
||||
|
||||
Use --all flag to delete all this kind of objects in the target namespace and clusters.
|
||||
|
||||
```
|
||||
vela kube delete [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# Delete the deployment nginx in default namespace in cluster-1
|
||||
vela kube delete deployment nginx --cluster cluster-1
|
||||
|
||||
# Delete the deployment nginx in demo namespace in cluster-1 and cluster-2
|
||||
vela kube delete deployment nginx -n demo --cluster cluster-1 --cluster cluster-2
|
||||
|
||||
# Delete all deployments in demo namespace in cluster-1
|
||||
vela kube delete deployment --all -n demo --cluster cluster-1
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--all Setting this flag will delete all this kind of resources.
|
||||
-c, --cluster strings The cluster to delete objects. Setting multiple clusters will delete objects in order. (default [local])
|
||||
-h, --help help for delete
|
||||
-n, --namespace string The namespace to delete objects. If empty, the default namespace will be used.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela kube](vela_kube.md) - Managing native Kubernetes resources across clusters.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
title: vela live-diff
|
||||
---
|
||||
|
||||
Compare application and revisions.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Compare application and revisions.
|
||||
|
||||
```
|
||||
vela live-diff
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
# 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
|
||||
|
||||
```
|
||||
-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
|
||||
-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
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: vela logs
|
||||
---
|
||||
|
||||
Tail logs for application.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Tail logs for vela application.
|
||||
|
||||
```
|
||||
vela logs [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--cluster string filter the pod by the cluster name
|
||||
-c, --component string filter the pod by the component name
|
||||
--container string specify the container name
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for logs
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-o, --output string output format for logs, support: [default, raw, json] (default "default")
|
||||
-p, --pod string specify the pod name
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
---
|
||||
title: vela ls
|
||||
---
|
||||
|
||||
List applications.
|
||||
|
||||
### Synopsis
|
||||
|
||||
List all vela applications.
|
||||
|
||||
```
|
||||
vela ls
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela ls
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-A, --all-namespaces If true, check the specified action in all namespaces.
|
||||
-e, --env string specify environment name for application
|
||||
--field-selector string Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2).
|
||||
-h, --help help for ls
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
-l, --selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2).
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: vela port-forward
|
||||
---
|
||||
|
||||
Forward local ports to container/service port of vela application.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Forward local ports to container/service port of vela application.
|
||||
|
||||
```
|
||||
vela port-forward [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
port-forward APP_NAME [options] [LOCAL_PORT:]REMOTE_PORT [...[LOCAL_PORT_N:]REMOTE_PORT_N]
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
--address strings Addresses to listen on (comma separated). Only accepts IP addresses or localhost as a value. When localhost is supplied, vela will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these addresses are available to bind. (default [localhost])
|
||||
--cluster string filter the pod by the cluster name
|
||||
-c, --component string filter the pod by the component name
|
||||
-e, --env string specify environment name for application
|
||||
-h, --help help for port-forward
|
||||
-n, --namespace string specify the Kubernetes namespace to use
|
||||
--pod-running-timeout duration The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running (default 1m0s)
|
||||
--resource-name string specify the resource name
|
||||
-t, --resource-type string specify the resource type, support the service, and pod
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
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
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela provider list](vela_provider_list.md) - List Terraform Cloud Providers
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: vela provider add
|
||||
---
|
||||
|
||||
Authenticate Terraform Cloud Provider
|
||||
|
||||
### Synopsis
|
||||
|
||||
Authenticate Terraform Cloud Provider by creating a credential secret and a Terraform Controller Provider
|
||||
|
||||
```
|
||||
vela provider add [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela provider add <provider-type>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for add
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela provider](vela_provider.md) - Authenticate Terraform Cloud Providers
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: vela provider delete
|
||||
---
|
||||
|
||||
Delete Terraform Cloud Provider
|
||||
|
||||
### Synopsis
|
||||
|
||||
Delete Terraform Cloud Provider
|
||||
|
||||
```
|
||||
vela provider delete [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela provider delete <provider-type> --name <provider-name>
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for delete
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela provider](vela_provider.md) - Authenticate Terraform Cloud Providers
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
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
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela provider](vela_provider.md) - Authenticate terraform cloud providers.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
---
|
||||
title: vela ql
|
||||
---
|
||||
|
||||
Show result of executing velaQL.
|
||||
|
||||
### Synopsis
|
||||
|
||||
Show result of executing velaQL, use it like:
|
||||
vela ql --query "inner-view-name{param1=value1,param2=value2}"
|
||||
vela ql --file ./ql.cue
|
||||
|
||||
```
|
||||
vela ql [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
Users can query with a query statement:
|
||||
vela ql --query "inner-view-name{param1=value1,param2=value2}"
|
||||
|
||||
Query by a ql file:
|
||||
vela ql --file ./ql.cue
|
||||
Query by a ql file from remote url:
|
||||
vela ql --file https://my.host.to.cue/ql.cue
|
||||
Query by a ql file from stdin:
|
||||
cat ./ql.cue | vela ql --file -
|
||||
|
||||
Example content of ql.cue:
|
||||
---
|
||||
import (
|
||||
"vela/ql"
|
||||
)
|
||||
configmap: ql.#Read & {
|
||||
value: {
|
||||
kind: "ConfigMap"
|
||||
apiVersion: "v1"
|
||||
metadata: {
|
||||
name: "mycm"
|
||||
}
|
||||
}
|
||||
}
|
||||
status: configmap.value.data.key
|
||||
|
||||
export: "status"
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --file string The CUE file path for VelaQL, it could be a remote url.
|
||||
-h, --help help for ql
|
||||
-q, --query string The query statement for VelaQL.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela ql apply](vela_ql_apply.md) - Create and store a VelaQL view
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
---
|
||||
title: vela ql apply
|
||||
---
|
||||
|
||||
Create and store a VelaQL view
|
||||
|
||||
### Synopsis
|
||||
|
||||
Create and store a VelaQL view to reuse it later.
|
||||
|
||||
You can specify your view file from:
|
||||
- a file (-f my-view.cue)
|
||||
- a URL (-f https://example.com/view.cue)
|
||||
- stdin (-f -)
|
||||
|
||||
View name can be automatically inferred from file/URL.
|
||||
If we cannot infer a name from it, you must explicitly specify the view name (see examples).
|
||||
|
||||
If a view with the same name already exists, it will be updated.
|
||||
|
||||
```
|
||||
vela ql apply [view-name] [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
Assume your VelaQL view is stored in <my-view.cue>.
|
||||
|
||||
View name will be implicitly inferred from file name or URL (my-view):
|
||||
vela ql create -f my-view.cue
|
||||
|
||||
You can also explicitly specify view name (custom-name):
|
||||
vela ql create custom-name -f my-view.cue
|
||||
|
||||
If view name cannot be inferred, or you are reading from stdin (-f -), you must explicitly specify view name:
|
||||
cat my-view.cue | vela ql create custom-name -f -
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-f, --file string CUE file that stores the view, can be local path, URL, or stdin (-)
|
||||
-h, --help help for apply
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela ql](vela_ql.md) - Show result of executing velaQL.
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: vela registry
|
||||
---
|
||||
|
||||
Manage Registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
Manage Registry of X-Definitions for extension.
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for registry
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
|
||||
* [vela registry config](vela_registry_config.md) - Configure (add if not exist) a registry, default is local (built-in capabilities)
|
||||
* [vela registry ls](vela_registry_ls.md) - List all registry
|
||||
* [vela registry remove](vela_registry_remove.md) - Remove specified registry
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: vela registry config
|
||||
---
|
||||
|
||||
Configure (add if not exist) a registry, default is local (built-in capabilities)
|
||||
|
||||
### Synopsis
|
||||
|
||||
Configure (add if not exist) a registry, default is local (built-in capabilities)
|
||||
|
||||
```
|
||||
vela registry config <registryName> <centerURL> [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela registry config my-registry https://github.com/oam-dev/catalog/tree/master/registry
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for config
|
||||
-t, --token string Github Repo token
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela registry](vela_registry.md) - Manage Registry
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
title: vela registry ls
|
||||
---
|
||||
|
||||
List all registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
List all configured registry
|
||||
|
||||
```
|
||||
vela registry ls [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
vela registry ls
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for ls
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
-V, --verbosity Level number for the log level verbosity
|
||||
-y, --yes Assume yes for all user prompts
|
||||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [vela registry](vela_registry.md) - Manage Registry
|
||||
|
||||
#### Go Back to [CLI Commands](vela.md) Homepage.
|
||||
|
||||
|
||||
###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue