🔘Pynt as a standalone container

Pynt container can run without the CLI, facilitating its use in various deployment scenarios beyond traditional Docker-based environments. This mode is particularly useful for systems leveraging Kubernetes or similar container orchestration platforms.

This mode is based on Pynt command, but here the user is required to run the Pynt container, control it through APIs, and route the http traffic through the container.

There are two step needed for this integration:

Run the Pynt Container: This involves setting up and running the Pynt container. Pynt can operate as a stand-alone server, as long as it setup correctly.

Control via APIs & Route HTTP Traffic: After deploying the Pynt container, you will need to manage it through its APIs. Additionally, route your HTTP traffic through the container to have Pynt scan the traffic.

How to run the Pynt Container

Image:

• ghcr.io/pynt-io/pynt:proxy-latest

ports:

• 6666 - Pynt proxy port

• 5001 - port for API commands to Pynt server

Environment variables:

• PYNT_SAAS_URL="https://api.pynt.io/v1" - Pynt platform URL

• PYNT_ID="$PYNT_ID" - Pynt credentials, how to get it

Here is an example of running Pynt server using docker:

docker run -e PYNT_ID="$PYNT_ID" -e PYNT_SAAS_URL="https://api.pynt.io/v1
" -p 6666:6666 -p 5001:5001 --rm ghcr.io/pynt-io/pynt:proxy-latest

How to control Pynt container

Once the Pynt container is running in your environment, run the Pynt scan by the following three steps:

1. To activate the Pynt proxy, make a call to the /api/proxy/start endpoint. Once activated, Pynt will listen on port 6666 for incoming traffic. For example, you can use curl as follows:

   scan_id=$(curl -X PUT $base_url:5001/api/proxy/start)

2. Run your functional tests through the Pynt proxy. Pynt will read and analyze the traffic. For example, using Python Pytest:

   export HTTP_PROXY=$base_url:6666
   export HTTPS_PROXY=$base_url:6666
   pytest goat.py

3. To start a Pynt scan, you need to call the /api/proxy/stop endpoint, providing the scan_id in the message body. For example, you can use the following curl command:

   curl -X PUT $base_url:5001/api/proxy/stop -d "$scan_id" -H "Content-Type: application/json"

4. Optionally, you can pass the Application ID and Test Name for improved management of this scan in the Pynt platform. For example:

   json_payload=$(printf '{"scanId": "%s", "applicationId": "%s", "testName": "%s"}' "$scan_id_param" "$applicationId" "$testName")
   curl -X PUT "$base_url:5001/api/proxy/stop" -d "$json_payload" -H "Content-Type: application/json"

5. To retrieve the report, send repeated requests (poll) to the endpoint /api/report, including the scan ID as a query parameter. A status code of 202 indicates the scan is still running, while a 200 status code signifies that the scan is complete and the HTML report is included in the response body. For example:

   status_code=$(curl -o "$temp_output" -s -w "%{http_code}\n" $base_url:5001/api/report?scanId=$scan_id_param)

Example: Pynt with Kubernetes

https://github.com/pynt-io/pynt/tree/main/goat_functional_tests/k8s