Skip to content

Commit 8524589

Browse files
liboyang0730liboyang0730
authored
Merge pull request #76 from oceanbase/xiaofeng_branch
增加英文版入门教程第五章
2 parents 4a8d94c + c2513b9 commit 8524589

File tree

49 files changed

+11150
-8055
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+11150
-8055
lines changed

‎docs/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_01_overview_of_the_oceanbase_database/00_introduction.md‎

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
1-
---
2-
title: Introduction
3-
weight: 1
4-
---
5-
6-
# 1.0 Introduction
7-
8-
This chapter introduces OceanBase Database and OceanBase ecological tools.
9-
10-
11-
## Contact us
12-
13-
You can contact us in the following ways:
14-
15-
* Forum on the official website of OceanBase Database Community Edition: [https://ask.oceanbase.com/](https://ask.oceanbase.com/)
16-
17-
* GitHub page for reporting issues of OceanBase Database Community Edition: [https://github.com/oceanbase/oceanbase/issues](https://github.com/oceanbase/oceanbase/issues)
18-
19-
* DingTalk group ID: 33254054
20-
21-
> **Note**
22-
>
23-
> You can click [here](https://open.oceanbase.com/course/275) to learn the supporting course of this tutorial — From Beginner to Pro: A Guide for DBAs.
1+
---
2+
title: Introduction
3+
weight: 1
4+
---
5+
6+
# 1.0 Introduction
7+
8+
This chapter introduces OceanBase Database and OceanBase ecological tools.
9+
10+
## Topics
11+
12+
* 1.1 OceanBase Database
13+
14+
* 1.2 OceanBase ecological tools
15+
16+
## Contact us
17+
18+
You can contact us in the following ways:
19+
20+
* Forum on the official website of OceanBase Database Community Edition: [https://ask.oceanbase.com/](https://ask.oceanbase.com/)
21+
22+
* GitHub page for reporting issues of OceanBase Database Community Edition: [https://github.com/oceanbase/oceanbase/issues](https://github.com/oceanbase/oceanbase/issues)
23+
24+
* DingTalk group ID: 33254054
25+
26+
> **Note**
27+
>
28+
> You can click [here](https://open.oceanbase.com/course/275) to learn the supporting course of this tutorial — From Beginner to Pro: A Guide for DBAs.

‎docs/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_01_overview_of_the_oceanbase_database/01_overview.md‎

Lines changed: 418 additions & 418 deletions
Large diffs are not rendered by default.

‎docs/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_01_overview_of_the_oceanbase_database/02_ecological-tools.md‎

Lines changed: 191 additions & 191 deletions
Large diffs are not rendered by default.

‎docs/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/00_introduction.md‎

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,39 @@
1-
---
2-
title: Introduction
3-
weight: 1
4-
---
5-
6-
# 2.0 Introduction
7-
8-
This chapter describes how to deploy OceanBase Database in an experience environment and a production environment. It also introduces some common database management operations, such as creating tenants, connecting to tenants, viewing resources, and setting variables.
9-
10-
## Contact us
11-
12-
You can contact us in the following ways:
13-
14-
* Forum on the official website of OceanBase Database Community Edition: [https://ask.oceanbase.com/](https://ask.oceanbase.com/)
15-
16-
* GitHub page for reporting issues of OceanBase Database Community Edition: [https://github.com/oceanbase/oceanbase/issues](https://github.com/oceanbase/oceanbase/issues)
17-
* DingTalk group ID: 33254054
18-
19-
> **Note**
20-
>
1+
---
2+
title: Introduction
3+
weight: 1
4+
---
5+
6+
# 2.0 Introduction
7+
8+
This chapter describes how to deploy OceanBase Database in an experience environment and a production environment. It also introduces some common database management operations, such as creating tenants, connecting to tenants, viewing resources, and setting variables.
9+
10+
## Topics
11+
12+
* 2.1 Preparations before deployment
13+
14+
* 2.2 Ecosystem components for deployment
15+
16+
* 2.3 Deploy OceanBase Database in an experience environment
17+
18+
* 2.4 Deploy OceanBase Database in a production environment
19+
20+
* 2.5 View the resource usage of an OceanBase cluster
21+
22+
* 2.6 Create a MySQL user tenant
23+
24+
* 2.7 Connect to a tenant
25+
26+
* 2.8 Set parameters and variables
27+
28+
## Contact us
29+
30+
You can contact us in the following ways:
31+
32+
* Forum on the official website of OceanBase Database Community Edition: [https://ask.oceanbase.com/](https://ask.oceanbase.com/)
33+
34+
* GitHub page for reporting issues of OceanBase Database Community Edition: [https://github.com/oceanbase/oceanbase/issues](https://github.com/oceanbase/oceanbase/issues)
35+
* DingTalk group ID: 33254054
36+
37+
> **Note**
38+
>
2139
> You can click [here](https://open.oceanbase.com/course/275) to learn the supporting course of this tutorial — From Beginner to Pro: A Guide for DBAs (in Chinese).

‎docs/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/01_preparation_before_deployment.md‎

Lines changed: 710 additions & 710 deletions
Large diffs are not rendered by default.

‎docs/user_manual/quick_starts_and_hands_on_practices_in_english/chapter_02_deploy_oceanbase_database/02_deployment_components.md‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
1-
---
2-
title: Ecosystem components for deployment
3-
weight: 3
4-
---
5-
6-
# 2.2 Ecosystem components for deployment
7-
8-
Generally, OceanBase Deployer (OBD), OceanBase Cloud Platform (OCP), and ob-operator are used to deploy OceanBase Database. The deployment tools apply to different scenarios.
9-
10-
* For enterprise users, OCP is recommended because it provides a wide range of O&M features that can facilitate O&M management in the future.
11-
12-
* For individual users or enterprise users with a few resources, OBD is recommended because this CLI-based tool consumes the fewest resources.
13-
14-
* For Kubernetes users, ob-operator is recommended because it allows the users to use OceanBase Database in line with their existing habits.
15-
16-
The following table compares the three deployment tools.
17-
18-
| Comparison item | OBD | OCP | ob-operator |
19-
| ---------------------- | ---------------- | ------------------------------------------------------------ | ------------------------- |
20-
| Supported OceanBase Database versions | V3.1.x and V4.x | V3.1.x and V4.x | V4.x |
21-
| Online/Offline deployment | Both supported | Only offline deployment supported | Both supported |
22-
| Compiled installation packages | Supported | Supported | Supported |
23-
| High availability<blockquote>**Note**<br></br>This refers to the high availability of the tool itself, not the high availability of the deployed OceanBase cluster. </blockquote> | Not supported | Supported | Supported (based on Kubernetes) |
24-
| Standalone and multi-node deployment | Supported | Not supported | Supported |
25-
| Security | Depending on operating system permissions | High (A user role-based permission isolation mechanism is provided to ensure resource security.) | Depending on the permission system of Kubernetes |
26-
| Ecosystem integration method | Open source code | Open APIs | Open source code |
27-
| Difficulty of getting started | Low | Medium | Depending on the familiarity with the Kubernetes environment |
28-
| Resource consumption | Low | High | Medium |
29-
30-
The following table describes the feature support of the tools.
31-
32-
> **Note**
33-
>
34-
> The feature support information in the following table is provided based on OBD V2.8.0, OCP V4.3.0, and ob-operator V2.2.0 (Dashboard V0.3.0). The feature support may vary across versions. To obtain accurate feature support information, see the official documentation for the specific version of the tool you are using.
35-
36-
| Feature | OBD | OCP | ob-operator |
37-
| -------------- | ---------------------- | ---- | ----------- |
38-
| Tenant creation | Supported | Supported | Supported |
39-
| Tenant viewing | Supported | Supported | Supported |
40-
| Database management | Not supported | Supported | Not supported |
41-
| User permission management | Not supported | Supported | Not supported |
42-
| Resource management | Not supported | Supported | Supported |
43-
| Resource isolation | Not supported | Supported | Not supported |
44-
| Major compaction management | Not supported | Supported | Not supported |
45-
| Backup and restore | Not supported | Supported | Supported |
46-
| Monitoring and alerting | Monitoring is supported but alerting is not. | Supported | Supported |
47-
| Scaling | Scale-out is supported but scale-in is not. | Supported | Supported |
48-
| TopSQL and SlowSQL | Not supported | Supported | Not supported |
49-
| Transaction diagnostics | Not supported | Supported | Not supported |
50-
| Deadlock diagnostics | Not supported | Supported | Not supported |
51-
| Session management | Not supported | Supported | Not supported |
52-
| Primary and standby databases | Supported | Supported | Supported |
53-
54-
You can select an appropriate tool to deploy OceanBase Database as needed based on the comparison results in the preceding tables.
1+
---
2+
title: Ecosystem components for deployment
3+
weight: 3
4+
---
5+
6+
# 2.2 Ecosystem components for deployment
7+
8+
Generally, OceanBase Deployer (OBD), OceanBase Cloud Platform (OCP), and ob-operator are used to deploy OceanBase Database. The deployment tools apply to different scenarios.
9+
10+
* For enterprise users, OCP is recommended because it provides a wide range of O&M features that can facilitate O&M management in the future.
11+
12+
* For individual users or enterprise users with a few resources, OBD is recommended because this CLI-based tool consumes the fewest resources.
13+
14+
* For Kubernetes users, ob-operator is recommended because it allows the users to use OceanBase Database in line with their existing habits.
15+
16+
The following table compares the three deployment tools.
17+
18+
| Comparison item | OBD | OCP | ob-operator |
19+
| ---------------------- | ---------------- | ------------------------------------------------------------ | ------------------------- |
20+
| Supported OceanBase Database versions | V3.1.x and V4.x | V3.1.x and V4.x | V4.x |
21+
| Online/Offline deployment | Both supported | Only offline deployment supported | Both supported |
22+
| Compiled installation packages | Supported | Supported | Supported |
23+
| High availability<blockquote>**Note**<br></br>This refers to the high availability of the tool itself, not the high availability of the deployed OceanBase cluster. </blockquote> | Not supported | Supported | Supported (based on Kubernetes) |
24+
| Standalone and multi-node deployment | Supported | Not supported | Supported |
25+
| Security | Depending on operating system permissions | High (A user role-based permission isolation mechanism is provided to ensure resource security.) | Depending on the permission system of Kubernetes |
26+
| Ecosystem integration method | Open source code | Open APIs | Open source code |
27+
| Difficulty of getting started | Low | Medium | Depending on the familiarity with the Kubernetes environment |
28+
| Resource consumption | Low | High | Medium |
29+
30+
The following table describes the feature support of the tools.
31+
32+
> **Note**
33+
>
34+
> The feature support information in the following table is provided based on OBD V2.8.0, OCP V4.3.0, and ob-operator V2.2.0 (Dashboard V0.3.0). The feature support may vary across versions. To obtain accurate feature support information, see the official documentation for the specific version of the tool you are using.
35+
36+
| Feature | OBD | OCP | ob-operator |
37+
| -------------- | ---------------------- | ---- | ----------- |
38+
| Tenant creation | Supported | Supported | Supported |
39+
| Tenant viewing | Supported | Supported | Supported |
40+
| Database management | Not supported | Supported | Not supported |
41+
| User permission management | Not supported | Supported | Not supported |
42+
| Resource management | Not supported | Supported | Supported |
43+
| Resource isolation | Not supported | Supported | Not supported |
44+
| Major compaction management | Not supported | Supported | Not supported |
45+
| Backup and restore | Not supported | Supported | Supported |
46+
| Monitoring and alerting | Monitoring is supported but alerting is not. | Supported | Supported |
47+
| Scaling | Scale-out is supported but scale-in is not. | Supported | Supported |
48+
| TopSQL and SlowSQL | Not supported | Supported | Not supported |
49+
| Transaction diagnostics | Not supported | Supported | Not supported |
50+
| Deadlock diagnostics | Not supported | Supported | Not supported |
51+
| Session management | Not supported | Supported | Not supported |
52+
| Primary and standby databases | Supported | Supported | Supported |
53+
54+
You can select an appropriate tool to deploy OceanBase Database as needed based on the comparison results in the preceding tables.

0 commit comments

Comments
 (0)