Skip to content

Administer TestGen

After installing TestGen, use the topics in this section to manage, configure, and maintain your deployment. These tasks are typically performed by the person who installed TestGen or manages the infrastructure it runs on.

Manage the application

How you operate the application depends on how it was installed.

TestGen runs as a Docker Compose application. Use the docker compose CLI to operate it. All commands must be run in the directory that contains the docker-compose.yaml file generated by the installation.

Stop the application

docker compose down

Restart the application

docker compose up -d --wait

View application logs

To follow real-time logs from the TestGen containers, use the following command. Press Ctrl+C to stop following.

docker compose logs -f

TestGen runs as a single application pod, managed by the Helm release created by the installation. The examples below use the release name dk-tg-app in the datakitchen namespace.

Stop the application

Scale the deployment to zero. The release and its configuration are kept.

kubectl scale deployment dk-tg-app-testgen --replicas=0 -n datakitchen

Restart the application

kubectl scale deployment dk-tg-app-testgen --replicas=1 -n datakitchen

To restart without changing the replica count, use kubectl rollout restart deployment dk-tg-app-testgen -n datakitchen.

View application logs

To follow real-time logs from the TestGen pod, use the following command. Press Ctrl+C to stop following.

kubectl logs -f deployment/dk-tg-app-testgen -n datakitchen

Configure the deployment

The settings in this section are applied to the deployment through environment variables. Restart the application for a change to take effect.

Settings that apply across the instance are managed in the application instead, on the System Settings page, and take effect immediately.

  • Set Environment Variables — apply environment variable settings and restart the application, in Docker, pip, and Kubernetes install modes.
  • Configure HTTPS — serve the TestGen UI and API over TLS with an SSL certificate.
  • Configure Email Server — connect an SMTP email server to enable email notifications for profiling runs, test runs, monitor anomalies, and quality scorecards.
  • Configure SSO Authentication — integrate with an OpenID Connect identity provider for single sign-on. Enterprise
  • Set Custom Logo — replace the default logo on the navigation menu with your company branding. Enterprise

Maintain your deployment