Development of GitLab Duo Workflow
This guide describes how to set up the local development environment for the various projects that make up GitLab Duo Workflow.
Prerequisites
- Vertex API access
- You need access to the
ai-enablement-dev-69497ba7
project in GCP. This should by available to all engineers at GitLab.
- You need access to the
- Docker
- See which Docker tooling is approved for GitLab team members in the handbook.
Set up local development for Workflow
Workflow consists of four separate services:
GDK Setup
We recommend setting up GitLab Duo Workflow directly with the GitLab Development Kit (GDK) for setting up local versions of GitLab, the GitLab Duo Workflow Service and Executor.
This setup can be used with the publicly available version of the VS Code Extension. Follow these instructions to see the GitLab Duo Workflow UI local build in VS Code if you want to actively need to develop it or use an unreleased version.
Manual Setup
GitLab Duo Workflow UI in Visual Studio Code (VS Code)
There is no need for the GDK, Workflow service or Workflow executor local build to test the GitLab Duo Workflow UI. Only set these up if you are making changes to one of these packages and need to test their integration with the GitLab Duo Workflow UI in VS Code. Please refer to the GitLab Duo Workflow README.md file in the Language Server project to get started with local development of GitLab Duo Workflow UI.
Set up your local GitLab instance
Configure the GitLab Duo Workflow Service URL in your local GitLab instance by updating the
config/gitlab.yml
file:development: duo_workflow: service_url: 0.0.0.0:50052 secure: false
Restart the GitLab instance.
gdk restart rails
In your local GitLab instance, enable the
duo_workflow
feature flag from the Rails console:Feature.enable(:duo_workflow)
Set up GitLab Runner with GDK so you can create CI jobs locally to test Workflow.
Create a personal access token in your local GitLab instance with the
api
scope. Save this value and use it in the next step.Run GDK with an Ultimate license.
If you’re running GitLab in SaaS mode, you’ll need to turn on the
beta and experimental features
functionality, as they are turned off by default. In the group settings for the project you’ll run workflow against, ensure that theUse experiment and beta Duo features
checkbox is checked.Manually create a Workflow using the following
curl
request; the output will be a workflow ID that is referred to as$WORKFLOW_ID
throughout the rest of these docs:curl POST --verbose \ --header "Authorization: Bearer $YOUR_GITLAB_PAT" \ --header 'Content-Type: application/json' \ --data '{ "project_id": "$PROJECT_ID_FOR_RUNNING_WORKFLOW_AGAINST" }' \ $YOUR_GDK_ROOT_URL/api/v4/ai/duo_workflows/workflows
Set up the GitLab Duo Workflow Service and Executor
Refer to the readme of GitLab Duo Workflow Service and GitLab Duo Workflow Executor to set them up individually.
Troubleshooting
Issues connecting to 50052 port
JAMF may be listening on the 50052
port which will conflict with GitLab Duo Workflow Service.
$ sudo lsof -i -P | grep LISTEN | grep :50052
jamfRemot <redacted> root 11u IPv4 <redacted> 0t0 TCP localhost:50052 (LISTEN)
To work around this,run the serveron 50053 with:
PORT=50053 poetry run duo-workflow-service
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support