Licensing

Most Vector tools need a license at runtime. Every Vector tool your pipelines use needs a license that your organization has purchased. The platform serves licenses to your jobs; it does not grant them. You purchase licenses for Vector tools from Vector. You always provide the licenses for third-party tools yourself.

Your situation Where the license comes from
Vector tool, in a pipeline Your purchased Vector license, served by the Vector license server. Add the server to the Vector License Client in your job
Vector tool, on your computer Your own license, purchased separately
Third-party tool, your own keys, needs a server A license server Vector operates with your keys activated on it
Third-party tool with a license file Your file, stored as a masked CI/CD variable

Vector tools in pipelines

Your license-enabled runners can connect to a Vector license server. Once your organization has purchased the licenses, your pipelines are allowed to use those Vector tools.

Use only the licenses you own

Even if the license server makes a license available to a job, this is not an entitlement to use the tool or the license. You need to own a Vector license for every Vector tool your pipelines run. Ask your Vector contact which licenses your organization has for pipelines, or to purchase them.

The server is exposed to jobs as a variable:

VECTOR_LICENSE_SERVER = "vector.prod.license.vector.internal"

You may need to add the license server to your Vector License Client:

VectorLicenseClient -addServers $VECTOR_LICENSE_SERVER

How many jobs can hold a license at once

Your organization may have a fixed number of licenses for each tool, and a job holds one license for as long as it runs. The number of jobs that can use a tool at the same time is therefore the number of license-enabled runners that can run in parallel.

If no license is free, the job fails. It does not wait for a license. Stagger the jobs that need the same tool, or ask your Vector contact about purchasing more licenses.

Reachable from license-enabled runners only

The license servers are on the runner network. They are not reachable from your computer or from your corporate network, and they cannot be made reachable. See Local setup.

Third-party tools

Tools that are not Vector products, such as compilers, static analyzers and simulation tools, are not covered by the Vector license server, and Vector does not provide licenses for them. You provide the licenses yourself, and there are two ways to make them available to your pipelines.

Your licenses on a license server that Vector operates

For your own license keys, Vector can run a license server on your runner network and activate your keys on it. You buy the licenses, and Vector hosts them and serves them to your pipelines. No firewall changes are needed on your side.

Your license file as a CI/CD variable

If a tool's license is a file and is not served by a license server, you supply the file. It is treated as a secret: it is stored in a masked CI/CD variable and is never committed. Customer users cannot set CI/CD variables, so ask your Vector contact to add it. See Secrets.

When a pipeline fails with a license error

Two causes are common:

  • All licenses for the tool are in use by other jobs. Rerun the job, or stagger the jobs that need the tool. See How many jobs can hold a license at once.
  • The tool does not find the license server. The Vector License Server has not been configured on your Vector License Client.

Report it to your Vector contact with the pipeline and job URL and the exact error text. See Getting help.