Merge pull request #1689 from Felixnoo/update-deploy-app-template

Update Doc: Deploy Apps from App Templates
This commit is contained in:
KubeSphere CI Bot 2021-06-09 10:24:11 +08:00 committed by GitHub
commit c3b5e522bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
78 changed files with 53 additions and 53 deletions

View File

@ -1,6 +1,6 @@
---
title: "Deploy Apps from App Templates"
keywords: 'Kubernetes, chart, helm, KubeSphere, application, app templates'
keywords: 'Kubernetes, Chart, Helm, KubeSphere, Application, App Templates'
description: 'Learn how to deploy an application from a Helm-based template.'
linkTitle: "Deploy Apps from App Templates"
weight: 10120
@ -13,23 +13,23 @@ This tutorial demonstrates how to quickly deploy [Grafana](https://grafana.com/)
## Prerequisites
- You have enabled [OpenPitrix (App Store)](../../../pluggable-components/app-store/).
- You have completed the tutorial of [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). Namely, you must have a workspace, a project and two user accounts (`ws-admin` and `project-regular`). `ws-admin` must be granted the role of `workspace-admin` in the workspace and `project-regular` must be granted the role of `operator` in the project.
- You have completed the tutorial of [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). Namely, you must have a workspace, a project and two accounts (`ws-admin` and `project-regular`). `ws-admin` must be granted the role of `workspace-admin` in the workspace and `project-regular` must be granted the role of `operator` in the project.
## Hands-on Lab
### Step 1: Add an app repository
1. Log in to the web console of KubeSphere as `ws-admin`. In your workspace, go to **App Repos** under **Apps Management**, and then click **Add Repo**.
1. Log in to the web console of KubeSphere as `ws-admin`. In your workspace, go to **App Repositories** under **App Management**, and then click **Add**.
![add-app-repo](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/add-app-repo.jpg)
![add-app-repo](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/add-app-repo.png)
2. In the dialog that appears, enter `test-repo` for the app repository name and `https://helm-chart-repo.pek3a.qingstor.com/kubernetes-charts/` for the repository URL. Click **Validate** to verify the URL and click **OK** to continue.
![input-repo-info](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/input-repo-info.jpg)
![input-repo-info](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/input-repo-info.png)
3. Your repository displays in the list after successfully imported to KubeSphere.
3. Your repository appears in the list after successfully imported to KubeSphere.
![repository-list](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/repository-list.jpg)
![repository-list](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/repository-list.png)
{{< notice note >}}
@ -39,13 +39,13 @@ This tutorial demonstrates how to quickly deploy [Grafana](https://grafana.com/)
### Step 2: Deploy Grafana from app templates
1. Log out of KubeSphere and log back in as `project-regular`. In your project, choose **Applications** under **Application Workloads** and click **Deploy New Application**.
1. Log out of KubeSphere and log back in as `project-regular`. In your project, choose **Apps** under **Application Workloads** and click **Deploy New App**.
![create-new-app](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/create-new-app.jpg)
![create-new-app](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/create-new-app.png)
2. Select **From App Templates** from the pop-up dialog.
![select-app-templates](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/select-app-templates.jpg)
![select-app-templates](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/select-app-templates.png)
**From App Store**: Choose built-in apps and apps uploaded individually as Helm charts.
@ -53,7 +53,7 @@ This tutorial demonstrates how to quickly deploy [Grafana](https://grafana.com/)
3. Select `test-repo` from the drop-down list, which is the private app repository just uploaded.
![private-app-template](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/private-app-template.jpg)
![private-app-template](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/private-app-template.png)
{{< notice note >}}
@ -63,7 +63,7 @@ This tutorial demonstrates how to quickly deploy [Grafana](https://grafana.com/)
4. Enter `Grafana` in the search bar to find the app, and then click it to deploy it.
![search-grafana](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/search-grafana.jpg)
![search-grafana](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/search-grafana.png)
{{< notice note >}}
@ -73,15 +73,15 @@ This tutorial demonstrates how to quickly deploy [Grafana](https://grafana.com/)
5. You can view its app information and configuration files. Under **Versions**, select a version number from the list and click **Deploy**.
![deploy-grafana](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/deploy-grafana.jpg)
![deploy-grafana](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/deploy-grafana.png)
6. Set an app name and confirm the version and deployment location. Click **Next** to continue.
![confirm-info](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/confirm-info.jpg)
![confirm-info](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/confirm-info.png)
7. In **App Config**, you can manually edit the manifest file or click **Deploy** directly.
7. In **App Configurations**, you can manually edit the manifest file or click **Deploy** directly.
![app-config](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/app-config.jpg)
![app-config](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/app-config.png)
8. Wait for Grafana to be up and running.
@ -91,37 +91,37 @@ To access Grafana outside the cluster, you need to expose the app through a Node
1. Go to **Services** and click the service name of Grafana.
![grafana-services](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/grafana-services.jpg)
![grafana-services](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/grafana-services.png)
2. Click **More** and select **Edit Internet Access** from the drop-down menu.
![edit-access](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/edit-access.jpg)
![edit-access](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/edit-access.png)
3. Select **NodePort** for **Access Method** and click **OK**. For more information, see [Project Gateway](../../../project-administration/project-gateway/).
![nodeport](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/nodeport.jpg)
![nodeport](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/nodeport.png)
4. Under **Service Ports**, you can see the port is exposed.
![exposed-port](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/exposed-port.jpg)
![exposed-port](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/exposed-port.png)
### Step 4: Access Grafana
1. To access the Grafana dashboard, you need the username and password. Navigate to **Secrets** and click the item that has the same name as the app name.
![grafana-secret](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/grafana-secret.jpg)
![grafana-secret](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/grafana-secret.png)
2. On the detail page, click the eye icon first and you can see the username and password.
2. On the detail page, click the eye icon and you can see the username and password.
![secret-page](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/secret-page.jpg)
![secret-page](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/secret-page.png)
![click-eye-icon](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/click-eye-icon.jpg)
![click-eye-icon](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/click-eye-icon.png)
2. Access Grafana through `${Node IP}:${NODEPORT}`.
2. Access Grafana through `<Node IP>:<NodePort>`.
![grafana-UI](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/grafana-UI.jpg)
![grafana-UI](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/grafana-UI.png)
![home-page](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/home-page.jpg)
![home-page](/images/docs/project-user-guide/applications/deploy-apps-from-app-templates/home-page.png)
{{< notice note >}}

View File

@ -1,6 +1,6 @@
---
title: "从应用模板部署应用"
keywords: 'Kubernetes, chart, helm, KubeSphere, 应用程序, 应用模板'
keywords: 'Kubernetes, Chart, Helm, KubeSphere, 应用程序, 应用模板'
description: '了解如何使用基于 Helm 的模板部署应用程序。'
linkTitle: "从应用模板部署应用"
@ -20,17 +20,17 @@ weight: 10120
### 步骤 1添加应用仓库
1. 以 `ws-admin` 用户登录 KubeSphere Web 控制台。在您的企业空间中,进入**应用管理**下的**应用仓库**页面,并点击**添加仓库**。
1. 以 `ws-admin` 用户登录 KubeSphere Web 控制台。在您的企业空间中,进入**应用管理**下的**应用仓库**页面,并点击**添加仓库**。
![add-app-repo](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/add-app-repo.jpg)
![add-app-repo](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/add-app-repo.png)
2. 在弹出的对话框中,将应用仓库名称设置为 `test-repo`,将应用仓库的 URL 设置为 `https://helm-chart-repo.pek3a.qingstor.com/kubernetes-charts/`,点击**验证**对 URL 进行验证,再点击**确定**进入下一步
2. 在弹出的对话框中,将应用仓库名称设置为 `test-repo`,将应用仓库的 URL 设置为 `https://helm-chart-repo.pek3a.qingstor.com/kubernetes-charts/`,点击**验证**对 URL 进行验证,再点击**确定**。
![input-repo-info](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/input-repo-info.jpg)
![input-repo-info](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/input-repo-info.png)
3. 应用仓库导入成功后会显示在如下图所示的列表中。
![repository-list](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/repository-list.jpg)
![repository-list](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/repository-list.png)
{{< notice note >}}
@ -42,11 +42,11 @@ weight: 10120
1. 登出 KubeSphere 并以 `project-regular` 用户重新登录。在您的项目中,进入**应用负载**下的**应用**页面,再点击**部署新应用**。
![create-new-app](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/create-new-app.jpg)
![create-new-app](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/create-new-app.png)
2. 在弹出的对话框中选择**来自应用模板**。
![select-app-templates](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/select-app-templates.jpg)
![select-app-templates](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/select-app-templates.png)
**来自应用商店**:选择内置的应用和以 Helm Chart 形式单独上传的应用。
@ -54,7 +54,7 @@ weight: 10120
3. 从下拉列表中选择之前添加的私有应用仓库 `test-repo`
![private-app-template](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/private-app-template.jpg)
![private-app-template](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/private-app-template.png)
{{< notice note >}}
@ -64,7 +64,7 @@ weight: 10120
4. 在搜索框中输入 `grafana` 找到该应用,点击搜索结果进行部署。
![search-grafana](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/search-grafana.jpg)
![search-grafana](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/search-grafana.png)
{{< notice note >}}
@ -72,17 +72,17 @@ weight: 10120
{{</ notice >}}
5. 您可以查看应用信息和配置文件,在**版本**下拉列表中选择版本,然后点击部署。
5. 您可以查看应用信息和配置文件,在**版本**下拉列表中选择版本,然后点击**部署**
![deploy-grafana](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/deploy-grafana.jpg)
![deploy-grafana](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/deploy-grafana.png)
6. 设置应用名称,确认应用版本和部署位置,点击**下一步**。
![confirm-info](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/confirm-info.jpg)
![confirm-info](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/confirm-info.png)
7. 在**应用配置**页面,您可以手动编辑清单文件或直接点击部署。
7. 在**应用配置**页面,您可以手动编辑清单文件或直接点击**部署**
![app-config](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/app-config.jpg)
![app-config](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/app-config.png)
8. 等待 Grafana 创建完成并开始运行。
@ -92,37 +92,37 @@ weight: 10120
1. 打开**服务**页面,点击 Grafana 的服务名称。
![grafana-services](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/grafana-services.jpg)
![grafana-services](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/grafana-services.png)
2. 点击**更多操作**,在下拉菜单中选择**编辑外网访问**。
![edit-access](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/edit-access.jpg)
![edit-access](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/edit-access.png)
3. 将**访问方式**设置为 **NodePort** 并点击**确定**。有关更多信息,请参见[项目网关](../../../project-administration/project-gateway/)。
![nodeport](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/nodeport.jpg)
![nodeport](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/nodeport.png)
4. 您可以在**服务端口**区域查看暴露的端口。
![exposed-port](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/exposed-port.jpg)
![exposed-port](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/exposed-port.png)
### 步骤 4访问 Grafana
1. 您需要获取用户名和密码才能登录 Grafana 主页。导航至**密钥**页面,点击与应用名称相同的条目。
1. 您需要获取用户名和密码才能登录 Grafana 主页。前往**密钥**页面,点击与应用名称相同的条目。
![grafana-secret](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/grafana-secret.jpg)
![grafana-secret](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/grafana-secret.png)
2. 在详情页面,点击眼睛图标查看用户名和密码。
![secret-page](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/secret-page.jpg)
![secret-page](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/secret-page.png)
![click-eye-icon](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/click-eye-icon.jpg)
![click-eye-icon](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/click-eye-icon.png)
2. 用 `${Node IP}:${NODEPORT}` 地址访问 Grafana。
2. 用 `<Node IP>:<NodePort>` 地址访问 Grafana。
![grafana-UI](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/grafana-UI.jpg)
![grafana-UI](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/grafana-UI.png)
![home-page](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/home-page.jpg)
![home-page](/images/docs/zh-cn/project-user-guide/applications/deploy-apps-from-app-templates/home-page.png)
{{< notice note >}}

Binary file not shown.

After

Width:  |  Height:  |  Size: 537 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 476 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 454 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 392 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 660 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 242 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 283 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 723 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 654 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 228 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 196 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 346 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 316 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 589 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 418 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 472 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 274 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 502 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 153 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 174 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 384 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 204 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 642 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 302 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 288 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 711 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 581 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 174 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 387 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 718 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 538 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 392 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 490 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 237 KiB