Skip to content

Commit

Permalink
Docs: update Quick Start (#3970)
Browse files Browse the repository at this point in the history
Signed-off-by: Carson Yang <yangchuansheng33@gmail.com>
  • Loading branch information
yangchuansheng authored Sep 22, 2023
1 parent 07abd93 commit 4809993
Show file tree
Hide file tree
Showing 82 changed files with 205 additions and 184 deletions.
2 changes: 1 addition & 1 deletion docs/4.0/docs/Intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# What is Sealos
# What is Sealos?

The vastness and complexity of the cloud-native ecosystem undoubtedly leaves many businesses in disarray, yearning for an efficient, ready-to-use distribution, which this ecosystem sorely lacks. The cloud-native market is in dire need of a cloud operating system to further reduce barriers and costs.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
sidebar_position: 4
---

# Use Database App

Databases are fundamental tools for data management, designed for efficient storage and access. Sealos offers a user-friendly database interface, eliminating the complexities of command-line operations. This assists in managing an array of databases, such as relational databases, NoSQL, vector databases, and streaming databases. With just a few clicks in the "[Database](../../platform-components/dbprovider/dbprovider.md)" app, you can seamlessly create a variety of databases, including MySQL, PostgreSQL, MongoDB, Redis, and many more.

This guide will show you how to install MySQL use Databse app.

# Install MySQL

1. Open Database app in the [Sealos](https://cloud.sealos.io) desktop.

![](./images/database-launch.jpg)

2. Click on 'Create Database' and finalize the basic configuration.

![](./images/database-configure.png)

3. Click on 'Deploy' then click 'Confirm' to wait for the successful creation of the MySQL.

![](./images/database-more.png)

4. Click on 'connect', which will directly launch the "Terminal" application, leading you to the database command line.

![](./images/database-connect.png)

# Install PostgreSQL and MongoDB

The installation process for PostgreSQL and MongoDB mirrors that of MySQL. Simply choose the respective database type on the basic configuration page.

![](./images/database-select.png)
34 changes: 34 additions & 0 deletions docs/4.0/docs/quick-start/app-deployments/use-a-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 1
---

# Use a template

This guide will show you how to use templates to fast-track applications deployment. and maximize Sealos's features.

## 1. Find a template

Start by accessing the "**Templates**" in the Sealos desktop.

![](./images/templates.jpg)

select the template you’d like to deploy

![Viewing the templates marketplace](./images/templates-2.png)

Not sure which one to use? How about [exploring FastGPT](../../examples/ai-applications/install-fastgpt-on-desktop.md)

## 2. Deploy the template to Sealos

Once you've selected a template, configure the necessary parameters, then click **Deploy Application** on the template page to start deployment.

![Deploying your chosen template](./images/deploy-template.png)

Once deployment concludes, click "Confirm" to navigate to the application's details.

![](./images/template-detail.png)

Wait for the application's status to switch to running. Subsequently, click on the external link to launch the application's Web interface directly through the external domain name.

![](./images/app-url.png)

31 changes: 31 additions & 0 deletions docs/4.0/docs/quick-start/app-deployments/use-app-launchpad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
sidebar_position: 2
---

# Use App Launchpad

Sealos desktop is similar to that of PC operating systems, such as macOS or Windows. Each icon on the desktop represents an app, similar to the shortcuts in Windows. Like PC operating systems, Sealos also comes with built-in apps. To quickly install applications on this cloud operating system, you need to use the system's built-in **App Launchpad**.

> For more information about application management, please refer to [Introduction to App Launchpad](../../platform-components/applaunchpad/applaunchpad.md)
This guide will show you how to quickly install some common applications on the Sealos cloud operating system.

## Deploy nginx

First, open App Launchpad in the [Sealos](https://cloud.sealos.io) desktop.

![](./images/app-launchpad.jpg)

Click on "New Application".

Enter the application name and image name in sequence, enable external network access, and then click "Deploy Application" to proceed.

![](./images/app-deployment.png)

Once the deployment is finished, click "Details" to enter the application's detailed view.

you can view the operational metrics of the Nginx application, including CPU and memory usage. Click on the external link to open the Nginx interface directly via the external domain name.

![](./images/app-nginx.png)

![](./images/SCR-20230529-sokx.png)
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
sidebar_position: 2
sidebar_position: 3
---

# Swiftly Install Applications with Terminal
# Use Terminal

For those proficient in Kubernetes and container basics, terminal command-line deployment presents an optimal solution. This document showcases Nginx as an example, elucidating the application deployment process via terminal.
Users familiar with Kubernetes and container fundamentals may opt to deploy applications using the **[Terminal](../../platform-components/terminal/terminal.md)** app. This guide will show you how to use the terminal for deployment, using Nginx as an example.

Commence by opening the terminal application within the [Sealos](https://cloud.sealos.io) desktop environment.
Start by launching the Terminal app within the [Sealos](https://cloud.sealos.io) desktop.

![](./images/app-launchpad-1.jpg)

Upon initializing the terminal application, a default terminal window is assigned, allowing the execution of various command-line operations.
Upon opening the Terminal app, a terminal window is automatically allocated, enabling you to execute various command-line operations.

![](./images/terminal.png)

First, create a deployment manifest for Nginx Deployment:
Begin by creating a deployment manifest for Nginx Deployment:

```yaml
# deployment.yaml
Expand Down Expand Up @@ -48,7 +48,7 @@ spec:
memory: 32Mi
```
② Subsequently, construct a deployment manifest for Nginx Service:
② Subsequently, create a deployment manifest for Nginx Service:
```yaml
# service.yaml
Expand All @@ -68,14 +68,14 @@ spec:
app: nginx
```
Execute the following commands to generate Deployment and Service from the deployment manifest:
Deploy both the Deployment and Service by executing the following:
```bash
kubectl apply -f deployment.yaml
kubectl apply -f service.yaml
```

Assess if Nginx can be accessed normally:
Verify Nginx's accessibility:

```bash
$ kubectl get pod -l app=nginx
Expand Down Expand Up @@ -114,7 +114,7 @@ Commercial support is available at
</html>
```

If you desire to expose Nginx to the internet, enabling access via external network domain, you'll need to create an Ingress resource. Start by creating a deployment manifest:
To expose Nginx to the internet and access it via a public domain, create an Ingress resource. Start by creating a deployment manifest:

```yaml
# ingress.yaml
Expand Down Expand Up @@ -156,12 +156,12 @@ spec:
secretName: wildcard-cloud-sealos-io-cert
```
Execute the following command to create an Ingress resource from the deployment manifest:
Deploy the Ingress resource:
```bash
$ kubectl apply -f ingress.yaml
```

Test if Nginx can be accessed normally through the external network domain:
Confirm the Nginx's accessibility through the public domain:

![](./images/nginx.png)
Diff not rendered.
Diff not rendered.
Binary file removed docs/4.0/docs/quick-start/images/database-launch.png
Diff not rendered.
Binary file removed docs/4.0/docs/quick-start/images/database-more1.png
Diff not rendered.
Binary file removed docs/4.0/docs/quick-start/images/database-more2.png
Diff not rendered.
Binary file removed docs/4.0/docs/quick-start/images/database-select.png
Diff not rendered.
67 changes: 0 additions & 67 deletions docs/4.0/docs/quick-start/install-apps-with-app-launchpad.md

This file was deleted.

45 changes: 0 additions & 45 deletions docs/4.0/docs/quick-start/install-db-with-database.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/4.0/i18n/zh-Hans/Intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 什么是 Sealos
# 什么是 Sealos

云原生生态之庞大与复杂,无疑让许多企业感到手足无措,这个生态依然缺乏好用的、开箱即用的发行版。在云原生市场还急需一款云操作系统以进一步降低云原生门槛与成本。

Expand Down
4 changes: 4 additions & 0 deletions docs/4.0/i18n/zh-Hans/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
"message": "快速开始",
"description": "The label for category Quick Start in sidebar docSidebar"
},
"sidebar.docSidebar.category.App Deployments": {
"message": "部署应用",
"description": "The label for category App Deployments in sidebar docSidebar"
},
"sidebar.docSidebar.category.Platform Components": {
"message": "平台组件",
"description": "The label for category Platform Components in sidebar docSidebar"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
sidebar_position: 4
---

# 安装数据库应用

数据库是数据管理的重要手段 , 可用于高效地存储和访问数据。Sealos 提供了一个简单易用的数据库前端应用,屏蔽了繁琐的命令行操作,帮助你管理关系数据库、NoSQL、向量数据库和流数据库等各种类型的数据库。你只需通过「[数据库](../../platform-components/dbprovider/dbprovider.md)」应用就能轻松创建各种数据库,包括 MySQL、PostgreSQL、MongoDB、Redis 等多种类型的数据库。

下面将通过示例来演示 Sealos 如何快速安装 MySQL。

# 快速安装 MySQL

1.[Sealos](https://cloud.sealos.top) 桌面环境中打开数据库。

![](./images/database-launch.jpg)

2. 点击新建数据库,完成基础配置设置。

![](./images/database-configure.png)

3. 点击「部署」,然后点击「确认」等待数据库创建成功。

![](./images/database-more.png)

4. 点击一键连接,就可以直接打开「[终端](../../platform-components/terminal/terminal.md)」应用进入数据库的命令行终端。

![](./images/database-connect.png)

# 快速安装 PostgreSQL 和 MongoDB

PostgreSQL 和 MongoDB 数据库的安装和 MySQL 类似,需要在基础配置界面选择相应的数据库类型。

![](./images/database-select.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 1
---

# 使用模板

这篇文档将会向您展示如何使用应用模板来快速安装各种分布式应用,并最大限度地发挥 Sealos 的功能。

## 1. 选择模板

首先在 [Sealos](https://cloud.sealos.top) 桌面环境中打开「模板市场」。

![](./images/templates.jpg)

选择自己想要部署的应用模板。

![查看模板市场](./images/templates-2.png)

不知道部署哪个应用?可以试试 [FastGPT AI 知识库](../../examples/ai-applications/install-fastgpt-on-desktop.md)

## 2. 将模板应用部署到 Sealos

选择模板之后,设置好相应的参数值,点击「部署应用」按钮开始部署。

![将模板部署到 Sealos](./images/deploy-template.png)

部署完成后,点击「确认」跳转到应用详情。

![](./images/template-detail.png)

等待应用的状态变成 `running` 之后,点击外网地址即可通过外网域名直接打开应用的 Web 界面。

![](./images/app-url.png)

Loading

0 comments on commit 4809993

Please sign in to comment.