Add CustomersDot support to GDK
Overview
Add CustomersDot service to GDK, consolidating configuration to streamline development of licensing and subscription features.
Related repositories:
- https://gitlab.com/gitlab-org/customers-gitlab-com
- https://gitlab.com/gitlab-org/gitlab-development-kit
Impacted categories
-
gdk-usability - Streamlining CustomersDot setup and integration with GDK
Problem
Setting up CustomersDot locally requires manual configuration across multiple files:
- Manual
gdk.ymledits - Multiple environment variables (
CUSTOMER_PORTAL_URL,GITLAB_LICENSE_MODE,GITLAB_SIMULATE_SAAS) - Manual GraphQL proxy setup
- No standardized GDK commands for CustomersDot
See https://gitlab.com/gitlab-org/customers-gitlab-com/-/blob/main/doc/setup/gitlab.md?plain=0
Proposal
Add CustomersDot as a gdk service
gdk config set customers-dot.enabled true
Consolidate configuration in gdk.yml
customers-dot:
enabled: true
port: 5000
auto_start: true
license:
mode: test
customer_portal_url: http://localhost:5000
gitlab:
simulate_saas: false
Auto-configure when customers.enabled: true
- Set
license.customer_portal_urlautomatically - Configure GraphQL proxy
- Apply necessary environment variables
Benefits
- One-command setup:
gdk install customers - Unified configuration in
gdk.yml - Standard GDK commands work with CustomersDot
- Fewer manual setup errors
Edited by Doug Barrett