mirror of
https://github.com/kubesphere/website.git
synced 2025-12-26 00:12:48 +00:00
Clean and update apllication in project user guide
Signed-off-by: Ray Zhou <ray@yunify.com>
This commit is contained in:
Ray Zhou
parent
c95bf74223
commit
2d8c2b0d5e
|
|
@ -5,5 +5,3 @@ weight: 2079
|
|||
_build:
|
||||
render: false
|
||||
---
|
||||
|
||||
TBD
|
||||
|
|
|
|||
|
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
title: "Application Repository"
|
||||
keywords: 'kubernetes, chart, helm, KubeSphere, application'
|
||||
description: 'Application Repository'
|
||||
|
||||
|
||||
weight: 2200
|
||||
---
|
||||
|
||||
An application template is the packaging, delivery, and management approach for the application in KubeSphere. An application template is composed of one or more Kubernetes workloads and services according to the application's characteristics and built on the [Helm](https://helm.sh/) packaging specification and delivered through a unified public or private application repository. The public repository is also called App Store in KubeSphere accessible to anybody. The private repository is usually limited access within workspace scope.
|
||||
|
||||
Application templates visualize and provide deployment and management capabilities in KubeSphere, enabling users to quickly deploy applications to specified projects based on application templates. The application template can serve as a standard delivery way for database, middleware and business system created by the enterprise. The templates could be shared between the teams through repository.
|
||||
|
||||
KubeSphere deploys an application repository service based on [OpenPitrix](https://openpitrix.io/) as a [pluggable component](../../../pluggable-components/app-store/). Before using any application template, you need to upload the Helm application package to a reposiotyr hosted by an object storage service, then add the application repository in KubeSphere. The KubeSphere repository service will automatically loads all the applications templates into the repository created in KubeSphere, as described [below](#add-a-sample-repository).
|
||||
|
||||
|
||||
|
||||
In addition, application templates can leverage OpenPitrix's application lifecycle management capabilities to support docking ISV, and regular users through application uploading, application review, deployment testing, application publishing, application version management and more, finally build a public or private application store where offers application services for KubeSphere. Companies can also build industry-wide public or internal application stores to enable standardized one-click delivery of applications, see [OpenPitrix Official Documentation](https://openpitrix.io/docs/v0.4/zh-CN/manual-guide/introduction).
|
||||
|
||||
This document will explain how to add a repository and use it. [Deploy Application from App Template](../deploy-app-from-template/) demonstates how to deploy an example application based on template from workspace private repository. [Deploy Application from App Store](../deploy-app-from-appstore) demonstrates how to deploy an example application from App Store, the public repository built in KubeSphere.
|
||||
|
||||
## Application List
|
||||
|
||||
In a project, the **Applications** under **Application Workloads** shows all deployed applications. This is also the place where you deploy applications based on templates either from a private repository or from App Store.
|
||||
|
||||
|
||||
|
||||
Click **Deploy New Application** to go to the **App Templates** page.
|
||||
|
||||
## Application Template
|
||||
|
||||
### Add a sample repository
|
||||
|
||||
As mentioned earlier, before using an application template, the workspace admin needs to pre-add the available application repository so that users can access and deploy the application from the template.
|
||||
|
||||
This document provides a sample application repository just for demonstration. Users can upload application packages in any Helm-based repository and add it to KubeSphere as needed.
|
||||
|
||||
1. Sign in with the workspace admin account to the KubeSphere and go into the target workspace, then choose **App Management → App Repos** to enter the list page. Click **Add Repo** button.
|
||||
|
||||
|
||||
|
||||
2. Fill in the basic information in the pop-up window, select https for the URL, fill in the blank with `charts.kubesphere.io/stable/`, then click the **Validate** button. After the validation is passed, click **OK** to complete it.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Access the application templates
|
||||
|
||||
Log out and switch to sign in with project-regular account and go into the target project, then choose **Application Workloads → Applications → Deploy New Application → From App Templates → docs-demo-repo**. You can see that all the application templates have been imported into the KubeSphere repository, then you will be able to browse or search any desired application to deploy with one click.
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -4,7 +4,7 @@ keywords: 'kubesphere, kubernetes, docker, devops, service mesh, openpitrix'
|
|||
description: 'Compose a microservice-based application'
|
||||
|
||||
|
||||
weight: 2260
|
||||
weight: 2230
|
||||
---
|
||||
|
||||
TBD
|
||||
|
|
|
|||
|
|
@ -1,53 +1,62 @@
|
|||
---
|
||||
title: "Deploy Applications from App Store"
|
||||
title: "Deploy Application from App Store"
|
||||
keywords: 'kubernetes, chart, helm, KubeSphere, application'
|
||||
description: 'Deploy Applications from App Store'
|
||||
description: 'Deploy Application from App Store'
|
||||
|
||||
|
||||
weight: 2209
|
||||
weight: 2220
|
||||
---
|
||||
|
||||
The application template is the storage, delivery, and management approach for the application in KubeSphere. The application template is built on the [Helm](https://helm.sh/) packaging specification and delivered through a unified public or private application repository. The application can be composed of one or more Kubernetes workloads and services according to the application's characteristics.
|
||||
## Objective
|
||||
|
||||
Application templates visualize and provide deployment and management capabilities in KubeSphere, enabling users to quickly deploy applications to pointed projects based on application templates. The application template can serve as a middleware and business system created by the enterprise, which could be shared between the teams. It can also be used as the basis for constructing industry delivery standards, delivery processes and paths according to industry characteristics.
|
||||
This tutorial shows you a simple example about how to quickly deploy a [Nginx](https://nginx.org/) application using templates from KubeSphere application store sponsored by [OpenPitrix](https://github.com/openpitrix/openpitirx). The demonstration includes one-click deploying apps within a workspace and exposing service by NodePort.
|
||||
|
||||
Before using an application template, you need to add an application repository in advance. KubeSphere built an application repository service based on [OpenPitrix](https://openpitrix.io). Before using the application template, you need to upload the Helm application package to the object storage, then add an application repository in KubeSphere. It will automatically loads all the applications as App template under this repository, as described in [Add Application Repository](../deploy-app-from-repo).
|
||||
## Prerequisites
|
||||
|
||||
|
||||
- You have enabled [KubeSphere App Store](../../pluggable-components/app-store)
|
||||
- You have completed the tutorial in [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/)
|
||||
|
||||
In addition, application templates can also be combined with OpenPitrix's application lifecycle management capabilities to support docking ISV, and regular users through application uploading, application review, deployment testing, application publishing, application version management and more, finnaly build a public or private application store where offers application services for KubeSphere. Companies can also build industry-wide public or internal application stores to enable standardized one-click delivery of applications, see [OpenPitrix Official Documentation](https://openpitrix.io/docs/v0.4/zh-CN/manual-guide/introduction).
|
||||
## Hands-on Lab
|
||||
|
||||
## Application List
|
||||
### Step 1: Browse App Templates
|
||||
|
||||
In all projects, an **application** portal is provided, which serves as an entry point for the application template. Once the application is deployed, it can also be used as a list of applications to manage all applications under the current project.
|
||||
1.1. Switch to use `project-regular` account to log in, then enter into `demo-project`.
|
||||
|
||||
|
||||
1.2. Click **Application Workloads → Applications**, click **Deploy New Application**.
|
||||
|
||||
Click **Deploy New Application** to go to the **App Templates** page.
|
||||
|
||||
|
||||
## Application Template
|
||||
1.3. Choose **From App Store** and enter into app store.
|
||||
|
||||
### Add a sample repository
|
||||
|
||||
|
||||
As mentioned earlier, before using an application template, the cluster admin needs to pre-add the available application repository so that users can access and deploy the application in the application template.
|
||||
|
||||
|
||||
This document provides a sample application repository just for demonstration. Users can upload application packages in the object storage and add application repositories as needed.
|
||||
1.4. Search `Nginx` and click into Nginx App. We will demonstrate how to one-click deploying Nginx to Kubernetes.
|
||||
|
||||
1. Sign in with the cluster admin account to the KubeSphere and go into the target workspace, then choose **App Management → App Repos** to enter the list page.
|
||||
### Step 2: One-click Deploy Nginx Application
|
||||
|
||||
|
||||
2.1. Click **Deploy** on the right. Generally you do not need to change any configuration, just click **Deploy**.
|
||||
|
||||
2. Click **Add Repo** button.
|
||||
|
||||
|
||||
3. Fill in the basic information in the pop-up window, select https for the URL, fill in the blank with `https://helm-chart-repo.pek3a.qingstor.com/kubernetes-charts/`, then click the **Validate** button. After the validation is passed, click **OK** to complete it.
|
||||
2.2. Wait for two minutes, then you will see the application `nginx` showing `active` on the application list.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Access the application templates
|
||||
### Step 3: Expose Nginx Web Service
|
||||
|
||||
3.1. Click into Nginx application, and then enter into its service page.
|
||||
|
||||
|
||||
|
||||
3.2. In this page, make sure its deployment and Pod are running, then click **More → Edit Internet Access**, and select **NodePort** in the dropdown list, click **OK** to save it.
|
||||
|
||||
|
||||
|
||||
3.3. At this point, you will be able to access Nginx web service from outside of the cluster.
|
||||
|
||||
|
||||
|
||||
Log out and switch to sign in with project-regular account, the normal user of the project and go into the target project, then choose **Application Workloads → Applications → Deploy New Application → From App Templates → docs-demo-repo**, you can see that all the applications in the sample application repository have been imported into the application template, then you will be able to browse or search for the desired app for one-click deployment to the desired project.
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,91 +0,0 @@
|
|||
---
|
||||
title: "Deploy Applications from App Repository"
|
||||
keywords: 'kubernetes, chart, helm, KubeSphere, application'
|
||||
description: 'Deploy Applications from App Repository'
|
||||
|
||||
|
||||
weight: 2211
|
||||
---
|
||||
|
||||
## Objective
|
||||
|
||||
This tutorial shows you how to quickly deploy a [Grafana](https://grafana.com/) application using templates from KubeSphere application store sponsored by [OpenPitrix](https://github.com/openpitrix/openpitirx). The demonstration includes importing application repository, sharing and deploying apps within a workspace.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- You have enabled [KubeSphere App Store](../../pluggable-components/app-store)
|
||||
- You have completed the tutorial in [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/)
|
||||
|
||||
## Hands-on Lab
|
||||
|
||||
### Step 1: Add an Application Repository
|
||||
|
||||
> Note: The application repository can be hosted by either object storage, e.g. [QingStor Object Storage](https://www.qingcloud.com/products/qingstor/), [AWS S3](https://aws.amazon.com/what-is-cloud-object-storage/), or by [GitHub Repository](https://github.com/). The packages are composed of Helm Chart template files of the applications. Therefore, before adding an application repository to KubeSphere, you need to create an object storage bucket and upload Helm packages in advance. This tutorial prepares a demo repository based on QingStor Object Storage.
|
||||
|
||||
1.1. Sign in with `ws-admin` account, click **View Workspace** and navigate to **Workspace Settings → App Repos**, then click **Create App Repository**.
|
||||
|
||||
|
||||
|
||||
1.2. Fill in the basic information, name it `demo-repo` and input the URL `https://helm-chart-repo.pek3a.qingstor.com/kubernetes-charts/`. You can validate if this URL is available, and choose **OK** when you have done.
|
||||
|
||||
> Note: It will automatically import all of the applications from the Helm repository into KubeSphere. You can browse those app templates in each project.
|
||||
|
||||
|
||||
|
||||
### Step 2: Browse App Templates
|
||||
|
||||
2.1. Switch to use `project-regular` account to log in, then enter into `demo-project`.
|
||||
|
||||
2.2. Click **Application Workloads → Applications**, click **Deploy New Application**.
|
||||
|
||||
|
||||
|
||||
2.3. Choose **From App Templates** and select `demo-repo` from the dropdown list.
|
||||
|
||||
|
||||
|
||||
2.4. Search `Grafana` and click into Grafana App. We will demonstrate deploying Grafana to Kubernetes as an example.
|
||||
|
||||
> Note: The applications of this demo repository are synchronized from the Google Helm repo. Some applications may not be able to be deployed successfully, since the helm charts were maintained by different organizations.
|
||||
|
||||
### Step 3: Deploy Grafana Application
|
||||
|
||||
3.1. Click **Deploy** on the right. Generally you do not need to change any configuration, just click **Deploy**.
|
||||
|
||||
|
||||
|
||||
3.2. Wait for two minutes, then you will see the application `grafana` showing `active` on the application list.
|
||||
|
||||
|
||||
|
||||
### Step 4: Expose Grafana Service
|
||||
|
||||
4.1. Click into Grafana application, and then enter into its service page.
|
||||
|
||||
|
||||
|
||||
4.2. In this page, make sure its deployment and Pod are running, then click **More → Edit Internet Access**, and select **NodePort** in the dropdown list, click **OK** to save it.
|
||||
|
||||
|
||||
|
||||
4.3. At this point, you will be able to access Grafana service from outside of the cluster.
|
||||
|
||||
|
||||
|
||||
### Step 5: Access the Grafana Service
|
||||
|
||||
In this step, we can access Grafana service using `${Node IP}:${NODEPORT}`, e.g. `http://192.168.0.54:31407`, or click the button **Click to visit** to access the Grafana dashboard.
|
||||
|
||||
5.1. Note you have to obtain the account and password from the grafana secret in advance. Navigate to **Configuration Center → Secrets**, click into **grafana-l47bmc** with Type Default.
|
||||
|
||||
|
||||
|
||||
5.2. Click the eye button to display the secret information, then copy and paste the values of **admin-user** and **admin-password** respectively.
|
||||
|
||||
|
||||
|
||||
5.3. Open the Grafana login page, sign in with the **admin** account.
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Deploy Applications from App Template"
|
||||
title: "Deploy Application from App Template"
|
||||
keywords: 'kubernetes, chart, helm, KubeSphere, application'
|
||||
description: 'Deploy Applications from App Template'
|
||||
description: 'Deploy Application from App Template'
|
||||
|
||||
|
||||
weight: 2210
|
||||
|
|
@ -9,7 +9,7 @@ weight: 2210
|
|||
|
||||
## Objective
|
||||
|
||||
This tutorial shows you a simple example about how to quickly deploy a [Nginx](https://nginx.org/) application using templates from KubeSphere application store sponsored by [OpenPitrix](https://github.com/openpitrix/openpitirx). The demonstration includes one-click deploying apps within a workspace and exposing service by NodePort.
|
||||
This tutorial shows you how to quickly deploy a [Grafana](https://grafana.com/) application using templates from KubeSphere App Store sponsored by [OpenPitrix](https://github.com/openpitrix/openpitirx/). The demonstration includes importing application repository, sharing and deploying apps within a workspace.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
@ -18,45 +18,74 @@ This tutorial shows you a simple example about how to quickly deploy a [Nginx](h
|
|||
|
||||
## Hands-on Lab
|
||||
|
||||
### Step 1: Browse App Templates
|
||||
### Step 1: Add an Application Repository
|
||||
|
||||
1.1. Switch to use `project-regular` account to log in, then enter into `demo-project`.
|
||||
> Note: The application repository can be hosted by either object storage, e.g. [QingStor Object Storage](https://www.qingcloud.com/products/qingstor/), [AWS S3](https://aws.amazon.com/what-is-cloud-object-storage/), or by [GitHub Repository](https://github.com/). The packages are composed of Helm Chart template files of the applications. Therefore, before adding an application repository to KubeSphere, you need to create an object storage bucket and upload Helm packages in advance. This tutorial prepares a demo repository based on QingStor Object Storage.
|
||||
|
||||
1.2. Click **Application Workloads → Applications**, click **Deploy New Application**.
|
||||
1.1. Sign in with `ws-admin` account, click **View Workspace** and navigate to **Workspace Settings → App Repos**, then click **Create App Repository**.
|
||||
|
||||
|
||||
|
||||
1.2. Fill in the basic information, name it `demo-repo` and input the URL `https://helm-chart-repo.pek3a.qingstor.com/kubernetes-charts/`. You can validate if this URL is available, and choose **OK** when you have done.
|
||||
|
||||
> Note: It will automatically import all of the applications from the Helm repository into KubeSphere. You can browse those app templates in each project.
|
||||
|
||||
|
||||
|
||||
### Step 2: Browse App Templates
|
||||
|
||||
2.1. Switch to use `project-regular` account to log in, then enter into `demo-project`.
|
||||
|
||||
2.2. Click **Application Workloads → Applications**, click **Deploy New Application**.
|
||||
|
||||
|
||||
|
||||
1.3. Choose **From App Store** and enter into app store.
|
||||
2.3. Choose **From App Templates** and select `demo-repo` from the dropdown list.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
2.4. Search `Grafana` and click into Grafana App. We will demonstrate deploying Grafana to Kubernetes as an example.
|
||||
|
||||
1.4. Search `Nginx` and click into Nginx App. We will demonstrate how to one-click deploying Nginx to Kubernetes.
|
||||
> Note: The applications of this demo repository are synchronized from the Google Helm repo. Some applications may not be able to be deployed successfully, since the helm charts were maintained by different organizations.
|
||||
|
||||
### Step 2: One-click Deploy Nginx Application
|
||||
### Step 3: Deploy Grafana Application
|
||||
|
||||
2.1. Click **Deploy** on the right. Generally you do not need to change any configuration, just click **Deploy**.
|
||||
3.1. Click **Deploy** on the right. Generally you do not need to change any configuration, just click **Deploy**.
|
||||
|
||||
|
||||
|
||||
|
||||
2.2. Wait for two minutes, then you will see the application `nginx` showing `active` on the application list.
|
||||
3.2. Wait for two minutes, then you will see the application `grafana` showing `active` on the application list.
|
||||
|
||||
|
||||
|
||||
|
||||
### Step 3: Expose Nginx Web Service
|
||||
### Step 4: Expose Grafana Service
|
||||
|
||||
3.1. Click into Nginx application, and then enter into its service page.
|
||||
4.1. Click into Grafana application, and then enter into its service page.
|
||||
|
||||
|
||||
|
||||
|
||||
3.2. In this page, make sure its deployment and Pod are running, then click **More → Edit Internet Access**, and select **NodePort** in the dropdown list, click **OK** to save it.
|
||||
4.2. In this page, make sure its deployment and Pod are running, then click **More → Edit Internet Access**, and select **NodePort** in the dropdown list, click **OK** to save it.
|
||||
|
||||
|
||||
|
||||
|
||||
3.3. At this point, you will be able to access Nginx web service from outside of the cluster.
|
||||
4.3. At this point, you will be able to access Grafana service from outside of the cluster.
|
||||
|
||||
|
||||
|
||||
|
||||
### Step 5: Access the Grafana Service
|
||||
|
||||
In this step, we can access Grafana service using `${Node IP}:${NODEPORT}`, e.g. `http://192.168.0.54:31407`, or click the button **Click to visit** to access the Grafana dashboard.
|
||||
|
||||
5.1. Note you have to obtain the account and password from the grafana secret in advance. Navigate to **Configuration Center → Secrets**, click into **grafana-l47bmc** with Type Default.
|
||||
|
||||
|
||||
|
||||
5.2. Click the eye button to display the secret information, then copy and paste the values of **admin-user** and **admin-password** respectively.
|
||||
|
||||
|
||||
|
||||
5.3. Open the Grafana login page, sign in with the **admin** account.
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue