Skip to content

Commit 2766fce

Browse files
committed
[AMORO-3404] Correct the description about MySQL usage
The lincense of MySQL is incompatible with Apache Lincese, we need to correct the descriptions This closes apache/amoro#3403
1 parent d8a73ee commit 2766fce

File tree

3 files changed

+21
-35
lines changed

3 files changed

+21
-35
lines changed

amoro-docs/content/admin-guides/deployment-on-kubernetes.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -157,16 +157,16 @@ ingress:
157157
### Configure the database.
158158
159159
AMS default is to use Derby database for storage. When the pod is destroyed, the data will also disappear.
160-
In production environments, we recommend using MySQL as the storage for system data.
160+
In production environments, we recommend using a RDBMS as the storage for system data, you can ref to [Database Configuration](/deployment/#configure-system-database) for more detail.
161161
162162
```yaml
163163
amoroConf:
164164
database:
165-
type: mysql
166-
driver: com.mysql.cj.jdbc.Driver
167-
url: <jdbc-uri>
168-
username: <mysql-user>
169-
password: <mysql-password>
165+
type: ${your_database_type}
166+
driver: ${your_database_driver}
167+
url: ${your_jdbc_url}
168+
username: ${your_username}
169+
password: ${your_password}
170170
```
171171
172172

amoro-docs/content/admin-guides/deployment.md

+14-28
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ You can choose to download the stable release package from [download page](../..
3131
## System requirements
3232

3333
- Java 8 is required.
34-
- Optional: MySQL 5.5 or higher
35-
- Optional: PostgreSQL 14.x or higher
34+
- Optional: A RDBMS (PostgreSQL 14.x or higher, MySQL 5.5 or higher)
3635
- Optional: ZooKeeper 3.4.x or higher
3736

3837
## Download the distribution
@@ -99,38 +98,25 @@ Make sure the port is not used before configuring it.
9998
10099
### Configure system database
101100
102-
You can use MySQL/PostgreSQL as the system database instead of the default Derby.
101+
Amoro used `Derby` as the backend storage default, so you can use `Derby` directly without any additional configuration.
103102

104-
If you would like to use MySQL as the system database, you need to manually download the [MySQL JDBC Connector](https://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.1.0/mysql-connector-j-8.1.0.jar)
105-
and move it into the `{AMORO_HOME}/lib/` directory. You can use the following command to complete these operations:
106-
```shell
107-
$ cd ${AMORO_HOME}
108-
$ MYSQL_JDBC_DRIVER_VERSION=8.0.30
109-
$ wget https://repo1.maven.org/maven2/mysql/mysql-connector-java/${MYSQL_JDBC_DRIVER_VERSION}/mysql-connector-java-${MYSQL_JDBC_DRIVER_VERSION}.jar
110-
$ mv mysql-connector-java-${MYSQL_JDBC_DRIVER_VERSION}.jar lib
111-
```
103+
You can also configure a relational backend storage as you needed.
104+
105+
> If you would like to use MySQL as the system database, you need to manually download the [MySQL JDBC Connector](https://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.1.0/mysql-connector-j-8.1.0.jar)
106+
and move it into the `${AMORO_HOME}/lib/` directory.
112107

113-
Create an empty database in MySQL/PostgreSQL, then AMS will automatically create tables in this MySQL/PostgreSQL database when it first started.
108+
You need to create an empty database in the RDBMS before to start the server, then AMS will automatically create tables in the database when it first started.
114109

115-
One thing you need to do is Adding MySQL/PostgreSQL configuration under `config.yaml` of Ams:
110+
One thing you need to do is adding configuration under `config.yaml` of Ams:
116111

117112
```yaml
118-
# MySQL
119113
ams:
120114
database:
121-
type: mysql
122-
jdbc-driver-class: com.mysql.cj.jdbc.Driver
123-
url: jdbc:mysql://127.0.0.1:3306/amoro?useUnicode=true&characterEncoding=UTF8&autoReconnect=true&useAffectedRows=true&allowPublicKeyRetrieval=true&useSSL=false
124-
username: root
125-
password: root
126-
# PostgreSQL
127-
#ams:
128-
# database:
129-
# type: postgres
130-
# jdbc-driver-class: org.postgresql.Driver
131-
# url: jdbc:postgresql://127.0.0.1:5432/amoro
132-
# username: user
133-
# password: passwd
115+
type: ${database_type} # postgres or mysql
116+
jdbc-driver-class: ${your_driver_name}
117+
url: ${your_jdbc_url}
118+
username: ${your_username}
119+
password: ${your_password}
134120
```
135121

136122
### Configure high availability
@@ -296,7 +282,7 @@ $ bin/ams.sh stop
296282

297283
### Upgrade system databases
298284

299-
You can find all the upgrade SQL scripts under `{AMORO_HOME}/conf/mysql/` with name pattern `upgrade-a.b.c-to-x.y.z.sql`.
285+
You can find all the upgrade SQL scripts under `${AMORO_HOME}/conf/${db_type}/` with name pattern `upgrade-a.b.c-to-x.y.z.sql`.
300286
Execute the upgrade SQL scripts one by one to your system database based on your starting and target versions.
301287

302288
### Replace all libs and plugins

amoro-docs/content/concepts/catalogs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ the multi-catalog feature can be used to support SQL across data sources, such a
3434

3535
```SQL
3636
SELECT c.ID, c.NAME, c.AGE, o.AMOUNT
37-
FROM MYSQL.ONLINE.CUSTOMERS c JOIN HIVE.OFFLINE.ORDERS o
37+
FROM ${CATALOG_A}.ONLINE.CUSTOMERS c JOIN ${CATALOG_B}.OFFLINE.ORDERS o
3838
ON (c.ID = o.CUSTOMER_ID)
3939
```
4040

0 commit comments

Comments
 (0)