DIRKRB-725 Add the guide to enable MySQL plugin.
diff --git a/has-project/docs/has-start.md b/has-project/docs/has-start.md
index 7a3aec8..bf8cf3e 100644
--- a/has-project/docs/has-start.md
+++ b/has-project/docs/has-start.md
@@ -59,6 +59,12 @@
HasInitTool: set_plugin <plugin_name>
HasInitTool: exit
```
+#### Enable MySQL plugin
+Please refer to [MySQL plugin](https://github.com/apache/directory-kerby/blob/trunk/has-project/docs/mysql-plugin.md).
+
+#### Enable LDAP plugin
+Please refer to [LDAP plugin](https://github.com/apache/directory-kerby/blob/trunk/has-project/docs/ldap-plugin.md).
+
### Configure HAS backend:
```
@@ -159,8 +165,8 @@
// Also you can use remote admin tool, admin.keytab file needed to be placed in /etc/has
sh bin/admin-remote.sh <conf_dir>
// Also: sh bin/admin-remote.sh, if HAS_CONF_DIR environment variable has been set.
-HadminLocalTool.local: creprincs hosts.txt
-HadminLocalTool.local: exit
+admin.local: creprincs hosts.txt
+admin.local: exit
```
The admin.keytab file is created by the kdcinit. In local and remote hadmin tool, you can type "?" for help.
@@ -169,8 +175,8 @@
cd kerby-dist/has-dist
// Start local or remote hadmin tool
sh bin/admin-local.sh(bin/admin-remote.sh) <conf_dir> -k <keytab>
-HadminLocalTool.local: hostroles
-HadminLocalTool.local: exit
+admin.local: hostroles
+admin.local: exit
```
#### Export service keytabs:
@@ -179,8 +185,8 @@
// Start local or remote hadmin tool
sh bin/admin-local.sh(bin/admin-remote.sh) <conf_dir> -k <keytab>
// An example of exporting keytabs of localhost(hostname):
-HadminLocalTool.local: expkeytabs localhost
-HadminLocalTool.local: exit
+admin.local: expkeytabs localhost
+admin.local: exit
```
### b. One step to create service principals, export keytabs and deploy keytabs:
@@ -194,7 +200,7 @@
] \
\} > hosts.txt
-// Start local hadmin tool
+// Start local admin tool
sh bin/admin-local.sh <conf_dir> -k <keytab>
// deploy_keytabs [HostRoles-File] [Where-to-Deploy] [SSH-Port] [UserName] [Password]
@@ -202,7 +208,7 @@
// UserName: The host user name
// Password: The host password
// All the hosts with the same user and password
-HadminLocalTool.local: deploy_keytabs hosts.txt 22 /etc/has/ username password
-HadminLocalTool.local: exit
+admin.local: deploy_keytabs hosts.txt 22 /etc/has/ username password
+admin.local: exit
```
-Note: The admin.keytab file is created by the `has-init`. In local hadmin tool, you can type "?" for help.
+Note: The admin.keytab file is created by the `has-init`. In local admin tool, you can type "?" for help.
diff --git a/has-project/docs/ldap-plugin.md b/has-project/docs/ldap-plugin.md
index 9bf1755..5694e95 100644
--- a/has-project/docs/ldap-plugin.md
+++ b/has-project/docs/ldap-plugin.md
@@ -8,7 +8,7 @@
## Prepare user infomation in ApacheDS
### Add user partition
-Please refer to [Add Partition](https://directory.apache.org/apacheds/basic-ug/1.4.3-adding-partition.html)
+Please refer to [Add Partition](https://directory.apache.org/apacheds/basic-ug/1.4.3-adding-partition.html) .
Example:
```
Partition Type: JDBM
diff --git a/has-project/docs/mysql-plugin.md b/has-project/docs/mysql-plugin.md
new file mode 100644
index 0000000..d7b697b
--- /dev/null
+++ b/has-project/docs/mysql-plugin.md
@@ -0,0 +1,37 @@
+
+MySQL Plugin
+===============
+
+## Install MySQL
+
+Please refer to [install mysql](https://dev.mysql.com/doc/refman/5.7/en/linux-installation.html).
+
+## Prepare user infomation in MySQL
+
+### Create database "has" and create table "has_user"
+```
+mysql> create database has;
+mysql> use has;
+mysql> CREATE TABLE has_user(user_name VARCHAR(100), pass_word VARCHAR(100));
+```
+
+### Insert user into table
+Example, username is "hdfs", password is "test":
+```
+mysql> INSERT INTO has_user VALUES ('hdfs', 'test');
+```
+
+## Config HAS server
+Example:
+```
+export mysqlUrl=jdbc:mysql://127.0.0.1:3306/has
+export mysqlUser=root
+export mysqlPasswd=123456
+```
+
+## Config client
+Example:
+```
+export userName=hdfs
+export password=test
+```
