Update: deploy first application (#401)
* adjust sidebar: getting-started, deliver-app and manage-app (#371) * Deliver first your app (#379) * adjust sidebar of deliver your app * Add: first vela app * multi-env * Deliver first your app (#381) * adjust sidebar of deliver your app * Add: first vela app * multi-env * multi cluster and scaler * Feat: change core concept doc (#382) Signed-off-by: barnettZQG <barnett.zqg@gmail.com> * update multi-cluster (#383) * change install and quick-start doc (#384) Signed-off-by: barnettZQG <barnett.zqg@gmail.com> * finishing ZH (#385) * Docs: add k8s objects doc (#386) Signed-off-by: barnettZQG <barnett.zqg@gmail.com> * Add EN: core concept (#388) * Docs: add helm doc (#389) Signed-off-by: barnettZQG <barnett.zqg@gmail.com> * V1.2 en 02 (#390) * Add: Deploy First Application * Add EN: install * V1.2 en 03 (#392) * Add: deploy Kubernetes raw resource * Add: helm chart * Docs: change latest version (#394) Signed-off-by: barnettZQG <barnett.zqg@gmail.com> * Doc: v1.2.0 Beta.3 * fix check-linl Signed-off-by: BinaryHB0916 <davidduan0916@gmail.com> * Update: quick-start-cli * Update * Update: deploy first application Co-authored-by: barnettZQG <barnett.zqg@gmail.com>
|
@ -2,7 +2,7 @@
|
|||
title: Deploy First Application
|
||||
---
|
||||
|
||||
> Before starting, please confirm that you've installed KubeVela Core and VelaUX in the control plane cluster based on [Install from Kubernetes cluster](./install.mdx)
|
||||
> Before starting, please confirm that you've installed KubeVela Core and VelaUX in the control plane cluster based on [Installation](./install.mdx)
|
||||
>
|
||||
> If you want to use KubeVela CLI for application delivery, please check [Deliver First Application](./end-user/quick-start-cli) in the Vela CLI manual.
|
||||
|
||||
|
@ -11,28 +11,28 @@ Welcome to KubeVela! In this section, we show you how to deliver your first app
|
|||
Follow these steps:
|
||||
|
||||
1. Prepare a Docker image. we use [crccheck/hello-world](https://hub.docker.com/r/crccheck/hello-world) for this time. Double-check if you're able to download it properly.
|
||||
2. Create the first `Application`.
|
||||
2. Create the first `Application` of `webervice` which is the common way to deploy stateless service.
|
||||
3. Check out the status of the Application's instance.
|
||||
|
||||
You'll get to know:
|
||||
|
||||
- Get familiar with core concepts as [Application](./getting-started/core-concept#application), [Cluster](getting-started/core-concept#cluster), [Target](getting-started/core-concept#target) and [Project](getting-started/core-concept#project)
|
||||
- Get familiar with core concepts as [Application](./getting-started/core-concept#application), [Environment](getting-started/core-concept#environment), [Target](getting-started/core-concept#target) and [Project](getting-started/core-concept#project)
|
||||
- Finished an application delivery by operating VelaUX
|
||||
|
||||
## Choosing deployment type and Environment
|
||||
|
||||
After VelaUX is installed, the first page you enter is for managing the app:
|
||||
|
||||

|
||||

|
||||
|
||||
Then click the button of `New Application` on the upper-right, type in these things:
|
||||
|
||||
- Name and other basic Infos
|
||||
- Choose the Project. We've created a default Project for you to use or you can click `New` to create your own
|
||||
- Choose the deployment type. In this case, we use `webservice` to deploy Stateless Application
|
||||
- Choose your environment. We select `local` Target for dev Environment
|
||||
1. Name and other basic Infos.
|
||||
2. Choose the Project. We've created a default Project for you to use or you can click `New` to create your own.
|
||||
3. Choose the deployment type. In this case, we use `webservice` to deploy Stateless Application.
|
||||
4. Choose your environment. We select the `Default` Environment based on the `Default` Target.
|
||||
|
||||

|
||||

|
||||
|
||||
## Setting up properties
|
||||
|
||||
|
@ -46,7 +46,7 @@ Next step, we see the page of properties. Configure following:
|
|||
|
||||
Confirmed. Notice that this application is only created but not deployed yet. VelaUX defaultly generates [Workflow](./getting-started/core-concept#workflow) and replicas of [Trait](./getting-started/core-concept#trait).
|
||||
|
||||

|
||||

|
||||
|
||||
## Executing Workflow to deploy
|
||||
|
||||
|
|
After Width: | Height: | Size: 183 KiB |
Before Width: | Height: | Size: 173 KiB |
After Width: | Height: | Size: 109 KiB |
Before Width: | Height: | Size: 116 KiB |
After Width: | Height: | Size: 90 KiB |
Before Width: | Height: | Size: 108 KiB |
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 108 KiB |
Before Width: | Height: | Size: 191 KiB After Width: | Height: | Size: 183 KiB |
|
@ -41,7 +41,7 @@ KubeVela 作为一个开箱即用、面向现代微服务架构的应用交付
|
|||
基于上述能力,用户现在可以通过 KubeVela 非常轻松的处理以下场景:
|
||||
|
||||
### 多环境、多集群应用交付
|
||||
面向 Kubernetes 的多环境、多集群交付已是一个标准性需求。您或许是需要环境隔离,开发、预发和生产三套集群;或许是需要交付不同的客户,每个客户独立一套集群;或许是需要交付到不同区域,在北京、广州多套集群;又或许您业务规模大,单个 Kubernetes 集群无法满足您的资源需求。从 1.1 版本开始,KubeVela 不仅实现了多集群的应用交付,并且既可以独立工作直接纳管多个集群,也可以集成 OCM、Karmada 等各类多集群管理工具来进行更复杂的交付动作。
|
||||
面向 Kubernetes 的多环境、多集群交付已是一个标准性需求。你或许是需要环境隔离,开发、预发和生产三套集群;或许是需要交付不同的客户,每个客户独立一套集群;或许是需要交付到不同区域,在北京、广州多套集群;又或许你业务规模大,单个 Kubernetes 集群无法满足你的资源需求。从 1.1 版本开始,KubeVela 不仅实现了多集群的应用交付,并且既可以独立工作直接纳管多个集群,也可以集成 OCM、Karmada 等各类多集群管理工具来进行更复杂的交付动作。
|
||||
|
||||

|
||||
_多集群应用发布Demo(结合Workflow)_
|
||||
|
@ -63,7 +63,7 @@ Workflow 的背景前面已经提到过,而它的具体使用场景则很多
|
|||

|
||||
_应用渐进式发布Demo(结合Workflow)_
|
||||
|
||||
您可以参考 [Rollout Demo](https://github.com/oam-dev/kubevela/tree/master/docs/examples/workflow/canary-rollout)实现图示效果,或参考最佳实践 [基于 Istio 的渐进式发布](https://kubevela.io/docs/case-studies/canary-blue-green/),体验完整的微服务渐进式发布和回滚。
|
||||
你可以参考 [Rollout Demo](https://github.com/oam-dev/kubevela/tree/master/docs/examples/workflow/canary-rollout)实现图示效果,或参考最佳实践 [基于 Istio 的渐进式发布](https://kubevela.io/docs/case-studies/canary-blue-green/),体验完整的微服务渐进式发布和回滚。
|
||||
|
||||
### 以应用为中心的云资源交付
|
||||
云厂商资源已经成为大多数应用开发者生产业务会采用的计算资源,它包括了基础设施、SaaS服务、中间件服务、托管服务等。对此,KubeVela 的设计是从“以应用为中心”的视角出发,帮助开发者以完全 Serverless 的方式更好、更方便的管理云资源,而不是疲于应付各种不同的云产品和控制台。在实现上,KubeVela 内置集成了 Terraform 来作为云资源的编排工具,并且能够以统一的应用模型支持各个云厂商上百种不同类型云服务的部署、绑定和管理。
|
||||
|
@ -112,7 +112,7 @@ KubeVela 是一个从第一天就诞生在云原生社区的开源项目。截
|
|||
## 参考信息
|
||||
立即安装使用,请参考:[安装指南](https://kubevela.io/docs/install)
|
||||
|
||||
您可以通过如下材料了解更多关于 KubeVela 以及 OAM 项目的细节:
|
||||
你可以通过如下材料了解更多关于 KubeVela 以及 OAM 项目的细节:
|
||||
- 项目代码库:https://github.com/oam-dev/kubevela 欢迎 Star/Watch/Fork!
|
||||
- 项目官方主页与文档:https://kubevela.io ,从1.1版本开始,已提供中文、英文文档,更多语言文档欢迎开发者进行翻译。
|
||||
- 项目钉钉群:23310022;Slack:[CNCF #kubevela Channel](https://cloud-native.slack.com/archives/C01BLQ3HTJA)
|
||||
|
|
|
@ -23,7 +23,7 @@ description: 本文介绍通过KubeVela 交付云厂商提供的服务,并能
|
|||
|
||||
开启成功后,让我们回到左侧第一个 `Application` 第一个选项卡,点击右上角的 `New Application` 开始创建应用:
|
||||
|
||||

|
||||

|
||||
|
||||
然后选择你需要的 Name 和 Project 后,新建一个 `Type` 是 alibaba-oss 的应用。同时你可以看到,**可供选择使用的云资源类型已经包括了 ACK、RDS、Redis、SLS 等等**:
|
||||
|
||||
|
|
|
@ -5,7 +5,7 @@ description: 本文介绍通过 KubeVela 交付 Helm Chart
|
|||
|
||||
本文介绍了如何通过 KubeVela 交付 Helm Chart 包交付到多个目标环境和集群。
|
||||
|
||||
通过 Helm Chart 包交付应用主要的应用场景是交付开源中间件应用,比如 [bitnami](https://github.com/bitnami/charts) 中包括了常用的生产可用中间件;交付开源工具应用,比如 Gitlab、Jenkins 等等,这些应用在 [Helm 官方仓库](https://hub.helm.sh/) 中可以获取到。KubeVela 可以帮助您将这些应用便捷地部署到管理的任何集群,并管理他们。
|
||||
通过 Helm Chart 包交付应用主要的应用场景是交付开源中间件应用,比如 [bitnami](https://github.com/bitnami/charts) 中包括了常用的生产可用中间件;交付开源工具应用,比如 Gitlab、Jenkins 等等,这些应用在 [Helm 官方仓库](https://hub.helm.sh/) 中可以获取到。KubeVela 可以帮助你将这些应用便捷地部署到管理的任何集群,并管理他们。
|
||||
|
||||
通过本文,你将学习使用 KubeVela 插件体系安装扩展插件。Helm Chart 包的交付能力目前由 FluxCD 插件支撑,FluxCD 插件除了带来 Helm 类型的应用交付能力以外还带来了 Kustomize 的交付能力。
|
||||
|
||||
|
@ -34,7 +34,7 @@ description: 本文介绍通过 KubeVela 交付 Helm Chart
|
|||
|
||||
## 通过 Chart 创建 Redis 应用
|
||||
|
||||
相信你通过之前的文章,已经掌握了应用的创建能力。我们需要使用 Chart 创建 Redis 应用,只需要选择应用部署类型为 `helm`,然后选择您准备好的具有默认 StorageClass 可以提供 PV 的集群 Target,然后进入部署参数配置页面。
|
||||
相信你通过之前的文章,已经掌握了应用的创建能力。我们需要使用 Chart 创建 Redis 应用,只需要选择应用部署类型为 `helm`,然后选择你准备好的具有默认 StorageClass 可以提供 PV 的集群 Target,然后进入部署参数配置页面。
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -85,7 +85,7 @@ Target 必须属于一个项目,同一个项目中的应用可以使用 Target
|
|||
|
||||

|
||||
|
||||
(3)设置部署参数,直接上传准备好的 Yaml 文件即可。需要注意的是,资源的名称如果在配置中指定,即使用配置的名称,您需要确定其与已存在的资源不冲突,如果不指定,则使用 KubeVela 资源命名规则自动命名。编辑器会自动将输入的内容进行格式化。
|
||||
(3)设置部署参数,直接上传准备好的 Yaml 文件即可。需要注意的是,资源的名称如果在配置中指定,即使用配置的名称,你需要确定其与已存在的资源不冲突,如果不指定,则使用 KubeVela 资源命名规则自动命名。编辑器会自动将输入的内容进行格式化。
|
||||
|
||||

|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: 交付第一个应用
|
|||
|
||||
欢迎来到 KubeVela! 在本小节中,我们会向你介绍一些例子来帮助你理解如何使用 KubeVela 解决应用交付中的实际问题。
|
||||
|
||||
在实践之前,请确保您已经按照 [快速安装](../install.mdx) 文档,在您的控制平面集群中安装了 KubeVela。
|
||||
在实践之前,请确保你已经按照 [快速安装](../install.mdx) 文档,在你的控制平面集群中安装了 KubeVela。
|
||||
|
||||
## 一个最简单的示例
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
title: 工作流步骤
|
||||
---
|
||||
|
||||
本文档将详细介绍 KubeVela 内置的各个工作流步骤。您可以通过自由的组合它们来设计完整的交付工作流。
|
||||
本文档将详细介绍 KubeVela 内置的各个工作流步骤。你可以通过自由的组合它们来设计完整的交付工作流。
|
||||
|
||||
## apply-application
|
||||
|
||||
|
|
|
@ -279,7 +279,7 @@ kubectl get service velaux -n vela-system -o jsonpath="{.spec.ports[0].nodePort}
|
|||
vela addon enable velaux serviceType=NodePort repo=acr.kubevela.net
|
||||
```
|
||||
|
||||
`serviceType` 配置 velaux 服务的访问方式,如果您使用云服务集群,请配置为 `serviceType=LoadBalancer`,启用完成后通过以下方式获取访问地址:
|
||||
`serviceType` 配置 velaux 服务的访问方式,如果你使用云服务集群,请配置为 `serviceType=LoadBalancer`,启用完成后通过以下方式获取访问地址:
|
||||
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=LoadBalancer repo=acr.kubevela.net
|
||||
|
@ -287,7 +287,7 @@ vela addon enable velaux serviceType=LoadBalancer repo=acr.kubevela.net
|
|||
kubectl get service velaux -n vela-system -o jsonpath="{.status.loadBalancer.ingress[0].ip}"
|
||||
```
|
||||
|
||||
如果您的集群中已经安装了 Nginx Ingress Controller,而且你具有可用的域名,你可以这样部署 VelaUX(请使用真实域名替换 example.doamin.com):
|
||||
如果你的集群中已经安装了 Nginx Ingress Controller,而且你具有可用的域名,你可以这样部署 VelaUX(请使用真实域名替换 example.doamin.com):
|
||||
|
||||
```shell script
|
||||
vela addon enable velaux repo=acr.kubevela.net domain=example.doamin.com
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
title: 交付第一个应用
|
||||
---
|
||||
|
||||
> 在实践之前,请确保你已经按照 [从 Kubernetes 集群安装](./install.mdx) 文档,在你的控制平面集群中安装了 KubeVela Core 和 VelaUX。
|
||||
> 在实践之前,请确保你已经按照 [快速安装](./install.mdx) 文档,在你的控制平面集群中安装了 KubeVela Core 和 VelaUX。
|
||||
>
|
||||
> 如果你希望通过使用 KubeVela CLI 来进行应用交付,请查看 Vela CLI 手册的 [交付第一个应用](./end-user/quick-start-cli)。
|
||||
|
||||
|
@ -10,30 +10,30 @@ title: 交付第一个应用
|
|||
|
||||
你将会操作的步骤有:
|
||||
|
||||
1. 准备一个服务镜像,本例中我们将使用: [crccheck/hello-world](https://hub.docker.com/r/crccheck/hello-world),请确保您的环境可以正常下载该镜像;
|
||||
1. 准备一个服务镜像,本例中我们将使用: [crccheck/hello-world](https://hub.docker.com/r/crccheck/hello-world),请确保你的环境可以正常下载该镜像;
|
||||
2. 基于服务镜像创建第一个 `webservice` 类型的 `Application`,这是无状态服务最简化的交付方式;
|
||||
3. 查看应用实例运行状态;
|
||||
|
||||
你将学习到内容的有:
|
||||
|
||||
- 初步接触 [Application](./getting-started/core-concept#应用(application))、[Cluster](getting-started/core-concept#集群(cluster))、[Target](getting-started/core-concept#交付目标(target)) 和 [Project](getting-started/core-concept#项目(project)) 等核心概念。
|
||||
- 初步接触 [应用(Application)](./getting-started/core-concept#应用(application))、[环境(Environment)](getting-started/core-concept#环境(Environment)))、[交付目标(Target)](getting-started/core-concept#交付目标(target)) 和 [项目(Project)](getting-started/core-concept#项目(project)) 等核心概念。
|
||||
|
||||
- 通过操作 VelaUX 完整交付一个应用。
|
||||
|
||||
## 选择应用的部署类型/规划应用部署环境
|
||||
|
||||
VelaUX 正常安装后,您进入的第一个页面即应用交付管理页面。
|
||||
VelaUX 正常安装后,你进入的第一个页面即应用交付管理页面。
|
||||
|
||||

|
||||

|
||||
|
||||
然后点击右上角的 `New Application` 按钮开始创建应用,按照 UI 提示填写以下四个维度的信息:
|
||||
|
||||
- 应用的名称等基础信息;
|
||||
- 选择所属的项目,我们已为你自动生成了默认项目,您也可以点击 `New` 进行创建;
|
||||
- 选择所属的项目,我们已为你自动生成了默认项目,你也可以点击 `New` 进行创建;
|
||||
- 选择应用的部署类型,本例中我们选择 `webservice` 类型,部署无状态服务,请注意,企业大多数业务应用都可以直接使用该类型进行部署。
|
||||
- 规划应用交付的环境,本例中我们为开发环境选择 `Default` 交付目标;
|
||||
- 规划应用交付的环境,我们选择基于默认 `Default` 交付目标创建的默认 `Default` 环境;
|
||||
|
||||

|
||||

|
||||
|
||||
## 设置应用的部署参数
|
||||
|
||||
|
@ -47,7 +47,7 @@ VelaUX 正常安装后,您进入的第一个页面即应用交付管理页面
|
|||
|
||||
确认创建后即可进入应用管理页面,这时应用还没有开始进行部署,VelaUX 默认生成了开发环境的交付 [工作流](./getting-started/core-concept#工作流(workflow)) 和调整应用副本数量的 [运维特征](./getting-started/core-concept#运维特征(trait))。
|
||||
|
||||

|
||||

|
||||
|
||||
## 执行环境的部署
|
||||
|
||||
|
|
After Width: | Height: | Size: 183 KiB |
Before Width: | Height: | Size: 173 KiB |
After Width: | Height: | Size: 109 KiB |
Before Width: | Height: | Size: 116 KiB |
After Width: | Height: | Size: 90 KiB |
Before Width: | Height: | Size: 108 KiB |
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 108 KiB |
Before Width: | Height: | Size: 191 KiB After Width: | Height: | Size: 183 KiB |
|
@ -2,7 +2,7 @@
|
|||
title: 工作流步骤
|
||||
---
|
||||
|
||||
本文档将详细介绍 KubeVela 内置的各个工作流步骤。您可以通过自由的组合它们来设计完整的交付工作流。
|
||||
本文档将详细介绍 KubeVela 内置的各个工作流步骤。你可以通过自由的组合它们来设计完整的交付工作流。
|
||||
|
||||
## apply-application
|
||||
|
||||
|
|
|
@ -4,7 +4,7 @@ title: 交付第一个应用
|
|||
|
||||
欢迎来到 KubeVela! 在本小节中,我们会向你介绍一些例子来帮助你理解如何使用 KubeVela 解决应用交付中的实际问题。
|
||||
|
||||
在实践之前,请确保您已经按照 [快速安装](./install.mdx) 文档,在您的控制平面集群中安装了 KubeVela。
|
||||
在实践之前,请确保你已经按照 [快速安装](./install.mdx) 文档,在你的控制平面集群中安装了 KubeVela。
|
||||
|
||||
## 一个最简单的示例
|
||||
|
||||
|
@ -243,7 +243,7 @@ spec:
|
|||
|
||||
## 下一步
|
||||
|
||||
上述所有功能,只是 KubeVela 这个现代化的云原生应用交付与管理平台的冰山一角。您可以从下面步骤来开始更好的了解 KubeVela:
|
||||
上述所有功能,只是 KubeVela 这个现代化的云原生应用交付与管理平台的冰山一角。你可以从下面步骤来开始更好的了解 KubeVela:
|
||||
|
||||
- 查看 KubeVela 的[`应用交付模型`](./core-concepts/application),进一步理解其是如何工作的。
|
||||
- 学习 KubeVela 的[`系统架构`](./core-concepts/architecture),深入了解 KubeVela 本身的设计与架构原理。
|
||||
|
|