Command Line Installation
Also available as:
loading table of contents...

Installing the Tag Synchronization Module

To install the tag synchronization module:

  1. Log in to the host machine as super-user (root).

  2. Locate and download the ranger-tagsync package, then install it by executing yum install ranger-tagsync.

    Installing the ranger-tagsync package will unpack and create a directory (ranger-tagsync-install-directory) and needed sub-directories and files in the ranger-tagsync directory under the Apache installation root directory.

  3. Make the ranger-tagsync-install-directory your current working directory.

    cd ranger-tagsync-install-directory

  4. Set up the JAVA_HOME environment variable to point to Java distribution on the installation machine.

    export JAVA_HOME=location-of-java-home-on-the-installation-machine

  5. Edit the file in the ranger-tagsync-install-directory to reflect the operational environment.

    Table 13.10. File Properties

    TAGADMIN_ENDPOINTURL of the destination of the tagsCustomize the value to reflect your deployment
    TAGADMIN_SSL_CONFIG_FILENAMEFile containing SSL configurationCustomize the value to point to SSL configuration specific to your deployment. The value will be ignored in the scheme in TAGADMIN_ENDPOINT URL is "http".
    TAGSYNC_KEYSTORE_FILENAMEFile to store encrypted password for Ranger Admin user ‘rangertagsync’ that is used for communicating with TagAdminCustomize the value to suit your deployment. If there is no value specified then the password will not be encrypted.
    TAG_SOURCESource of the tagging informationAt this time, the only supported value is ‘Atlas’.
    TAGSYNC_ATLAS_KAFKA_ENDPOINTSURL of the Kafka endpoint to which Atlas sends its notificationsCustomize the value to reflect your deployment.
    TAGSYNC_ATLAS_ZOOKEEPER_ENDPOINTURL of the ZooKeeper endpoint needed for AtlasCustomize the value to reflect your deployment.
    TAGSYNC_ATLAS_CONSUMER_GROUPString representing Kafka Consumer Group ID used by Tag-SyncCustomize the value to reflect your deployment.
    TAGSYNC_ATLAS_TO_RANGER_SERVICE_MAPPINGMapping between Atlas cluster-name, component-type, and Ranger service-name

    This mapping is provided as a string value in the following format.


    Customize the value to reflect your deployment.

    unix_userranger-tagsync process is run as this Unix user.There is no need to change this value (default is ‘ranger’).
    unix_groupranger-tagsync process is run with this Unix group-id.There is no need to change this value (default is ‘ranger’).
    logdirDirectory where logs are storeCustomize the value to suit your deployment.

  6. Run the setup script to create the run-time directory structure.


    The run-time directory structure copies scripts into appropriate directories, creates files required for Atlas integration, creates configuration files which are used by the ranger-tagsync process to configure itself, and sets up symbolic links wherever necessary.

    Table 13.11. Run-time Directory Structure

    DirectoryFileLinked to
    /etc/ranger/tagsync/confapplication.propertiesProperties required for Atlas interface
    /etc/ranger/tagsync/confjava_home.shShell command to set JAVA_HOME environment variable
    /etc/ranger/tagsync/conflog4j.xmlLog4j configuration properties
    /etc/ranger/tagsync/confranger-tagsync-site.xmlRanger-tagsync process configuration properties
    /etc/ranger/tagsync/confrangertagsync.jceksEncrypted password for Ranger Admin user ‘rangertagsync’
    /etc/init.dranger-tagsyncShell script to start/stop/query ranger-tagsync service
    /var/log/ranger/tagsyncranger-tagsync-install-directory/logDirectory where logs (ranger-tagsync.log*) generated by ranger-tagsync are stored.
    /var/run/rangertagsync.pidFile containing process-id of the ranger-tagsync process, if it is running