Merge pull request #440 from wonderflow/r3f
add application how-to docs footer
This commit is contained in:
commit
f92fdbe2f6
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Bind application with environment
|
||||
title: Bind Application with Environment
|
||||
---
|
||||
|
||||
We can specify bind with one or more environments before deploy.
|
||||
|
|
@ -21,3 +21,7 @@ After choose well, click the `submit` button, it will show the new environment c
|
|||
KubeVela will automatically generate the deploy workflow for the newly created environments.
|
||||
|
||||
In the environment tab, you can click `Deploy` button to deploy the application.
|
||||
|
||||
### Next Step
|
||||
|
||||
* [Deploy the Application](./deploy-application)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Create application
|
||||
title: Create Application
|
||||
description: create an application by kubevela dashboard
|
||||
---
|
||||
|
||||
|
|
@ -30,4 +30,8 @@ Different component types are different significantly, you can fill in the forms
|
|||
|
||||
After you finished configuring the application, click "Submit" to create the application. This means the application configuration was saved.
|
||||
|
||||
You should choose to [bind environment](./bind-new-environment) to do real deployment.
|
||||
You need to [bind environment](./bind-new-environment) for real deployment.
|
||||
|
||||
### Next Step
|
||||
|
||||
* [Bind Application with Environment](./bind-new-environment)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Delete application
|
||||
title: Delete Application
|
||||
description: delete an application by KubeVela dashboard
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Deploy application
|
||||
title: Deploy Application
|
||||
description: deploy an application to environment by KubeVela dashboard
|
||||
---
|
||||
|
||||
|
|
@ -32,3 +32,7 @@ There's a `Deploy` button on the top right corner, you can click that for deploy
|
|||

|
||||
|
||||
You can upgrade the application in any state, as KubeVela is a declarative system. There will be a kindly reminder for you if the workflow is running when you want to upgrade.
|
||||
|
||||
### Next Step
|
||||
|
||||
* [Check Application State](./get-application-instance)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Expose application for public access
|
||||
title: Expose Application for Public Access
|
||||
description: View an application endpoints by KubeVela dashboard
|
||||
---
|
||||
|
||||
|
|
@ -36,3 +36,7 @@ Other component types can also be able to configure the service expose, but they
|
|||
After the application deployed with service exposed configuration, you can see a `Service Endpoint` button on the left of the `Recycle` button. You'll see the endpoint when hover your mouse there.
|
||||
|
||||

|
||||
|
||||
### Next Step
|
||||
|
||||
* [View Resources List Created](./view-application-resource)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Check application state
|
||||
title: Check Application State
|
||||
description: View an application instances by KubeVela dashboard
|
||||
---
|
||||
|
||||
|
|
@ -14,3 +14,7 @@ As the picture shows, check the application pod details by click the expand butt
|
|||
For cloud resources, there will be a link to the cloud console for management.
|
||||
|
||||

|
||||
|
||||
### Next Step
|
||||
|
||||
* [View Application Logs](./get-application-log)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: View application logs
|
||||
title: View Application Logs
|
||||
description: View an application log by KubeVela dashboard
|
||||
---
|
||||
|
||||
|
|
@ -13,3 +13,7 @@ Click the icon in the `Action` column, you'll see the running logs for pod.
|
|||

|
||||
|
||||
By default, the logs will refresh every 5s. If your logs didn't have timestamp, you can click the `Show timestamps` to see.
|
||||
|
||||
### Next Step
|
||||
|
||||
* [Expose Application for Public Access](./get-application-endpoint)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: View application revision
|
||||
title: List Application Revision
|
||||
description: View an application revision by KubeVela dashboard
|
||||
---
|
||||
|
||||
|
|
@ -10,3 +10,7 @@ You can check the application revision in the `Revisions` tab inside the baselin
|
|||

|
||||
|
||||
Manually upgrade or triggered by webhooks will all list here.
|
||||
|
||||
### Next Step
|
||||
|
||||
* [Recycle Application Instance](./recycle-environment)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Recycle application instance
|
||||
title: Recycle Application Instance
|
||||
---
|
||||
|
||||
When you want to delete the application instance in some environment, you can click the `Recycle` button in that environment.
|
||||
|
|
@ -13,3 +13,7 @@ It will delete the whole application instance with related resources.
|
|||
### Delete the environment binding
|
||||
|
||||
After the application instance recycled, there will be a `Delete` button, click this button means unbound the environment for application.
|
||||
|
||||
### Next Step
|
||||
|
||||
* [Delete Application](./delete-application)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: View application created resources
|
||||
title: View Resources List Created
|
||||
---
|
||||
|
||||
If you want to learn the resources created by the applications, you can click `Check the details` text button, it will provide a window to show the resources.
|
||||
|
|
@ -7,3 +7,7 @@ If you want to learn the resources created by the applications, you can click `
|
|||

|
||||
|
||||
There're three kinds of information including `Applied Resources`,`Conditions` and `Component Status`. The `Applied Resources` are all resources created by the applications.
|
||||
|
||||
### Next Step
|
||||
|
||||
* [List Application Revision](./get-application-revision)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: 发布应用到新环境
|
||||
title: 绑定应用到环境
|
||||
description: 发布应用到新的环境
|
||||
---
|
||||
|
||||
|
|
@ -14,3 +14,7 @@ description: 发布应用到新的环境
|
|||
在弹窗中选择需要发布的环境。如果环境还没创建,可点击下方的 `Create new environment` 创建新的环境。
|
||||
|
||||
点击确认即完成绑定,`Baseline Config` 右侧环境选项区域出现新的环境,且在工作流管理页面将自动生成新环境的部署工作流。切换到新环境视图下点击 `Deploy` 即可将应用发布到该环境。
|
||||
|
||||
### 下一步
|
||||
|
||||
* [部署应用](./deploy-application).
|
||||
|
|
@ -20,3 +20,7 @@ description: 本文介绍在 KubeVela Dashboard 中创建应用的操作方法
|
|||
### 完成创建
|
||||
|
||||
根据提示完成部署参数的设置后,点击提交按钮即可完成应用创建。成功创建后进入应用管理页面,应用处于未部署状态。
|
||||
|
||||
### 下一步
|
||||
|
||||
* [绑定应用到环境](./bind-new-environment).
|
||||
|
|
@ -8,3 +8,4 @@ description: 应用删除的操作方式
|
|||

|
||||
|
||||
如上图所示,回到应用列表页面,鼠标移动到应用名称右侧的操作图标上,点击 Remove 选项即可完成应用的删除操作。
|
||||
|
||||
|
|
|
|||
|
|
@ -26,3 +26,7 @@ description: 指定用户将创建的应用部署到指定的环境。
|
|||

|
||||
|
||||
更新部署可以在任意状态下进行,选择执行某一个流水线后,将使用最新的应用配置进行部署。如果该环境正在执行部署,UI 将提示你是否强制进行新的部署。
|
||||
|
||||
### 下一步
|
||||
|
||||
* [查看应用运行实例](./get-application-instance)
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: 访问应用
|
||||
description: 通过 Dashboard 设置应用访问方式,获取应用的访问地址并访问应用。
|
||||
title: 暴露访问地址
|
||||
description: 通过 UI 设置应用访问方式,获取应用的访问地址并访问应用。
|
||||
---
|
||||
|
||||
### 设置应用访问方式
|
||||
|
|
@ -29,3 +29,7 @@ description: 通过 Dashboard 设置应用访问方式,获取应用的访问
|
|||
设置完应用访问方式后,执行应用部署,然后切换到环境视图下即可看到 `Service Endpoint` 按钮,鼠标移动到上方即可显示该应用的访问地址。
|
||||
|
||||

|
||||
|
||||
### 下一步
|
||||
|
||||
* [查看应用部署的资源列表](./view-application-resource)
|
||||
|
|
@ -16,3 +16,7 @@ description: 通过 Dashboard 查看应用运行实例,掌握应用运行状
|
|||
对于交付的 云服务 应用,用户可通过点击实例名称跳转到云服务商管理页面。
|
||||
|
||||

|
||||
|
||||
### 下一步
|
||||
|
||||
* [查看应用运行日志](./get-application-log)
|
||||
|
|
@ -10,3 +10,7 @@ description: 通过查看应用的运行日志是排查故障的最直接方式
|
|||

|
||||
|
||||
日志查询页面默认为每 5 秒自动刷新,查看最新的日志。若你的应用日志中没有时间信息,可点击 `Show timestamps` 展示日志记录时间。
|
||||
|
||||
### 下一步
|
||||
|
||||
* [暴露访问地址](./get-application-endpoint)
|
||||
|
|
@ -8,3 +8,7 @@ description: 查看应用当前部署版本和历史部署版本。
|
|||

|
||||
|
||||
通过 Webhook Trigger 触发部署的版本,如果携带了代码信息,版本号可与代码 Commit 信息进行关联。
|
||||
|
||||
### 下一步
|
||||
|
||||
* [回收应用实例](./recycle-environment)
|
||||
|
|
@ -14,3 +14,7 @@ description: 操作应用从某个环境回收,释放占用的资源。
|
|||
### 删除应用和环境的绑定关系
|
||||
|
||||
应用如果成功从该环境回收后,操作区域将存在 `Delete` 按钮,点击该按钮即可删除应用与环境的绑定关系。
|
||||
|
||||
### 下一步
|
||||
|
||||
* [删除应用](./delete-application)
|
||||
|
|
@ -11,3 +11,7 @@ title: 查看应用部署的资源列表
|
|||
弹窗中展示了应用的 `Applied Resources` `Conditions` 和 `Component Status` 三方面信息,其中 `Applied Resources` 即是应用部署的资源列表。
|
||||
|
||||
在列表中呈现了包括资源类型、名称、所在集群和 Namespace 等信息。
|
||||
|
||||
### 下一步
|
||||
|
||||
* [查看应用部署版本](./get-application-revision)
|
||||
|
|
@ -50,13 +50,13 @@ module.exports = {
|
|||
{
|
||||
"Manage application": [
|
||||
"how-to/dashboard/application/create-application",
|
||||
"how-to/dashboard/application/bind-new-environment",
|
||||
"how-to/dashboard/application/deploy-application",
|
||||
"how-to/dashboard/application/get-application-instance",
|
||||
"how-to/dashboard/application/get-application-log",
|
||||
"how-to/dashboard/application/get-application-endpoint",
|
||||
"how-to/dashboard/application/view-application-resource",
|
||||
"how-to/dashboard/application/get-application-revision",
|
||||
"how-to/dashboard/application/bind-new-environment",
|
||||
"how-to/dashboard/application/recycle-environment",
|
||||
"how-to/dashboard/application/delete-application",
|
||||
],
|
||||
|
|
|
|||
Loading…
Reference in New Issue