Skip to content

Commit 123d645

Browse files
authored
Update dashboard how-to guide (#5417)
* Replace Dashboard How-to for a complete Managing application lifecycle with Kubeapps How-to * Update list of How-to guides * Update site/content/docs/latest/howto/dashboard.md
1 parent 19a72e3 commit 123d645

20 files changed

+106
-25
lines changed

site/content/docs/latest/howto/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ How-to guides can be thought of as directions that guide the reader through the
88
| [Basic Form Support](./basic-form-support.md) | Configure your Helm chart in order to present a simple intuitive form during installation. |
99
| [Custom App View Support](./custom-app-view-support.md) | Inject custom app views for specific deployments. |
1010
| [Custom Form Component Support](./custom-form-component-support.md) | Extend basic form with custom UI component or third party APIs for component values and validation. |
11-
| [Dashboard](./dashboard.md) | Manage and deploy applications in your cluster by using Kubeapps dashboard. |
11+
| [Managing application lifecycle with Kubeapps](./dashboard.md) | Manage and deploy applications in your cluster by using Kubeapps dashboard. |
1212
| [Multi-cluster Support](./deploying-to-multiple-clusters.md) | Configure Kubeapps to target other clusters when deploying a package, in addition to the cluster on which Kubeapps is itself deployed. |
1313
| [Offline Installation](./offline-installation.md) | Install Kubeapps in an offline environment (without Internet connection) |
1414
| [Private Package Repository](./private-app-repository.md) | Configure Kubeapps to use a private package repository. |
+105-24
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,128 @@
1-
# Using the Dashboard
1+
# Managing application lifecycle with Kubeapps
22

3-
Once you have [installed Kubeapps in your cluster](https://github.com/vmware-tanzu/kubeapps/tree/main/chart/kubeapps) you can use the Dashboard to start managing and deploying applications in your cluster. Checkout the [Getting Started](../tutorials/getting-started.md) guide to learn how to access the Dashboard and deploy your first application.
3+
## Table of Contents
44

5-
The following sections walk you through some common tasks with the Kubeapps Dashboard.
5+
1. [Introduction](#introduction)
6+
2. [Pre-requisites](#pre-requisites)
7+
3. [Browse applications in the configured repositories](#browse-applications-in-the-configured-repositories)
8+
4. [Application details](#application-details)
9+
5. [Deploy an application](#deploy-an-application)
10+
6. [Update an application](#update-an-application)
11+
7. [Delete an application](#delete-an-application)
12+
8. [Browse applications installed in the cluster](#browse-applications-installed-in-the-cluster)
613

7-
## Work with Charts
14+
## Introduction
815

9-
### Deploy new applications using the Dashboard
16+
[Kubeapps](https://kubeapps.dev/) provides a cloud native solution to browse, deploy and manage the lifecycle of applications on a Kubernetes cluster. It is a one-time install that gives you a number of important benefits, including the ability to:
1017

11-
- Start with the Dashboard welcome page:
18+
- browse and deploy packaged applications from public or private repositories
19+
- customize deployments through an intuitive user interface
20+
- upgrade, manage and delete the applications that are deployed in your Kubernetes cluster
21+
- expose an API to manage your package repositories and your applications
1222

13-
![Dashboard main page](../img/dashboard-home.png)
23+
This guide explains in detail how to **manage the lifecycle** of your applications in Kubernetes with Kubeapps.
1424

15-
- Use the "Catalog" menu to select an application from the list of applications available. This example assumes you want to deploy MariaDB.
25+
## Pre-requisites
1626

17-
![MariaDB chart](../img/mariadb-chart.png)
27+
- Kubeapps up and running (see [Get Started with Kubeapps](../tutorials/getting-started.md))
28+
- A Package Repository configured in Kubeapps (see [Managing Package Repositories with Kubeapps](../tutorials/managing-package-repositories.md))
1829

19-
- Click the "Deploy" button. You will be prompted for the release name, cluster namespace and values for your application deployment.
30+
## Browse applications in the configured repositories
2031

21-
![MariaDB installation](../img/mariadb-installation.png)
32+
To explore the list of applications available in the existing repositories configured in Kubeapps:
2233

23-
- Click the "Submit" button. The application will be deployed. You will be able to track the new Kubernetes deployment directly from the browser. The "Notes" section of the deployment page contains important information to help you use the application.
34+
1. Click **Catalog** in the main menu.
35+
2. Kubeapps displays in the center of the page a list with the applications available in the configured repositories.
2436

25-
![MariaDB deployment](../img/mariadb-deployment.png)
37+
![Browse catalog](../img/dashboard/browse-catalog.png)
2638

27-
### List all the applications running in your cluster
39+
**Search** and **filtering options** are available to improve the experience to explore and find applications.
2840

29-
The "Applications" page displays a list of the application deployments in your cluster.
41+
## Application details
3042

31-
![Deployment list](../img/dashboard-deployments.png)
43+
Kubeapps provides a complete overview of applications, metadata and parameters to have all necessary information before deploying into your cluster.
3244

33-
### Remove existing application deployments
45+
- Click on any app from the **Catalog view**, for example, **Wordpress**.
46+
- Kubeapps navigates to the detail page including:
3447

35-
You can remove any of the applications from your cluster by clicking the "Delete" button on the application's status page:
48+
- **Application data** (on the left side): name, package format, app version, package version, categories, home URL, maintainers, related URLs
49+
- **README.md**: Kubeapps render the information available in the package README.md file (including all configuration parameters to install the package).
3650

37-
![Deployment removal](../img/dashboard-delete-deployment.png)
51+
![Browse Application](../img/dashboard/browse-application.png)
52+
![Browse Application parameters](../img/dashboard/browse-application-parameters.png)
3853

39-
### Add more chart repositories
54+
From the top-right corner, you can select the **package version** to deploy the application into your cluster.
4055

41-
By default, Kubeapps comes with the Bitnami repository enabled. You can see the list of enabled chart repositories in the "Package Repositories" page under the menu:
56+
## Deploy an application
4257

43-
![Repositories List](../img/dashboard-repos.png)
58+
Click the **Deploy** button from the detail page. Kubeapps displays a new view for the deployment, including:
4459

45-
Add new repositories (for example, your organization's chart repository) by clicking the "Add Package Repository" button. Fill the "Add Repository" form using the repository info. For a detailed guide of how to add package repositories, check [this guide](./private-app-repository.md).
60+
- `Application data`: same information displayed previously in the detail view.
61+
- `Name`: a descriptive name for the application.
62+
- `Deployment values`: set application values for deployment. Kubeapps provides two alternatives to edit parameters:
63+
- **Visual editor**: table view component to search, paginate and update values for the different parameters.
64+
- **YAML editor**: to directly edit the YAML file (including the capability to enable a diff view to show changes from default).
4665

47-
![Adding repository](../img/dashboard-add-repo.png)
66+
![Deploy application visual editor](../img/dashboard/deploy-application-visual-editor.png)
67+
![Deploy application visual editor with parameters](../img/dashboard/deploy-application-visual-editor-parameters.png)
68+
![Deploy application visual editor](../img/dashboard/deploy-application-yaml-editor.png)
69+
70+
Set values for configuration parameters and click the **Deploy** button to launch the deployment.
71+
72+
> There is another button to help you restore parameters to the default values in the package.
73+
74+
You can track the deployment directly from Kubeapps. The "Notes" section on the deployment page contains important information to help you use the application.
75+
76+
![Deploy application progress not ready](../img/dashboard/deploy-application-progress-0.png)
77+
![Deploy application progress 1 pod](../img/dashboard/deploy-application-progress-1.png)
78+
![Deploy application progress ready](../img/dashboard/deploy-application-progress-ready.png)
79+
80+
## Update an application
81+
82+
Kubeapps provides an easy way to identify applications with an updated version available in the repository.
83+
84+
- In the list of applications installed in your cluster, with an **arrow**:
85+
86+
![Update application arrow](../img/dashboard/update-application-list.png)
87+
88+
- In the detail view with an **info message** on the left side:
89+
90+
![Update application message](../img/dashboard/update-application-message.png)
91+
92+
Once you have selected the application to update, click either the **Update** button or the **Update Now** link in the message. Kubeapps displays the deployment view.
93+
94+
For the update case, the Visual Editor table displays the following columns:
95+
96+
- `Defalut value`: including the default value for each parameter in the package.
97+
- `Deployed value`: including the value deployed in the cluster for each parameter.
98+
- `Current value`: to set the value for each parameter in the upgrade process.
99+
100+
![Update application visual editor](../img/dashboard/update-application-visual-editor.png)
101+
102+
The YAML Editor includes options to enable a diff to compare:
103+
104+
- `Package values`: comparing new values in the YAML file with default values in the package.
105+
- `Deployed values`: comparing new values in the YAML file with deployed values in the cluster.
106+
107+
![Update application YAML editor](../img/dashboard/update-application-yaml-editor.png)
108+
109+
### Delete an application
110+
111+
You can remove any of the applications from your cluster by clicking the **Delete** button on the application's status page:
112+
113+
![Deployment removal](../img/dashboard/delete-application.png)
114+
115+
## Browse applications installed in the cluster
116+
117+
To explore the list of applications installed in the cluster directly from Kubeapps:
118+
119+
1. Click **Application** in the main menu.
120+
2. Kubeapps displays in the center of the page a list with the applications installed in the selected context (cluster / namespace):
121+
122+
![Deployment list](../img/dashboard/update-application-list.png)
123+
124+
Kubeapps also provides the ability for listing applications in all namespaces for the selected cluster. Activate the toggle option **Show apps in all namespaces**:
125+
126+
![Deployment list all namespaces](../img/dashboard/list-available-applications.png)
127+
128+
> **NOTE**: An additional benefit for Kubeapps is that it reflects the status of applications in the cluster (even if not managed directly by using Kubeapps). So any change performed by using the Helm, Flux or Carvel directly from the CLI, is visible from Kubeapps when listing the installed applications in the cluster.
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
-87.3 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)