Page MenuHomePhabricator
Create Task
Maniphest T426110

[GrowthBook Integration] Set GROWTHBOOK_API_KEY environment variable for staging and production
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

Description

The backend of Test Kitchen UI polls the GrowthBook REST API on startup and at a configurable interval to sync experiment configuration. The API requires a Bearer token for authentication. The token is read from the GROWTHBOOK_API_KEY environment variable at startup (see config/configuration.js in prospective MR). If the variable is not set, the application logs an error and the poller will fail to authenticate.

The placeholder <growthbook-api-key> in config.prod.yaml and config.dev.yaml documents where the value is expected. The real key must be injected via the deployment system.

Technical Notes

The API key can be found in the GrowthBook instance under Settings >> API Keys (https://growthbook.wikimedia.org/settings/keys).

Staging and production should probably use different keys depending on which GrowthBook environment they point to.

Acceptance Criteria

  • Make sure that the API key is not bound to a user account
  • The GROWTHBOOK_API_KEY is set as a Kubernetes secret and mounted as an environment variable in the Test Kitchen UI pod for both staging and production
  • The GrowthBook poller successfully authenticates and syncs experiment configuration on startup for both staging and production

Details

Other Assignee
brouberol
Related Changes in Gerrit:
SubjectRepoBranchLines +/-
test-kitchen chart: Updated to support growthbook specific configurationoperations/deployment-chartsmaster+16 -2
Customize query in gerrit

Related Objects
Search...

Event Timeline

cjming created this task.Tue, May 12, 6:07 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptTue, May 12, 6:07 PM
cjming updated the task description. (Show Details)Tue, May 12, 6:08 PM
cjming updated the task description. (Show Details)
cjming updated the task description. (Show Details)Tue, May 12, 6:11 PM
cjming updated the task description. (Show Details)
cjming renamed this task from [GrowthBook Integration] Set GROWTHBOOK_API_KEY environment variable for staging and production deployments to [GrowthBook Integration] Set GROWTHBOOK_API_KEY environment variable for staging and production.Tue, May 12, 6:32 PM
cjming updated the task description. (Show Details)
KReid-WMF triaged this task as High priority.Thu, May 14, 3:46 PM
KReid-WMF edited projects, added Test Kitchen (Experiment Platform Sprint 24); removed Test Kitchen.
KReid-WMF updated the task description. (Show Details)
KReid-WMF set the point value for this task to 3.
Sfaci subscribed.Thu, May 14, 10:57 PM

Regarding the first AC, and once we have a GrowthBook API Key not bound to a specific user:

The GROWTHBOOK_API_KEY is set as a Kubernetes secret and mounted as an environment variable in the Test Kitchen UI pod for both staging and production

I have found some notes I took while creating the kubernetes chart for the first time for Test Kitchen UI regarding how to provision secrets for a service (T361342: Provision the MPIC secrets in the private puppet repository was the related ticket at that time):

In the case we need new secrets once we have created chart/helmfile or even when the service is already deployed and running, we have to file a ticket at https://phabricator.wikimedia.org/project/board/6524/ asking for what we need. After that we should create a chart change to add them and deploy the service to start using them.

cjming added a parent task: T421792: [EPIC] Build GrowthBook-originated experiment configuration service with transitional Test Kitchen UI stitching.Thu, May 14, 11:35 PM
CodeReviewBot added a project: Patch-For-Review.Fri, May 15, 3:49 PM

sfaci opened https://gitlab.wikimedia.org/repos/data-engineering/growthbook/-/merge_requests/45

New docker image for staging that includes status as a filter in the API

Sfaci removed a project: Patch-For-Review.Fri, May 15, 3:50 PM
Sfaci added a comment.Fri, May 15, 10:55 PM

My mistake. The last related patch about the new docker image is not related to this ticket.

Sfaci claimed this task.Fri, May 15, 11:54 PM
Sfaci moved this task from Ready for Development to In Progress on the Test Kitchen (Experiment Platform Sprint 24) board.
Sfaci updated the task description. (Show Details)Sun, May 17, 3:41 PM
Sfaci added a project: Data-Platform-SRE.Mon, May 18, 8:49 AM
brouberol updated Other Assignee, added: brouberol.Mon, May 18, 9:15 AM
brouberol subscribed.Mon, May 18, 10:09 AM

Both test-kitchen-next and growthbook now have a GROWHTBOOK_API_KEY environment variable containing an API key for growthbook.

test-kitchen is integrated with growthbook and test-kitchen-next is integrated with growthbook-next.

brouberol updated the task description. (Show Details)Mon, May 18, 10:09 AM
brouberol changed the task status from Open to In Progress.Mon, May 18, 10:10 AM
brouberol moved this task from Backlog - project to In Progress on the Data-Platform-SRE (2026-04-24 - 2026-05-15) board.
brouberol edited projects, added Data-Platform-SRE (2026-04-24 - 2026-05-15); removed Data-Platform-SRE.
brouberol moved this task from In Progress to Done on the Data-Platform-SRE (2026-04-24 - 2026-05-15) board.Mon, May 18, 10:10 AM
Sfaci reassigned this task from Sfaci to cjming.Mon, May 18, 4:03 PM
Sfaci moved this task from In Progress to Needs Review on the Test Kitchen (Experiment Platform Sprint 24) board.
Sfaci moved this task from Needs Review to In Progress on the Test Kitchen (Experiment Platform Sprint 24) board.Tue, May 19, 11:40 PM
Sfaci moved this task from In Progress to Needs Review on the Test Kitchen (Experiment Platform Sprint 24) board.
Sfaci moved this task from Needs Review to In Progress on the Test Kitchen (Experiment Platform Sprint 24) board.
cjming added a comment.Thu, May 21, 1:37 PM

I think this is done? prod still needs the status filter update but afaict the 400 error has to do with this rather than with the api key

Sfaci added a comment.Thu, May 21, 2:25 PM
In T426110#11944982, @cjming wrote:

I think this is done? prod still needs the status filter update but afaict the 400 error has to do with this rather than with the api key

Right! The GB API Key has been set already as a env var, so there is nothing else to do here. The purpose of the ticket was setting that config property as an env var. The third AC in the description is pretty unrelated because the tickets related to the code itself are covering that already.

gerritbot added a comment.Thu, May 21, 8:46 PM

Change #1290916 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[operations/deployment-charts@master] test-kitchen chart: Updated to support growthbook specific configuration

https://gerrit.wikimedia.org/r/1290916

gerritbot added a project: Patch-For-Review.Thu, May 21, 8:46 PM
gerritbot added a comment.Thu, May 21, 9:18 PM

Change #1290916 merged by jenkins-bot:

[operations/deployment-charts@master] test-kitchen chart: Updated to support growthbook specific configuration

https://gerrit.wikimedia.org/r/1290916

Sfaci moved this task from In Progress to Done on the Test Kitchen (Experiment Platform Sprint 24) board.Thu, May 21, 9:56 PM
Gehel moved this task from Done to Reported on the Data-Platform-SRE (2026-04-24 - 2026-05-15) board.Fri, May 22, 9:49 AM
KReid-WMF closed this task as Resolved.Wed, May 27, 3:04 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits