Chat now with support
Chat with Support

SharePlex 12.2 - Installation and Setup guide

About this Guide Conventions used in this guide Installing and Setting up SharePlex on Oracle Source Database
SharePlex Pre-installation Checklist for Oracle Download the SharePlex installer Install SharePlex on Linux and UNIX Set up an Oracle environment for replication Set up replication from Oracle to a different target type Set up Replication from Oracle to Cloud storage Installation and Setup for Cloud-Hosted Databases for Oracle Installation and setup for remote capture Installation and setup for HA cluster Generic SharePlex demonstration for Oracle Advanced SharePlex demonstrations for Oracle Database Setup Utilities Solve Installation Problems for Oracle
Installing and Setting up SharePlex on a PostgreSQL Database as Source and Service
SharePlex Pre-installation Checklist for PostgreSQL Download the SharePlex installer for PostgreSQL Install SharePlex on Linux for PostgreSQL as a Source Set up Replication from PostgreSQL to Supported Target Types Installation and Setup for Cloud-Hosted Databases for PostgreSQL Installation and Setup for Remote Capture for PostgreSQL Install SharePlex on PostgreSQL High Availability Cluster Configure SharePlex on PostgreSQL Azure Flexible Server with High Availability Using Logical Replication Install SharePlex on PostgreSQL High Availability Cluster Generic SharePlex Demonstration for PostgreSQL Advanced SharePlex Demonstrations for PostgreSQL Database Setup for PostgreSQL Database Setup for PGDB as a Service Installation of pg_hint_plan extension Solve Installation Problems for PostgreSQL
Installing SharePlex on a Docker container Assign SharePlex users to security groups Solve Installation Problems Uninstall SharePlex Advanced installer options Install SharePlex as root SharePlex installed items

Solve database connection problems for PostgreSQL

Did you verify the credentials?

If SharePlex cannot connect to a source or target database, you can view the login credentials that are being used for that database by using the connection command with the show option. For example:

sp_ctrl> connection r.mydb show

You can also view connection settings in the connections.yaml file, which is stored in the data sub-directory of the SharePlex variable-data directory. If there are no settings in this file, it means that the SharePlex database setup procedure was not performed on this database.

To view the correct database setup procedure for the database, see SharePlex Reference GuideSharePlex Utilities

You can use the connection command to update connection properties. For more information, see the SharePlex Reference Guide.

Did you assign a DBA role to the SharePlex PostgreSQL user?

The SharePlex PostgreSQL user requires a DBA role with unlimited privileges. The SharePlex user is created with the default PostgreSQL profile under the assumption that the profile has the unlimited resource privileges assigned by PostgreSQL as the default. If SharePlex is unable to interact with PostgreSQL, check to see if the default was changed. If so, assign SharePlex a DBA role with unlimited privileges for all definitions.

Installing SharePlex on a Docker container

You can install SharePlex on a Docker container manually or through a Dockerfile.

To install SharePlex on a Docker container through a Dockerfile, follow these steps:

  1. Create a docker build file in the following format (This is a sample Docker file format created for the Linux platform):

# -------- Pull RHEL UBI ------------------------

ARG UBI_MINIMAL_VERSION="latest"

FROM --platform=linux/amd64 registry.access.redhat.com/ubi8/ubi:${UBI_MINIMAL_VERSION}

LABEL maintainer="<maintainer email address>"

# -------- Set Environment ------------------------

ENV HOME_DIR=/home/splex \

BASE_DIR=/u01/splex \

SP_SYS_PRODDIR=/u01/splex/prod \

SP_SYS_VARDIR=/u01/splex/var \

SP_COP_TPORT=2100 \

PATH=$SP_SYS_PRODDIR/bin:$PATH \

ODBCINI=$SP_SYS_VARDIR/odbc/odbc.ini \

ODBCSYSINI=$SP_SYS_VARDIR/odbc

# -------- Set ROOT Password ------------------------

RUN echo "root:****" | chpasswd

# -------- Install CPIO, PostgresSQL ODBC ------------------------

RUN yum -y install cpio hostname util-linux-user procps --nogpgcheck

RUN yum install -y --nogpgcheck openssh-server openssh-clients

RUN /usr/bin/ssh-keygen -A

RUN /usr/sbin/sshd

RUN yum install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm

RUN yum install -y postgresql14-odbc --nogpgcheck

RUN yum install -y https://yum.oracle.com/repo/OracleLinux/OL8/appstream/x86_64/getPackage/ksh-20120801-257.0.1.el8.x86_64.rpm --nogpgcheck

RUN yum install -y unixODBC-devel.x86_64 unixODBC.x86_64 postgresql15-odbc.x86_64 --nogpgcheck

RUN cd /usr/lib64;ln -s /usr/pgsql-15/lib/psqlodbcw.so psqlodbcw.so

RUN cd /usr/lib;ln -s /usr/pgsql-15/lib/psqlodbcw.so psqlodbcw.so

# -------- Add Group and User ------------------------

RUN groupadd -g 54321 spadmin

RUN useradd -g spadmin -md /home/splex splex

RUN echo "splex:*****" | chpasswd

# RUN chown splex:spadmin ${BASE_DIR}

# -------- Copy SharePlex Binaries, Reponse file, Installtion script ------------------------

COPY --chown=splex:spadmin --chmod=777 SharePlex.tpm ${BASE_DIR}/

COPY --chown=splex:spadmin --chmod=777 product.rsp ${BASE_DIR}/

COPY --chown=splex:spadmin --chmod=777 installsplex.sh ${BASE_DIR}/

# -------- Change User and Install SharePlex ------------------------

USER splex

# CMD [ "/u01/splex/SharePlex-11.0.0-b1-c048c979-ONEOFF-SPO-24709-rhel-amd64-m64.tpm -r /u01/splex/product.rsp" ]

RUN /u01/splex/installsplex.sh

RUN rm ${BASE_DIR}/installsplex.sh ${BASE_DIR}/product.rsp ${BASE_DIR}/SharePlex.tpm

EXPOSE 22

VOLUME [ "${BASE_DIR}" ]

  1. Create a SharePlex install script file similar to the below sample file: (This is a sample SharePlex install script file format created for the Linux platform)

    #!/bin/bashset -e

    echo 'export SP_HOME=/u01/splex

    export SP_SYS_HOST_NAME=$(hostname)

    export SP_SYS_PRODDIR=${SP_HOME}/prod

    export SP_SYS_VARDIR=${SP_HOME}/var

    export SP_SYS_BINDIR=${SP_SYS_PRODDIR}/bin

    export SP_COP_TPORT=4545

    export SP_COP_UPORT=4545

    export PATH=${SP_SYS_BINDIR}:${PATH}

    alias spbin="cd ${SP_SYS_BINDIR}/"

    alias spvar="cd ${SP_SYS_VARDIR}/"

    alias splog="cd ${SP_SYS_VARDIR}/log"

    alias spc="${SP_SYS_BINDIR}/sp_ctrl"

    alias gocop="${SP_SYS_BINDIR}/sp_cop -u${SP_COP_TPORT} &"

    export ODBCINI=${SP_SYS_VARDIR}/odbc/odbc.ini

    export ODBCSYSINI=${SP_SYS_VARDIR}/odbc

    ' >> /home/splex/.bashrc

    /u01/splex/SharePlex.tpm -r /u01/splex/product.rsp

  2. Create SharePlex silent install file (Examples: product.rsp) used for silent ora_setup. Not applicable for PostgreSQL. For additional information, see Run database setup for Oracle in silent mode section.

  3. Install Docker (Example: Docker desktop).

  4. Choose a base image.

  5. Install necessary packages (Example: PostgreSQL ODBC driver / Oracle Instant Client).

  6. Add custom files to the project directory (SharePlex files).

  7. Specify the user that will run your container (Example: splex:spadmin).

  8. Specify the exposed ports (Example: 2100).

  9. Define the entry point (Example: bash).

  10. Define a configuration method (Example: environment variables / scripts).

  11. Externalize your data (define an external volume for persistent data).

Build and run SharePlex container

  1. Create the following files and and copy them to the project directory (Example: splex_to_container) :

    • dockerfile (Docker build file)

    • installsplex.sh (SharePlex install script)

    • product.rsp (SharePlex silent install file)

    • SharePlex.tpm (SharePlex TPM installer)

  1. From within this directory, run the following commands:

    1. docker build -t shareplex:11

      This command will build the SharePlex image with the name "shareplex" and tag "11".

    2. docker run -itd --privileged -d --memory-reservation=100m --expose 22 --ulimit nofile=2000:2000 -p 4545:4545 -p 80:22 --name shareplex -it shareplex:11.4

      This command will start the container from the image "shareplex:11" named "shareplex."

    3. docker exec -it shareplex bash

      This command will start an interactive terminal session into the running SharePlex container. You can now run a database setup utility.

Assign SharePlex users to security groups

Contents

 

Overview

The SharePlex security groups provide access control to the SharePlex command and control system. Without proper configuration of these groups, anyone with permissions on the system can use the commands that view, configure, and control data replication.

Overview of SharePlex security groups

About the SharePlex Security Groups

To monitor, control, or change SharePlex replication, a person must be assigned to one of the SharePlex security groups on the systems where he or she will be issuing commands. Each group corresponds to an authorization level, which determines which SharePlex commands a person can issue. To execute a command, a user must have that command’s authorization level or higher. Use the authlevel command to determine your authorization level for issuing SharePlex commands on a system.

Description of the SharePlex security groups

Refer to the following table to determine the group and authorization level that you want to grant each SharePlex user.

User Authorization Levels and Roles
Auth level User type User group User roles
1 Administration spadmin*

You need at least one user with Administrator rights on each source and target system.

Can issue all SharePlex commands. Commands that can only be issued by a SharePlex Administrator are:

  • startup, shutdown
  • all configuration commands relating to an active configuration
  • all parameter commands except list param
  • start capture
  • stop capture
  • abort capture
  • truncate log

The SharePlex Administrator user must be in the Oracle dba group. For Oracle RAC and ASM 11gR2 and above, the user must also be in the Oracle Inventory group. For example: $ useradd –g spadmin –G dba,oinstall. The membership in Oracle Inventory group must be listed explicitly in the etc/group file.

On Unix and Linux, unless you install SharePlex as a root user, the SharePlex Administrator user and the SharePlex admin group must exist prior to installation.

2 Operator spopr Can issue all SharePlex commands except those listed above.
3 Viewer spview Can view lists, status screens, and logs to monitor replication only.

Note: The default name for the SharePlex administrator group is spadmin, but you can designate any group or specify any name for that group during installation.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating