Skip to content
This repository was archived by the owner on Apr 20, 2023. It is now read-only.

Commit 9bafc83

Browse files
authored
Update README.md
Updated information on the privileges for delphix db user and delphix OS user. Updated information on the different ways to create a dSource.
1 parent af4f723 commit 9bafc83

File tree

1 file changed

+38
-27
lines changed

1 file changed

+38
-27
lines changed

README.md

Lines changed: 38 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,18 @@ The Delphix virtualization SDK (https://github.com/delphix/virtualization-sdk) p
66

77
## MySQL Plugin
88
MySQL plugin is developed to virtualize MySQL data source leveraging the following built-in MySQL technologies:
9-
- Replication: Allows staging MySQL instance to be kept in sync with teh source database.
10-
- Ingest Backup: Dsource can be created by ingesting a MySQL backup.
11-
- Subsetting: Allows to create a dSource using a specific list of tables from source database.
9+
Features:
1210
- Environment Discovery: MySQL plugin can discover environments where MySQL server is installed.
11+
- Ingesting Data: Create a dSource using differnt methods specified below.
1312
- VDB Creation: Single node MySQL VDB can be provisioned from the dsource snapshot.
1413

14+
Different Ways to Ingest Data ( Dsource creation )
15+
- Replication with Delphix initiated Backup: Delphix takes an initial backup from source DB to ingest data and create a dSource. Delphix also sets up a master-slave replication to keep this dSource in sync with the source database. User can select the databases they want to virtualize
16+
- Replication with User Provided Backup: User provides a backup file from source DB to ingest data and create a dSource. Delphix sets up a master-slave replication to keep this dSource in sync with your source database.
17+
- User Provided Backup with no Replication: User provides a backup file from source DB to ingest data and create a dSource. When a new backup is available, user initiates a resync of the dSource to ingest data from the new backup.
18+
- Manual Backup Ingestion: Delphix creates an empty seed datanase and User manually ingests a backup to create a dSource.
19+
- Simple Tablespace Backup/Subsetting: Allows to create a dSource using a specific list of tables from source database.
20+
1521

1622
### Table of Contents
1723
1. [Prerequisites](#requirements-plugin)
@@ -35,11 +41,11 @@ MySQL plugin is developed to virtualize MySQL data source leveraging the followi
3541

3642
**MySQL database user with following privileges**
3743
1. delphixdb
38-
This MySQL user must be configured to have following privilege from the Delphix Engine IP as well as the staging host IP.
44+
This MySQL user must be configured to have following privilege from the Delphix Engine IP, the staging host IP and localhost
3945
To grant the privilege for this user, use the following command:
4046

4147
```js
42-
SQL> GRANT SELECT, RELOAD, REPLICATION CLIENT,REPLICATION SLAVE,SHOW VIEW, EVENT, TRIGGER on *.* to 'delphix'@'%';
48+
SQL> GRANT SELECT, SHUTDOWN, SUPER, RELOAD, REPLICATION CLIENT,REPLICATION SLAVE,SHOW VIEW, EVENT, TRIGGER on *.* to 'delphix'@'%';
4349
```
4450

4551
OR
@@ -48,41 +54,46 @@ OR
4854
SQL> GRANT ALL PRIVILEGES ON *.* TO '<delphix>'@'%';
4955
```
5056

51-
#### _Staging Requirements_
57+
#### _Staging Host Specific Requirements_
5258

5359
**O/S user with following privileges**
54-
55-
1. Same version as Source MySQL Binaries installed.
56-
2. A MySQL config file (my.cnf) to be used for the Staging DB instance must be available under Delphix Toolkit Directory.
57-
3. Regular o/s user. should be able to ps all processes.
58-
4. Execute access on mysqldump, mysqld, mysql binary
59-
5. Empty folder on host to hold delphix toolkit [ approximate 2GB free space ]
60-
6. Empty folder on host to mount nfs filesystem. This is just and empty folder with no space requirements and act as base folder for nfs mounts.
61-
7. sudo privileges for mount, umount. See sample below assuming `delphix_os` is used as delphix user.
62-
60+
1. Regular o/s user. should be able to ps all processes.
61+
2. Should be in the same primary and secondary groups as mysql user ( or the MySQL binary owner )
62+
3. Execute access on all files within MySQL installation folder - Min permission level 775 recommended.
63+
4. Sudo privileges for mount, umount. See sample below assuming `delphix_os` is used as delphix user.
64+
Example sudoers file entry
6365
```shell
6466
Defaults:delphix_os !requiretty
6567
delphix_os ALL=NOPASSWD: \
66-
/bin/mount, /bin/umount
67-
```
68+
/bin/mount, /bin/umount, /bin/mkdir, /bin/rmdir, /bin/ps
6869

69-
#### _Target Requirements_
70-
71-
**O/S user with following privileges**
70+
**Other Staging Host Requirements**
7271

7372
1. Same version as Source MySQL Binaries installed.
7473
2. A MySQL config file (my.cnf) to be used for the Staging DB instance must be available under Delphix Toolkit Directory.
75-
3. Regular o/s user. should be able to ps all processes.
76-
4. Execute access on mysqldump, mysqld, mysql binary
77-
5. Empty folder on host to hold delphix toolkit [ approximate 2GB free space ]
78-
6. Empty folder on host to mount nfs filesystem. This is just and empty folder with no space requirements and act as base folder for nfs mounts.
79-
7. sudo privileges for mount, umount. See sample below assuming `delphix_os` is used as delphix user.
74+
3. Empty folder on host to hold delphix toolkit [ approximate 2GB free space ]
75+
4. Empty folder on host to mount nfs filesystem. This is just and empty folder with no space requirements and act as base folder for nfs mounts.
76+
8077

78+
#### _Target Requirements_
79+
80+
**O/S user with following privileges**
81+
1. Regular o/s user. should be able to ps all processes.
82+
2. Should be in the same primary and secondary groups as mysql user ( or the MySQL binary owner )
83+
3. Execute access on all files within MySQL installation folder - Min permission level 775 recommended.
84+
4. Sudo privileges for mount, umount. See sample below assuming `delphix_os` is used as delphix user.
85+
Example sudoers file entry
8186
```shell
8287
Defaults:delphix_os !requiretty
8388
delphix_os ALL=NOPASSWD: \
84-
/bin/mount, /bin/umount
85-
```
89+
/bin/mount, /bin/umount, /bin/mkdir, /bin/rmdir, /bin/ps
90+
91+
**Other Staging Host Requirements**
92+
93+
1. Same version as Source MySQL Binaries installed.
94+
2. A MySQL config file (my.cnf) to be used for the Staging DB instance must be available under Delphix Toolkit Directory.
95+
3. Empty folder on host to hold delphix toolkit [ approximate 2GB free space ]
96+
4. Empty folder on host to mount nfs filesystem. This is just and empty folder with no space requirements and act as base folder for nfs mounts.
8697
8798
8899
### <a id="upload-plugin"></a>Steps to build, upload and run unit tests for plugin

0 commit comments

Comments
 (0)