Skip to main content

garak (garak)

Probes a model endpoint for jailbreaks, prompt injection, data leakage and toxic output, and writes a report.

Generated from catalog/services/garak.yaml: do not edit by hand.

Summary​

Version0.12.0
Useexecute on demand
Layerfunctional (AI catalog)
CategoryEvaluation and LLM operations
Installation methodspython
External connectionno
Sandbox onlyno

Licence​

SPDX identifierApache-2.0
Licence policycore licence (MIT or Apache-2.0)
Licence exception-
Platform componentgarak

Packages and artifacts​

A package the project of the service publishes (its image, its binary archive, its Python or OS package) carries the licence of the service; a third-party package carries the licence written on its row, read from the official upstream metadata.

KindPackageVersionLicenceDetails
Python packagegarak0.12.0Apache-2.0interpreters, in order of preference python3.11, python3.12, python3.10

Supported systems and architectures​

MethodOperating systemsArchitectures
pythonRHEL family (dnf), Debian family (apt), Arch Linux (pacman)x86_64, aarch64 (not restricted by the descriptor)

Certified host systems: RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). The host preflight accepts these systems (other releases of a known family give a warning, end of life releases are refused) and the x86_64 and aarch64 architectures.

Prerequisites​

Host​

The descriptor declares no host preflight check.

Network and ports​

None.

Services and connections needed​

Details and resolution: see Dependencies.

Installation methods and modes​

MethodDefaultWhat the method uses
pythonyesa Python virtual environment holding the Python packages of the descriptor

Components​

ComponentKindInstallation methodsPorts
garak client (garak)clientpython-

Client (client) (default)​

Installed on the evaluation hosts, run on demand.

What the mode deploys:

ComponentPlacement
garakmin 1, recommended 1

Install this service​

The install wizard of the Navin Manager plans, validates and runs the installation; you need the services:install permission on the cluster.

  1. Open the wizard. In Clusters, choose the row action Install services of the target cluster. The wizard opens on its first step, Service.

  2. Choose the service. On the Service step, select garak. The card shows the licence Apache-2.0 and the dependencies the installation needs.

  3. Choose the hosts and the mode. On the Hosts step, tick the hosts, then choose the Mode: client (default). Each mode deploys the components listed in Installation methods and modes.

  4. Bind the dependencies. On the Bindings step, choose for each dependency (litellm) Install with the platform or Use an existing connection; an optional dependency can stay on No binding.

  5. Configure. On the Configure step, review the parameters (see Configuration parameters); the required ones are api_key. Passwords left empty with a generated default are generated and sealed by the Manager.

  6. Review and install. On the Install step the Manager validates the plan and shows the installation order; when it says "The plan is valid. Ready to install.", choose Install. A highly available mode is installed only when its HA checks pass.

  7. Verify. The operation ends when the health checks of every instance pass (see Health checks); the service then shows as running in Services.

On demand runs​

Probes a model for vulnerabilities (prompt injection, jailbreak, leakage) when a red team campaign is asked.

Portal screen: /quality/redteam

High availability​

Clusternone (none)
High availabilitynone (none)
Failovernone (none)
Replicationnone (none)
Quorumnone (none)
Discoverynone (none)
Entry pointnone (none)
Official documentationhttps://docs.garak.ai/garak

Topology per mode​

ModesHighest catalog levelDistributionQuorum componentFault domainsDescription
clientstandalone (standalone)parallel jobs (parallel-jobs)--Installed on the evaluation hosts; scans run in parallel, orchestrated outside the tool.

Notes​

  • A command line tool run on demand: never a highly available cluster; several scans run as independent parallel jobs.

Configuration parameters​

General​

ParameterTypeDefaultAllowed valuesRequiredSecretRestartDescription
Endpoint (endpoint_url)urlhttp://127.0.0.1:4000/v1-nononoOpenAI compatible base URL of the model to scan when no LiteLLM binding is set.
API key (api_key)password--yesyesnoKey of the scanned endpoint.
Model (model)stringnavin-chat-nononoModel name sent to the endpoint.
Probes (probes)stringpromptinject,dan,leakreplay-nononoComma separated garak probe families.

Dependencies​

For each active dependency the Manager takes the first of: the binding chosen in the wizard; a service of the same installation that provides it; a service already installed in the cluster; the only connection of the expected type. Otherwise an optional dependency stays unbound, and a required one is added to the installation in its default mode (the column below names the catalog service added).

BindingProvided byConnection typeEndpointOptionalWhen nothing is boundDescription
litellmlitellm-apiyesstays unbound (optional)LiteLLM gateway of the platform serving the model under scan (the endpoint of the generator); without it the endpoint parameter is used.

Commands​

CommandComponentTargetDescription
Scan the endpoint (scan)garakchosen hostRuns the configured probes against the endpoint; the report lands in the data directory. (asks for confirmation)

Health checks​

Liveness (per instance)​

ComponentCheckDetails
garak{{ paths.opt }}/venv/bin/python -m garak --version1 retries; interval 1 s; timeout 120 s

Uninstall​

Paths removed when the data is purged: {{ paths.data }}, {{ paths.opt }}.

Upstream documentation​