Docs: add some application howto doc
Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG
parent
8cd8164a63
commit
be42c84b00
|
|
@ -1,4 +1,4 @@
|
|||
---
|
||||
title: Create an application
|
||||
title: How to create an application
|
||||
description: create an application by kubevela dashboard
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Edit kubernetes cluster
|
||||
title: Edit metadata of kubernetes cluster
|
||||
---
|
||||
|
||||
We support connect and detach the kubernetes cluster.
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 137 KiB |
|
|
@ -112,7 +112,7 @@
|
|||
"description": "The label for category Customize Traits in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.CLI": {
|
||||
"message": "CLI 命令行工具",
|
||||
"message": "CLI 命令行",
|
||||
"description": "The label for category CLI in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Capabilities": {
|
||||
|
|
@ -163,9 +163,9 @@
|
|||
"message": "调试指南",
|
||||
"description": "The label for category Debugging in sidebar docs"
|
||||
},
|
||||
"sidebar.docs.category.Administrator Manuals": {
|
||||
"message": "自定义扩展",
|
||||
"description": "The label for category Administrator Manuals in sidebar docs"
|
||||
"sidebar.docs.category.Extension": {
|
||||
"message": "平台扩展",
|
||||
"description": "平台扩展参考文档"
|
||||
},
|
||||
"sidebar.docs.category.Simple Template": {
|
||||
"message": "Simple Template",
|
||||
|
|
@ -182,5 +182,17 @@
|
|||
"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.Manage application": {
|
||||
"message": "应用管理",
|
||||
"description": "通过 Dashboard 对应用的管理操作说明"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: Overview
|
||||
---
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: 发布应用到新环境
|
||||
description: 发布应用到新的环境
|
||||
---
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: 创建应用
|
||||
description: 本文介绍在 KubeVela Dashboard 中创建应用的操作方法。
|
||||
---
|
||||
|
||||
### 判断你的应用类别
|
||||
|
||||
我们大致把应用分为三种类型，普通业务应用、中间件（第三方开源应用）、云服务。对于普通业务应用，我们建议你采用 `webservice` 部署类型或你的自定义类型。对于中间件或第三方复杂应用建议直接采用 `helm` 部署类型，对于比较简单且直接提供了 Docker 镜像的第三方开源应用，比如 wordpress,也可以直接采用 `webservice` 类型。
|
||||
|
||||
### 设置应用基础信息
|
||||
|
||||
进入 `Applications` 页面，点击 `New Application` 按钮，进入应用基础信息设置页面。设置应用名称等基础信息，根据上一步判断的应用类型选择类型，根据你的实际情况选择部署的环境。设置完成后直接进入下一步。
|
||||
|
||||
### 设置应用部署参数
|
||||
|
||||
应用部署参数对于不同的类型差异较大，可根据 UI 提示的帮助信息进行信息输入。比如对于 `webservice` 类型的应用，他的输入参数如下图：
|
||||
|
||||
|
||||
|
||||
### 完成创建
|
||||
|
||||
根据提示完成部署参数的设置后，点击提交按钮即可完成应用创建。成功创建后进入应用管理页面，应用处于未部署状态。
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: 删除应用
|
||||
description: 应用删除的操作方式
|
||||
---
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: 部署应用到指定环境
|
||||
description: 指定用户将创建的应用部署到指定的环境。
|
||||
---
|
||||
|
||||
应用创建完成后，需要分别执行环境对应的工作流完成环境的部署，每个环节的对应工作流会自动生成。
|
||||
|
||||
### 首次部署
|
||||
|
||||
从应用列表点击指定应用进入应用详细页面，在 `Benchmark Config` 右侧即为所有已绑定的环境列表。选择你需要部署的环境，点击环境名称进入环境页面。
|
||||
|
||||
|
||||
|
||||
环境处于未部署状态时将显示部署按钮，点击按钮即可开始执行当前环境的部署工作流。工作流执行状态显示在页面的右上方。如果你设置了审核的步骤，到达该步骤时页面中将弹出审核窗口。如果部署步骤出现故障，该步骤显示为红色，鼠标移动到该步骤上将显示故障原因。
|
||||
|
||||
### 更新部署
|
||||
|
||||
应用详情页面的右上方有一个常驻的 `Deploy` 按钮，点击该按钮执行默认工作流。按钮右边三点按钮为选择不同的环境工作流，鼠标移动到其上方即可显示多个工作流选项。
|
||||
|
||||
更新部署可以在任意状态下进行，选择执行某一个流水线后，将使用最新的应用配置进行部署。如果该环境正在执行部署，UI 将提示你是否强制进行新的部署。
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: 访问应用
|
||||
description: 获取应用的访问地址并访问应用。
|
||||
---
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: 查看应用运行实例
|
||||
description: 通过 Dashboard 查看应用运行实例，掌握应用运行状态。
|
||||
---
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: 查看应用运行日志
|
||||
description: 通过查看应用的运行日志是排查故障的最直接方式
|
||||
---
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: 查看应用部署版本
|
||||
description: 查看应用当前部署版本和历史部署版本。
|
||||
---
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: Overview
|
||||
---
|
||||
|
||||
### [创建应用](./create-application)
|
||||
|
||||
通过 Dashboard 创建各种类型的应用的操作方式。
|
||||
|
||||
### [应用部署到指定环境](./deploy-application)
|
||||
|
||||
操作应用部署到指定的环境。
|
||||
|
||||
### [查看应用实例](./get-application-instance)
|
||||
|
||||
对于已部署的应用，查看指定环境的应用实例信息。
|
||||
|
||||
### [查看应用运行日志](./get-application-log)
|
||||
|
||||
查看运行应用的容器日志的操作方式。
|
||||
|
||||
### [访问应用](./get-application-endpoint)
|
||||
|
||||
获取应用的访问地址，并访问应用。
|
||||
|
||||
### [查看应用部署版本](./get-application-revision)
|
||||
|
||||
查看应用的当前部署版本和历史版本。
|
||||
|
||||
### [发布到新环境](./bind-new-environment)
|
||||
|
||||
发布已有应用到新环境的操作方式。
|
||||
|
||||
### [回收环境](./recycle-environment)
|
||||
|
||||
回收一个应用在某个环境的部署实例的操作方式
|
||||
|
||||
### [删除应用](./delete-application)
|
||||
|
||||
删除一个应用的操作方式。
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
title: 回收应用部署的实例
|
||||
description: 操作应用从某个环境回收，释放占用的资源。
|
||||
---
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Connect a kubernetes cluster
|
||||
---
|
||||
|
||||
We support connect and detach the kubernetes cluster.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Detach a kubernetes cluster
|
||||
---
|
||||
|
||||
We support connect and detach the kubernetes cluster.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Edit metadata of kubernetes cluster
|
||||
---
|
||||
|
||||
We support connect and detach the kubernetes cluster.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: Overview
|
||||
---
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: Set cluster dashboard
|
||||
---
|
||||
|
||||
We support connect and detach the kubernetes cluster.
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: Overview
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: Overview
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: Overview
|
||||
---
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
title: Overview
|
||||
---
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 137 KiB |
14
sidebars.js
14
sidebars.js
|
|
@ -49,7 +49,10 @@ module.exports = {
|
|||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
Dashboard: [
|
||||
type: "category",
|
||||
label: "Dashboard",
|
||||
collapsed: true,
|
||||
items: [
|
||||
{
|
||||
"Manage application": [
|
||||
"how-to/dashboard/application/overview",
|
||||
|
|
@ -86,10 +89,15 @@ module.exports = {
|
|||
],
|
||||
},
|
||||
{
|
||||
"Manage addon": [],
|
||||
"Manage addon": ["how-to/dashboard/addon/overview"],
|
||||
},
|
||||
],
|
||||
CLI: [
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "CLI",
|
||||
collapsed: false,
|
||||
items: [
|
||||
"end-user/quick-start-cli",
|
||||
{
|
||||
"Deploying Components": [
|
||||
|
|
|
|||
Loading…
Reference in New Issue