Step 3. Install DataClarity

Before you install

• Ensure that you prepare a clean environment (VM) with no other 3rd party software installed.

• Ensure the system requirements for platform installation are met. For details, see System requirements.

  You can use a standalone script to verify the minimum “Proof of Concept” requirements for the environment. The script checks the minimum CPUs, RAM, free disk space, whether the needed ports are open, and that the required external repositories are accessible. The script must be run as root (superuser).

  Copy

  check.sh

  curl -O https://raw.githubusercontent.com/DataClarityCorp/distribution/main/system_check.sh

• Obtain the distribution file, <distribution>.tar.gz, provided by DataClarity.

• Obtain the license script provided by DataClarity.

• Prepare the domain name (hostname) or IP address to be used for the DataClarity platform.

• SSL: If you want to use the certificate for your domain, prepare the certificate and the key files (.crt, .key).

• We recommend that you update OpenSSL. Otherwise, you may get an error when running the install script. However, it does not impact the installation.

• Check firewall rules to ensure that ports 80, 443, and 5432 are open.

  Depending on your Linux distribution, choose the appropriate commands:

  Ubuntu

  Copy

  sudo ufw allow 80

  Copy

  sudo ufw allow 443

  Copy

  sudo ufw allow 5432

  Copy

  sudo iptables -P FORWARD ACCEPT

  Copy

  sudo apt-get install iptables-persistent

  Copy

  sudo ufw default allow routed

  Red Hat Enterprise Linux (RHEL)/CentOS

  Copy

  sudo firewall-cmd --zone=public --add-port=80/tcp --permanent

  Copy

  sudo firewall-cmd --zone=public --add-port=443/tcp --permanent

  Copy

  sudo firewall-cmd --zone=public --add-port=5432/tcp --permanent

  Copy

  sudo firewall-cmd --zone=public --add-masquerade --permanent

  Copy

  sudo firewall-cmd --reload

1. Download or copy over the distribution file provided by DataClarity, <distribution>.tar.gz, where “distribution” is the name of the specific distribution file, for example, dataclarity-2021.5-premium.tar.gz.

   You may use the following command to download the file by inserting the URL to the file, for example:

   Copy

   curl -LO https://github.com/DataClarityCorp/distribution/raw/main/k8s/free/dataclarity-free-latest.tar.gz

2. Unpack the tar file:

   Copy

   tar -zxf dataclarity-free-latest.tar.gz

   After unpacking, you get the distribution folder with install.sh, remove.sh, and template files.

2. The install script must have an executable mode enabled. Run the following command to make sure it is enabled:

   Copy

   chmod +x install.sh

3. From the distribution folder, execute the installation script:

   Copy

   ./install.sh

   1. Enter production to install the latest stable production version or beta to install the pre-release version. 
      Note: This option will appear in premium installation only.

   2. Enter the public entry point (IP, host, FQDN).

      Note: If you set an IP address, the installation script will skip the next step for adding an alias, as it will not be necessary.

   3. For Add host alias to resolve “[hostname]”, enter one of the following:

      • y — If you want to use your PC hostname that is not registered in public DNS (not bound to that PC on the global DNS server). This command will add the PC’s hostname and IP to the hosts file inside the docker containers.

        For IP address for “hostname”, type in the external IP by which you can reach the PC outside the machine.

      • n — To skip adding host alias.

   4. For Disable HTTPS, enter one of the following:

      • y — To disable SSL, making the client-server connection insecure.

      • n — To enable SSL.
        To use your own certificate for your domain, create the folder certs in /distribution/template, and then place the certificate file and the key file in that folder. Otherwise, the installer will automatically generate a self-signed certificate for your domain.

   5. (This step appears if you enabled SSL (selected n for Disable HTTPS)).

      For Disable built-in SSL termination, enter one of the following:

      • y — The platform will use an insecure connection to communicate internally. Use this option if you want to place a gateway (reverse proxy), which will handle SSL offloading, in front of the platform.
      • n — The platform will use a secure connection to communicate internally and externally.

   6. For Disable authentication for Kubernetes Dashboard, select one of the following:

      • y — To disable authentication for the Kubernetes Dashboard; it is not recommended if you are using a public entry point.

      • n — To use authentication for the Kubernetes Dashboard. You will need to use a token to log into the Kubernetes Dashboard.

        If you choose this option, the access token will be displayed at the end of the installation process

   7. To Proceed with the installation enter y.

       

What’s next?

Step 4. Provision users