For the complete documentation index, see llms.txt. This page is also available as Markdown.

Legacy DRAGEN Cloud Licensing

Credential based authentication is required for users that run DRAGEN on the cloud with the legacy Bring-Your-Own-License (BYOL) model. DRAGEN must have access to the DRAGEN License server at runtime, license.dragen.illumina.com.

DRAGEN also authenticates cloud runs with the instance identity document from the cloud provider's instance metadata service. See Instance Identity for AWS or Azure.

To verify connectivity to the license server, you can query the healthcheck endpoint which will return a 200 status code and a small JSON body if successful.

curl https://license.dragen.illumina.com/healthcheck/version --header 'Content-Type: application/json'
{"version":"<server version>"}

Running DRAGEN Cloud BYOL with Credential Licensing

BYOL users must provide credentials to DRAGEN at runtime, using one of two options.

Providing Credentials via License Credentials File

The suggested method for specifying your credentials is through a file passed in to DRAGEN at runtime. The file can be pointed to using the option --lic-credentials <path to file> or an environment variable containing the path to this file, DRAGEN_LICENSE_CREDENTIALS_FILE. This method provides a more secure way to pass credentials, which avoids accidental credentials leaks from command line console logs.

The License Credentials File should be formatted as follows;

credentials-1=<username>
credentials-2=<password>

Providing Credentials via Command Line

Alternatively, you can simply provide your credentials over the command line using the option --lic-server <license server URL with credentials>.

The license server URL should be formatted as follows;

Retrieving License Information and usage using dragen_lic

There are two options for retrieving information and usage for your licenses using the packaged dragen_lic tool. Examples for each one are below.

  • Basic Output (i.e. no additional arguments). This is the recommended method to view license information by a human user as the output is more readable.

  • JSON Output (i.e. using the -j flag). This is the recommended method to view license information by a machine user as the output is already in a machine readable JSON format.

Note: Just like running DRAGEN as noted above, you must specify your credentials using the --lic-credentials or --lic-server command line options.

Retrieving License Information and usage using API endpoint

Alternatively, you can retrieve license information and usage using our License Server endpoint specified below without the use of DRAGEN. License information is returned in a JSON format.

GET request to https://license.dragen.illumina.com/api/v2/query_quota. Your user credentials must be provided as a Basic Authorization header. An example of this using the curl tool is shown below.

Run information collected

Run information is a key component of the DRAGEN Licensing infrastructure. For each individual run, the following information is collected by Illumina;

  • date

  • duration

  • run status

  • software version

  • data quality

  • licensing quota consumed (number of bases)

  • instance identity

Last updated

Was this helpful?