Salesforce

On-Premises Installation Health Check Script

« Go Back
Information
On-Premises Installation Health Check Script
UUID-bfafe868-2dd4-efc5-ec05-61b85e3f2a8c
Article Content

On-Premises Installation Guide PDF

The Health Check script is used to validate the resources currently set up on a customer's environment, compare configurations, and then send out a report against OneTrust's minimum requirements needed to install/run the OneTrust product.

Important

As of January 25, 2023, customers can no longer perform new deployments of on-premises instances. Deployments before this date are still supported and will be upgraded as necessary until this solution reaches end of life.

For more information on available stacks and hosting options, see Supported Stacks for On-Premises and About OneTrust Hosting Options, Locations, and Backup.

To run the health check script

  1. Navigate to the folder path where OneTrust package is downloaded.

  2. Navigate to ....admin-portal\k8s-deployment\health_inventory

  3. Open and edit .envs file for the below details:

    # Docker configuration 
    export OT_DOCKER_REGISTRY="docker.onetrust.io"
    export DOCKER_USER="docker-read"
    # Enter sql_database_hostname to check the database connectivity
    export SQL_DATABASE_HOSTNAME="" 
    # Enter sql_database username
    export SQL_DB_USER=""   
    # Enter sql_database password
    export SQL_DB_PASSWORD="" 
    # Enter the sql port (Example:- 1433)
    export SQL_DB_PORT=""
    # Toggle this to true if AWS EFS is deployed
    export AWS_EFS="false"
    # Enter the aws efs dns
    export OT_AWS_EFS_DNS=""
    # Enter the efs port (Example:- 2049)
    export EFS_PORT=""
    # Enter SMTP hostname
    export SMTP_HOSTNAME=""
    # Enter the SMTP port (Example:- 1025)
    export SMTP_PORT=
  4. Optional: If separate MongoDB cluster:

    # Enter mongo_database_hostname to check the database connectivity
    export MONGO_DB_HOSTNAME=""
    # Enter mongo_database user
    export MONGO_DB_USER=""
    # Enter mongo_database password
    export MONGO_DB_PASSWORD=""
    # Enter the mongo authentication database
    export MONGO_AUTH_DB=""
    # Enter the mongo port (Example:- 27017 or 27019)
    export MONGO_DB_PORT=""
    # Toggle this to true
    OPENSHIFT_CLUSTER="true"
  5. Navigate to the command line terminal (WSL or bash) where we will execute the shell scripts ...\admin-portal\k8s-deployment.

  6. Execute health script by entering ./health_script.sh install

 
Article Visibility
1,806
Translation
English
Checked

Powered by