3.3. Deploying an Extractor for Amazon Aurora

3.3. Deploying an Extractor for Amazon Aurora
Prev	^Up	Chapter 3. Deploying MySQL Extractors	Next

3.3. Deploying an Extractor for Amazon Aurora

3.3.1. Changing Amazon RDS/Aurora Instance Configurations

Replicating from Amazon Aurora, operates by directly accessing the binary log provided by Aurora and enables you to take advantage of the Amazon Web, either replicating from the remote Aurora instance, or to a standard EC2 instance within AWS. The complexity with Aurora is that there is no access to the host that is running the instance, or the MySQL binary logs.

To use this service, two aspects of the Tungsten Replicator are required, direct mode and unprivileged user support. Direct mode reads the MySQL binary log over the network, rather than accessing the binlog on the filesystem. The unprivileged mode enables the user to access and update information within Aurora without requiring SUPER privileges, which are unavailable within an Aurora instance. For more information, see Section B.4.6, “MySQL Unprivileged Users”.

The deployment requires a host for the extractor installation, this can be an EC2 instance within your AWS environment, or it could be a remote host in your own environment.

This deployment follows a similar model to an Offboard Installation

Figure 3.2. Topologies: Aurora Extraction

Before starting the installation, the prerequisites must have been completed (see Appendix B, Prerequisites) on both the Host designated for the installation of the extractor, and within the source database instance.

There are two types of installation, either via a Staging Install, or via an ini file install.

To understand the differences between these two installation methods, see Section 9.1, “Comparing Staging and INI tpm Methods”

Regardless of which installation method you choose, the steps are the same, and are outlined below.

Install the Tungsten Replicator package (see Section 2.1.2, “Using the RPM package files”), or download the compressed tarball and unpack it, either on the source host, or on the staging host:
copy
```
shell> cd /opt/continuent/software
shell> tar zxf tungsten-replicator-7.1.4-10.tar.gz
```
Change to the Tungsten Replicator staging directory:
copy
```
shell> cd tungsten-replicator-7.1.4-10
```
Configure the replicator for extraction (In this example, the service name is alpha)
Click the link below to switch examples between Staging and INI methods
Show Staging
Show INI
copy
```
shell> ./tools/tpm configure defaults \
    --reset \
    --install-directory=/opt/continuent \
    --user=tungsten \
    --profile-script=~/.bash_profile \
    --mysql-allow-intensive-checks=true \
    --skip-validation-check=InstallerMasterSlaveCheck \
    --skip-validation-check=MySQLPermissionsCheck \
    --skip-validation-check=MySQLBinaryLogsEnabledCheck \
    --skip-validation-check=MySQLMyISAMCheck \
    --skip-validation-check=RowBasedBinaryLoggingCheck \
    --rest-api-admin-user=apiuser \
    --rest-api-admin-pass=secret

shell> ./tools/tpm configure alpha \
    --master=localhost \
    --members=localhost \
    --enable-heterogeneous-service=true \
    --privileged-master=false \
    --replication-host=rds.endpoint.url \
    --replication-port=3306 \
    --replication-user=tungsten_alpha \
    --replication-password=secret \
    --datasource-mysql-conf=/dev/null \
    --svc-extractor-filters=dropcatalogdata \
    --property=replicator.service.comments=true
```
copy
```
shell> vi /etc/tungsten/tungsten.ini
```
copy
```
[defaults]
install-directory=/opt/continuent
user=tungsten
profile-script=~/.bash_profile
mysql-allow-intensive-checks=true
skip-validation-check=InstallerMasterSlaveCheck
skip-validation-check=MySQLPermissionsCheck
skip-validation-check=MySQLBinaryLogsEnabledCheck
skip-validation-check=MySQLMyISAMCheck
skip-validation-check=RowBasedBinaryLoggingCheck
rest-api-admin-user=apiuser
rest-api-admin-pass=secret

[alpha]
master=localhost
members=localhost
enable-heterogeneous-service=true
privileged-master=false
replication-host=rds.endpoint.url
replication-port=3306
replication-user=tungsten_alpha
replication-password=secret
datasource-mysql-conf=/dev/null
svc-extractor-filters=dropcatalogdata
property=replicator.service.comments=true
```
Configuration group defaults
The description of each of the options is shown below; click the icon to hide this detail:
Click the icon to show a detailed description of each argument.
- --reset
  reset
  For staging configurations, deletes all pre-existing configuration information between updating with the new configuration values.
- --install-directory=/opt/continuent
  install-directory=/opt/continuent
  Path to the directory where the active deployment will be installed. The configured directory will contain the software, THL and relay log information unless configured otherwise.
- --user=tungsten
  user=tungsten
  System User
- --profile-script=~/.bash_profile
  profile-script=~/.bash_profile
  Append commands to include env.sh in this profile script
- --mysql-allow-intensive-checks=true
  mysql-allow-intensive-checks=true
  For MySQL installation, enables detailed checks on the supported data types within the MySQL database to confirm compatibility. This includes checking each table definition individually for any unsupported data types.
- --skip-validation-check=InstallerMasterSlaveCheck
  skip-validation-check=InstallerMasterSlaveCheck
  The --skip-validation-check disables a given validation check. If any validation check fails, the installation, validation or configuration will automatically stop.
  Warning
  Using this option enables you to bypass the specified check, although skipping a check may lead to an invalid or non-working configuration.
  You can identify a given check if an error or warning has been raised during configuration. For example, the default table type check:
```
...
ERROR >> centos >> The datasource root@centos:3306 (WITH PASSWORD) » 
 uses MyISAM as the default storage engine (MySQLDefaultTableTypeCheck)
...
```
  The check in this case is MySQLDefaultTableTypeCheck, and could be ignored using --skip-validation-check=MySQLDefaultTableTypeCheck.
  Setting both --skip-validation-check and --enable-validation-check is equivalent to explicitly disabling the specified check.
- --skip-validation-check=MySQLPermissionsCheck
  skip-validation-check=MySQLPermissionsCheck
  The --skip-validation-check disables a given validation check. If any validation check fails, the installation, validation or configuration will automatically stop.
  Warning
  Using this option enables you to bypass the specified check, although skipping a check may lead to an invalid or non-working configuration.
  You can identify a given check if an error or warning has been raised during configuration. For example, the default table type check:
```
...
ERROR >> centos >> The datasource root@centos:3306 (WITH PASSWORD) » 
 uses MyISAM as the default storage engine (MySQLDefaultTableTypeCheck)
...
```
  The check in this case is MySQLDefaultTableTypeCheck, and could be ignored using --skip-validation-check=MySQLDefaultTableTypeCheck.
  Setting both --skip-validation-check and --enable-validation-check is equivalent to explicitly disabling the specified check.
- --skip-validation-check=MySQLBinaryLogsEnabledCheck
  skip-validation-check=MySQLBinaryLogsEnabledCheck
  The --skip-validation-check disables a given validation check. If any validation check fails, the installation, validation or configuration will automatically stop.
  Warning
  Using this option enables you to bypass the specified check, although skipping a check may lead to an invalid or non-working configuration.
  You can identify a given check if an error or warning has been raised during configuration. For example, the default table type check:
```
...
ERROR >> centos >> The datasource root@centos:3306 (WITH PASSWORD) » 
 uses MyISAM as the default storage engine (MySQLDefaultTableTypeCheck)
...
```
  The check in this case is MySQLDefaultTableTypeCheck, and could be ignored using --skip-validation-check=MySQLDefaultTableTypeCheck.
  Setting both --skip-validation-check and --enable-validation-check is equivalent to explicitly disabling the specified check.
- --skip-validation-check=MySQLMyISAMCheck
  skip-validation-check=MySQLMyISAMCheck
  The --skip-validation-check disables a given validation check. If any validation check fails, the installation, validation or configuration will automatically stop.
  Warning
  Using this option enables you to bypass the specified check, although skipping a check may lead to an invalid or non-working configuration.
  You can identify a given check if an error or warning has been raised during configuration. For example, the default table type check:
```
...
ERROR >> centos >> The datasource root@centos:3306 (WITH PASSWORD) » 
 uses MyISAM as the default storage engine (MySQLDefaultTableTypeCheck)
...
```
  The check in this case is MySQLDefaultTableTypeCheck, and could be ignored using --skip-validation-check=MySQLDefaultTableTypeCheck.
  Setting both --skip-validation-check and --enable-validation-check is equivalent to explicitly disabling the specified check.
- --skip-validation-check=RowBasedBinaryLoggingCheck
  skip-validation-check=RowBasedBinaryLoggingCheck
  The --skip-validation-check disables a given validation check. If any validation check fails, the installation, validation or configuration will automatically stop.
  Warning
  Using this option enables you to bypass the specified check, although skipping a check may lead to an invalid or non-working configuration.
  You can identify a given check if an error or warning has been raised during configuration. For example, the default table type check:
```
...
ERROR >> centos >> The datasource root@centos:3306 (WITH PASSWORD) » 
 uses MyISAM as the default storage engine (MySQLDefaultTableTypeCheck)
...
```
  The check in this case is MySQLDefaultTableTypeCheck, and could be ignored using --skip-validation-check=MySQLDefaultTableTypeCheck.
  Setting both --skip-validation-check and --enable-validation-check is equivalent to explicitly disabling the specified check.
- --rest-api-admin-user=apiuser
  rest-api-admin-user=apiuser
  Optional: Must be specified along with rest-api-admin-pass if you wish to access the full API features and use the Dashboard GUI for cluster installations.
- --rest-api-admin-pass=secret
  rest-api-admin-pass=secret
  Optional: Must be specified along with rest-api-admin-user if you wish to access the full API features.
Configuration group alpha
The description of each of the options is shown below; click the icon to hide this detail:
Click the icon to show a detailed description of each argument.
- --master=localhost
  master=localhost
  The hostname of the primary (extractor) within the current service.
- --members=localhost
  members=localhost
  Hostnames for the dataservice members
- --enable-heterogeneous-service=true
  enable-heterogeneous-service=true
  - On a Primary
    --mysql-use-bytes-for-string is set to false.
    colnames filter is enabled (in the binlog-to-q stage to add column names to the THL information.
    pkey filter is enabled (in the binlog-to-q and q-to-dbms stage), with the addPkeyToInserts and addColumnsToDeletes filter options set to false.
    enumtostring filter is enabled (in the q-to-thl stage), to translate ENUM values to their string equivalents.
    settostring filter is enabled (in the q-to-thl stage), to translate SET values to their string equivalents.
  - On a Replica
    --mysql-use-bytes-for-string is set to true.
    pkey filter is enabled (q-to-dbms stage).
- --privileged-master=false
  privileged-master=false
  Does the login for the Primary database service have superuser privileges
- --replication-host=rds.endpoint.url
  replication-host=rds.endpoint.url
  Hostname of the datasource where the database is located. If the specified hostname matches the current host or member name, the database is assumed to be local. If the hostnames do not match, extraction is assumed to be via remote access. For MySQL hosts, this configures a remote replication Replica (relay) connection.
- --replication-port=3306
  replication-port=3306
  The network port used to connect to the database server. The default port used depends on the database being configured.
- --replication-user=tungsten_alpha
  replication-user=tungsten_alpha
  For databases that required authentication, the username to use when connecting to the database using the corresponding connection method (native, JDBC, etc.).
- --replication-password=secret
  replication-password=secret
  The password to be used when connecting to the database using the corresponding --replication-user.
- --datasource-mysql-conf=/dev/null
  datasource-mysql-conf=/dev/null
  MySQL config file
- --svc-extractor-filters=dropcatalogdata
  svc-extractor-filters=dropcatalogdata
  Replication service extractor filters
- --property=replicator.service.comments=true
  property=replicator.service.comments=true
  The --property option enables you to explicitly set property values in the target files. A number of different models are supported:
  - key=value
    Set the property defined by key to the specified value without evaluating any template values or other rules.
  - key+=value
    Add the value to the property defined by key. Template values and other options append their settings to the end of the specified property.
  - key~=/match/replace/
    Evaluate any template values and other settings, and then perform the specified Ruby regex operation to the property defined by key. For example --property=replicator.key~=/(.*)/somevalue,\1/ will prepend somevalue before the template value for replicator.key.
Once the prerequisites and configuring of the installation has been completed, the software can be installed:
copy
```
shell> ./tools/tpm install
```

In the above examples,

enable-heterogenous-service, is only required if the target applier is NOT a MySQL database
datasource-mysql-conf, needs to be set as shown as we do not have access to the my.cnf file

If the installation process fails, check the output of the /tmp/tungsten-configure.log file for more information about the root cause.

Once the installation has been completed, you can now proceed to configure the Applier service following the relevant step within Chapter 4, Deploying Appliers.

Following installation of the applier, the services can be started. For information on starting and stopping Tungsten Cluster see Section 2.4, “Starting and Stopping Tungsten Replicator”; configuring init scripts to startup and shutdown when the system boots and shuts down, see Section 2.5, “Configuring Startup on Boot”.

Monitoring the extractor is the same as an extractor from MySQL, for information, see Section 3.2.1, “Monitoring the MySQL Extractor”.

cd /opt/continuent/software
tar zxf tungsten-replicator-7.1.4-10.tar.gz
cd tungsten-replicator-7.1.4-10
./tools/tpm configure defaults \
    --reset \
    --install-directory=/opt/continuent \
    --user=tungsten \
    --profile-script=~/.bash_profile \
    --mysql-allow-intensive-checks=true \
    --skip-validation-check=InstallerMasterSlaveCheck \
    --skip-validation-check=MySQLPermissionsCheck \
    --skip-validation-check=MySQLBinaryLogsEnabledCheck \
    --skip-validation-check=MySQLMyISAMCheck \
    --skip-validation-check=RowBasedBinaryLoggingCheck \
    --rest-api-admin-user=apiuser \
    --rest-api-admin-pass=secret

./tools/tpm configure alpha \
    --master=localhost \
    --members=localhost \
    --enable-heterogeneous-service=true \
    --privileged-master=false \
    --replication-host=rds.endpoint.url \
    --replication-port=3306 \
    --replication-user=tungsten_alpha \
    --replication-password=secret \
    --datasource-mysql-conf=/dev/null \
    --svc-extractor-filters=dropcatalogdata \
    --property=replicator.service.comments=true
vi /etc/tungsten/tungsten.ini
[defaults]
install-directory=/opt/continuent
user=tungsten
profile-script=~/.bash_profile
mysql-allow-intensive-checks=true
skip-validation-check=InstallerMasterSlaveCheck
skip-validation-check=MySQLPermissionsCheck
skip-validation-check=MySQLBinaryLogsEnabledCheck
skip-validation-check=MySQLMyISAMCheck
skip-validation-check=RowBasedBinaryLoggingCheck
rest-api-admin-user=apiuser
rest-api-admin-pass=secret

[alpha]
master=localhost
members=localhost
enable-heterogeneous-service=true
privileged-master=false
replication-host=rds.endpoint.url
replication-port=3306
replication-user=tungsten_alpha
replication-password=secret
datasource-mysql-conf=/dev/null
svc-extractor-filters=dropcatalogdata
property=replicator.service.comments=true
./tools/tpm install

Show Copy-friendly Text

Prev	Up	Next
3.2.1. Monitoring the MySQL Extractor	^Level	3.3.1. Changing Amazon RDS/Aurora Instance Configurations

Continuent Documentation

3.3. Deploying an Extractor for Amazon Aurora

Warning

Warning

Warning

Warning

Warning