This documentation site is no longer maintained. For the latest Delphix product documentation, please visit help.delphix.com
Hyperscale Compliance

Installation and setup (Mongo profiler)

Pre-requisites

  1. Download the latest version of the MongoDB profiler from the Delphix download page.

  2. Ensure that the host running the profiler has podman installed.

  3. Set up the Hyperscale MongoDB Connector and add the required ConnectorInfo details.

Procedure

  1. Untar the profiler downloaded from Delphix’s download page. It should contain the container images for the profiler and the podman-compose.yaml file to run the profiler.

    tar xzvf mongo-profiler.tar.gz
    
  2. Create db_connection_conf.yaml using the template and populate the desired information.

    cp db_connection_conf.yaml.template db_connection_conf.yaml
    
    cat db_connection_conf.yaml
    #
    # Copyright (c) 2023 by Delphix. All rights reserved.
    #
    source_mongodb_uri: "mongodb://example.com:27017/?authMechanism=admin"
    source_database: "test_db"
    source_collection: "test_collection"
    source_username: "test_user"
    target_database: "target_db"
    target_collection: "target_collection"
    
  3. Check the help of profiler.sh.

    ./profiler.sh
    Usage: ./profiler.sh [OPTIONS]
    
      Create masking inventory file.
    
    Options:
      -o OPERATION          Operations
                              masking-inventory   Generate masking inventory JSON file.
                              data-sets           Execute API /data-sets using the
                                                    generated masking inventory file.
    
      -c DB_CONN_CONF       Path of db_connection_conf.yaml
    
      [-u UNLOAD_SPLIT]     Refer Hyperscale docs for more details.
                            Required for "data-sets" operation only.
    
      [-e HSENGINE]         Hostname or IP of HyperScale Engine
      [-k KEY]              API Key for Controller
      [-d CONNECTOR-ID]     Connector ID
      [-help]               Show this message and exit.
    
    
      Examples,
    
      #./profiler.sh -o masking-inventory -c DB_CONN_CONF.yaml
    
      #./profiler.sh -o data-sets -c DB_CONN_CONF.yaml -e HSENGINE.com -k APIKEY -d ID -u UNLOAD_SPLIT