Install TestGen on Mac/Linux¶

The dk-installer program installs DataOps Data Quality TestGen as a Docker Compose application. This is the recommended installation mode, as Docker encapsulates and isolates the application from other software on your machine and does not require you to manage Python dependencies.

Prerequisites¶

Install the following prerequisites, and verify that their versions are supported.

Software	Supported versions	Command to check version
Python 3 Most Linux and macOS systems have Python pre-installed. On Windows, you will need to download and install. Why Python? To run the installer.	3.9, 3.10, 3.11, 3.12, 3.13	`python3 --version`
Docker + Docker Compose Why Docker? Docker lets you try TestGen without affecting your local software environment. All the dependencies TestGen needs are isolated in its container, so installation is easy and insulated.	Docker: 26.1, 27.5, 28.5 Compose: 2.38, 2.39, 2.40	`docker -v` `docker compose version`

How to install TestGen¶

Create and navigate to a new install directory, e.g., "/testgen".

Download the latest version of dk-installer.

curl -o dk-installer.py 'https://raw.githubusercontent.com/DataKitchen/data-observability-installer/main/dk-installer.py'

Run the install command.
```
python3 dk-installer.py tg install
```
The installation downloads the latest Docker images for TestGen and deploys a new Docker Compose application. The process may take 5~10 minutes, depending on your machine and network connection.

For advanced options, see the Installation options section.
Verify that you can log in to the UI with the URL and credentials provided in the terminal output. You can also find this information at any time in the dk-tg-credentials.txt file.

How to set up demo data¶

You can also use the installer program to seed TestGen with demo data for the Quick Start tutorial.

Verify that the UI is accessible and the docker-compose.yaml file generated by the installation is present in the folder.
Run the demo setup command.
```
python3 dk-installer.py tg run-demo
```
In the TestGen UI, you will see that new data profiling and test results have been generated.
Follow the TestGen portions of the Quick Start demo tutorial for a walk-through of the software.

Tip

To upgrade an instance of TestGen to the latest released version, see Upgrade TestGen. For other post-install tasks, see Administer TestGen.

Installation options¶

--image: To install a specific version. The latest released version of TestGen is installed by default. For a list of recent releases, see TestGen Release Notes.
```
python3 dk-installer.py tg install --image=datakitchen/dataops-testgen:v<version>
```
--port: To specify a custom port. The TestGen application uses port 8501 by default.
```
python3 dk-installer.py tg install --port=<port>
```
--pull-timeout: To specify the maximum amount of time (in minutes) that Docker should be allowed to pull images. The installer uses a 5 minute timeout by default, and retries 3 times.
```
python3 dk-installer.py tg install --pull-timeout=<minutes>
```
--ssl-cert-file and --ssl-key-file: To enable SSL for HTTPS support by specifying local file paths to your SSL certificate and key files.
```
python3 dk-installer.py tg install \
  --ssl-cert-file=<path to cert file> \
  --ssl-key-file=<path to key file>
```
--no-analytics: To disable sending anonymous analytics data to DataKitchen. For more details, see Anonymous Analytics.
```
python3 dk-installer.py --no-analytics tg install
```

How to remove demo data¶

After completing the quickstart, you can remove the demo data from TestGen with the following steps.

Verify that the UI is accessible and the docker-compose.yaml file generated by the installation is present in the folder.
Run the delete demo command.
```
python3 dk-installer.py tg delete-demo
```