Before you start
- To verify on IronBee, register your instance in the console and connect the project’s group there. See GitLab Self-Managed and Dedicated.
- The IronBee CLI the job installs is the latest release, unless
ironbee_cli_versionpins one. Pin 0.54.0 or newer: an older CLI names no repository for a job off gitlab.com. - The CI/CD variables, as on gitlab.com. See Get started with the GitLab component. Clear Protect variable on each, which GitLab ticks by default: a protected variable reaches only pipelines of protected branches and tags, so a merge request pipeline from another branch runs without it.
Make your copy
Your copy is a mirror ofgitlab.com/ironbee-ai/ironbee-gitlab, with its tags, in a group of yours on the instance:
- With the IronBee CLI, an administrator runs
ironbee host setup gitlab.acme.com --components tools, which makes the group and the copy and pushes the component’s branches and tags into it. Run it again to take a new release. See The components’ copies. - By hand, set up pull mirroring where your tier has it (Premium and Ultimate), or push the branches and tags yourself. A push by hand carries
-o ci.skip: the copy holds IronBee’s own release pipeline, which isn’t meant to run on your runners. The copy doesn’t follow gitlab.com by itself, so bring it up to each new release the same way.
Include your copy
The include names your copy on the job’s own instance, at a tag, and the job names the same copy for its scripts:- The tag. The moving
@v1or a release tag needs nothing more. A partial version, such as@1, or~latestresolves only for a copy published in your instance’s CI/CD Catalog. IRONBEE_GITLAB_PROJECTnames your copy. Its default,ironbee-ai/ironbee-gitlab, is a path anyone on your instance may hold. The job fetches its scripts at the commit its include resolved, which a project other than your copy doesn’t have, so a wrong or missing path fails the job at the fetch instead of running that project’s scripts.
Platform or local on your instance
Off gitlab.com, the component counts the project as private whatever its visibility, since IronBee reads it only through its group’s connection on your registered instance. So withverification_mode: auto, the job runs locally when an Anthropic credential is set, and on IronBee otherwise. Once the project’s group is connected, set verification_mode: platform. See How auto decides.
A private certificate authority
Name the authority’s file in your GitLab runners’ configuration,tls-ca-file. GitLab then hands each job its path as CI_SERVER_TLS_CA_FILE, and the component trusts it:
- for its own fetch of the scripts
- for the IronBee CLI and its own calls, through
NODE_EXTRA_CA_CERTS, so every other host stays trusted - for its git that talks to your instance, through
GIT_SSL_CAINFO
NODE_EXTRA_CA_CERTS or GIT_SSL_CAINFO your pipeline sets itself is kept, and then has to hold your authority. The job’s image doesn’t have the authority installed: your application’s own commands that call your instance set it up themselves.
Fix commits
Fix commits are authored asIronBee <ironbee-gitlab@users.noreply.gitlab.acme.com>, with your instance’s host. They carry [skip ci] as on gitlab.com. See Running in GitLab CI/CD.
What the job’s runner must reach
On 443:- IronBee’s API and collector,
api.service.ironbee.aiandcollector.service.ironbee.ai - on IronBee with the application on the runner, the verification tunnel’s endpoint, an address the IronBee API gives each run, with no fixed name
- the npm registry
- Docker Hub, for the job’s default image
- Anthropic’s API, whenever fixing is on or the mode is local
- in local mode, Playwright’s browser download
What’s next?
GitLab Self-Managed and Dedicated
Register your instance and connect its groups.
Configuration
Every input and output, with defaults.