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

Commit 4a19b16

Browse files
committed
Documentation final updtes
1 parent 5d548c0 commit 4a19b16

21 files changed

+313
-341
lines changed

docs/docs/Discovery.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,12 @@ Whenever there is any change (installing a new database home) to an already set
77
we need to perform an environment discovery/refresh.
88

99

10-
Prerequisites
11-
=============
10+
## Prerequisites
1211

1312
- Installation of the MySQL Plugin is required before the Discovery.
1413

14+
## Refreshing an Environment
1515

16-
Refreshing an Environment
17-
=========================
1816
Environment refresh will update the metadata associated with that environment and push Delphix Toolkit on to the host.
1917

2018
1. Login to the **Delphix Management** application.
@@ -29,8 +27,10 @@ Environment refresh will update the metadata associated with that environment an
2927
Once an environment refresh completes successfully, Delphix will discover all MySQL installations on the environment.
3028
These installations are referred to as "repositories"
3129

32-
Add Source Config
33-
===================
30+
31+
## Add Source Config
32+
33+
3434
As noted avove, environments contain `repositories`, that are MySQL installations in the environment.
3535
Each environment may have any number of repositories associated with it.
3636

@@ -42,27 +42,28 @@ For the MySQL plugin, Source config is must be created manually.
4242

4343
### How to create Source Config
4444

45+
*Source Config is created on the Staging Environment*
46+
4547
1. Login to the **Delphix Management** application.
4648
2. Click **Manage**.
4749
3. Select **Environments**.
4850
4. Select the repository.
4951
5. Click on **+** icon (Shown in next image).
50-
51-
![Screenshot](./image/image10.png)
52-
52+
![Screenshot](./image/image10.png)
5353

5454
6. Add required details in the `Add database` section.
55-
- Enter port number in **Source Couchbase port** section.
56-
- Enter source host address in section **Source Host**.
57-
- Enter unique name for the staging database in **identify field** section.
58-
- Enter Couchbase data path of staging host in **DB data path** section.
55+
56+
- Enter source data directory in section **Data Directory**.
57+
- Enter source port number in **Port** section.
58+
- Enter MySQL base directory on the source host in **Base Directory** section.
59+
- Enter dsource name in **MySQL dSource Name** section.
60+
5961

62+
![Screenshot](./image/image11.png)
6063

61-
![Screenshot](./image/image11.png)
6264

65+
## What's Next?
6366

64-
What's Next?
65-
===================
6667

6768
Now that your environments are all added and a Source Config has been created,
6869
please proceed to [Linking](/Linking/Replication_Mode/index.html) page to see how we can create the dSource.
Lines changed: 75 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,82 @@
11
# Manual Ingestion
22

3-
Given below are the pre-requisites for MySQL virtualization when using Manual Ingestion mode.
4-
5-
### Source Environment Requirements
6-
7-
Source environment is where the source MySQL databases are running.
8-
9-
#### Source DB User
10-
In Manual Ingestion mode, Delphix does not interact with the source database.
11-
Delphix creates a staging database and the backups are ingested manually by a customer user.
12-
13-
However, Delphix needs to be able to manage this staging database for snapshots and other time travel operations.
14-
Hence, we require a user with the following permissions on the staging database.
15-
16-
*SELECT, SHUTDOWN, SUPER, RELOAD ,SHOW VIEW, EVENT, TRIGGER*
17-
18-
There are 2 ways to achieve this
19-
20-
1. Create this user on your source database so that when the backup is restored, this user is present in the staging db.
21-
2. Create this user manually in the staging db.
22-
In this case, the customer user must ensure that this user is always present in the staging db
23-
and has the necessary privileges
24-
25-
```jql
26-
mysql> GRANT SELECT, SHUTDOWN, SUPER, RELOAD ,SHOW VIEW, EVENT, TRIGGER on *.* to 'user'@'staging-host';
27-
```
28-
You can also grant more permissive privileges
29-
30-
```jql
31-
mysql>GRANT ALL PRIVILEGES ON *.* TO 'user'@'%';
32-
```
33-
34-
!!! note
35-
Remember, this is the user that Delphix uses to manage the Staging database.
36-
So, if you're using Option#1 above, it is recommended that you create a dedicated source db user for Delphix with the privileges
37-
mentioned above.
38-
39-
### Staging Environment Requirements
40-
41-
#### Staging OS User
42-
- A Delphix OS user with the elevated permissions to run *ps, mount, umount, mkdir, rmdir*
43-
commands without requiring a password
44-
45-
<div class="code_box_outer">
46-
<div class="code_box_title">
47-
<span class="code_title">*/etc/sudoers*</span>
48-
</div>
49-
<div>
50-
```groovy hl_lines="6"
51-
Defaults:delphix_os !requiretty
52-
delphix_os ALL=NOPASSWD: \
53-
/bin/mount, /bin/umount, /bin/mkdir, /bin/rmdir, /bin/ps
54-
```
55-
</div>
56-
</div>
57-
58-
- Delphix OS user should be in the same primary and secondary groups as mysql user ( or the MySQL binary owner )
59-
- Delphix OS user must have execute access on all files within MySQL installation folder - Min permission level 775 recommended.
60-
61-
#### Storage
62-
- Empty folder on staging host to hold delphix toolkit [ approximate 2GB free space ]
63-
64-
#### MySQL Version & Configuration
65-
- MySQL Binary version must match the version on the source database(s)
66-
67-
- Starter *my.cnf* file <span class="code_title">[Recommended] </span>
68-
69-
As every organization's MySQL configuration is different,
70-
Delphix expects a starter *my.cnf* file to be present in Delphix Toolkit Directory when creating a staging database.
71-
72-
Delphix will use this *my.cnf* file and modify it as per the configuration provided during the the dsource creation process.
73-
74-
This is recommended to reduce the possibility of errors while restoring the backup from the source database.
75-
76-
if tnis file is not provided, Delphix will create a *my.cnf* file from scratch.
77-
78-
### Target Environment Requirements
79-
80-
#### Target OS User
81-
- A Delphix OS user with the elevated permissions to run *ps, mount, umount, mkdir, rmdir*
82-
commands without requiring a password
83-
84-
<div class="code_box_outer">
85-
<div class="code_box_title">
86-
<span class="code_title">*/etc/sudoers*</span>
87-
</div>
88-
<div>
89-
```groovy hl_lines="6"
90-
Defaults:delphix_os !requiretty
91-
delphix_os ALL=NOPASSWD: \
92-
/bin/mount, /bin/umount, /bin/mkdir, /bin/rmdir, /bin/ps
93-
```
94-
</div>
95-
</div>
96-
97-
- Delphix OS user should be in the same primary and secondary groups as mysql user ( or the MySQL binary owner )
98-
- Delphix OS user must have execute access on all files within MySQL installation folder - Min permission level 775 recommended.
3+
In Manual Ingestion Mode, Delphix creates a seed (empty) staging database.
4+
Customer users will be responsible to manually ingest data into this staging db.
5+
All other management operations can be performed through Delphix. A snapshot can be taken either manually
6+
or via a SnapSync policy once the data is restored into the seed staging database.
997

8+
### Pre-Requisites
9+
10+
- Staging environment must be added to Delphix.
11+
- A Source Config must be created on the staging environment-MySQL repository.
12+
- <span class="code_title">[Recommended] </span>
13+
As every organization's MySQL configuration is different,
14+
Delphix expects a starter *my.cnf* file to be present in Delphix Toolkit Directory when creating a staging database.
15+
Delphix will use this *my.cnf* file and modify it as per the configuration provided during the the dsource creation process.
16+
17+
This is recommended to reduce the possibility of errors while restoring the backup from the source database.
18+
19+
!!! warning
20+
It may take upto 5 minutes after successful dSource creation for the status to show as Active.
21+
22+
23+
### Creating dSource
24+
25+
1. Login to **Delphix Management** application.
26+
2. Click **Manage** > **Datasets**.
27+
3. Select **Add dSource**.
28+
29+
![Screenshot](../../image/add-dsource.png)
30+
31+
32+
4. In the Add dSource wizard, select the MySQL source configuration which is created on the staging host.
33+
5. Select *Manual Ingestion* in the dSource Type dropdown.
34+
6. Provide the additional details required for dsource creation
35+
- Staging DB Server ID
36+
37+
Server ID for the dsource (stagind db. For Replication Mode,
38+
this server id must be greater than the source db server id.
39+
40+
- Staging DB Port
41+
42+
Port for the dsource (staging db).
43+
44+
- Staging Initialization Password
45+
46+
Password to use while initializing the dsource (staging db).
47+
This password will be assigned to the *'root'@'localhost'*
48+
49+
- MySQL Base Directory
50+
51+
MySQL installation directory. This is where the location of */bin/mysql*
52+
53+
- Mount Location on Staging Host
54+
55+
This is the mount directory for Delphix on the staging host.
56+
This location should be unique and empty.
57+
58+
- Source DB UserName
59+
60+
Delphix db user on the source database. In Manual Ingestion mode, Delphix does not connect to the source db.
61+
Delphix will be using this db user to manage the dsource and other time travel operations.
62+
This user must be part of the source db backup that will be restored into the staging db.
63+
64+
- Source DB Password
65+
66+
Password for the source db user.
67+
68+
8. On dSource Configuration screen, select the dataset group where the dSource will be placed and click *Next*.
69+
9. On the Data Management screen, select the staging environment and the environment user and click *Next*.
70+
10. On the Policies screen, select the Snapsync and Retention policies for the dSource and click *Next*.
71+
11. On the Hooks screen, add any pre-sync and (or) post-sync hooks as required and click *Next*.
72+
12. Review the dSource configuration on the Summary screen and Submit. The Linking process has commenced.
73+
74+
![Screenshot](../../image/dsource-creation.png)
75+
76+
77+
Once the dSource creation is successful, the <span class="code_title">*Timeflow*</span> tab should show the initial snapshot.
10078

10179
Done, What's Next?
10280
----------------
103-
Alright, we've taken care of all the pre-requisites. Next step - Install the plugin.
81+
Alright, we have created a MySQL dSource. Next step - Provision a VDB.
10482

0 commit comments

Comments
 (0)