Skip to content

feat: add global.airbyteUrl Helm value for Airbyte 2.0.0+ #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 9, 2025
Merged

feat: add global.airbyteUrl Helm value for Airbyte 2.0.0+ #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
12f3785
feat: add global.airbyteUrl Helm value for Airbyte 2.0.0+
bernielomax Oct 8, 2025
022f18e
refactor: allow for dynamic ports in v2 Helm values
bernielomax Oct 9, 2025
f763055
test: fix tests
bernielomax Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions internal/cmd/local/install.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ func (i *InstallCmd) installOpts(ctx context.Context, user string) (*service.Ins
DisableAuth: i.DisableAuth,
LocalStorage: !supportMinio,
EnablePsql17: enablePsql17,
Port: i.Port,
}

if opts.DockerAuth() {
Expand Down
7 changes: 4 additions & 3 deletions internal/cmd/local/local_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ func TestValues_FileDoesntExist(t *testing.T) {
}

func TestValues_BadYaml(t *testing.T) {
cmd := InstallCmd{Values: "./testdata/invalid.values.yaml"}
cmd := InstallCmd{Values: "./testdata/invalid.values.yaml", Port: 8000}
// Does not need actual clients for tests.
testFactory := func(kubeConfig, kubeContext string) (k8s.Client, goHelm.Client, error) {
return nil, nil, nil
Expand All @@ -134,7 +134,7 @@ func TestValues_BadYaml(t *testing.T) {
}

func TestInvalidHostFlag_IpAddr(t *testing.T) {
cmd := InstallCmd{Host: []string{"ok", "1.2.3.4"}}
cmd := InstallCmd{Host: []string{"ok", "1.2.3.4"}, Port: 8000}
// Does not need actual clients for tests.
testFactory := func(kubeConfig, kubeContext string) (k8s.Client, goHelm.Client, error) {
return nil, nil, nil
Expand All @@ -146,7 +146,7 @@ func TestInvalidHostFlag_IpAddr(t *testing.T) {
}

func TestInvalidHostFlag_IpAddrWithPort(t *testing.T) {
cmd := InstallCmd{Host: []string{"ok", "1.2.3.4:8000"}}
cmd := InstallCmd{Host: []string{"ok", "1.2.3.4:8000"}, Port: 8000}
// Does not need actual clients for tests.
testFactory := func(kubeConfig, kubeContext string) (k8s.Client, goHelm.Client, error) {
return nil, nil, nil
Expand All @@ -162,6 +162,7 @@ func TestInstallOpts(t *testing.T) {
cmd := InstallCmd{
// Don't let the code dynamically resolve the latest chart version.
Chart: "/test/path/to/chart",
Port: 8000,
}
expect := &service.InstallOpts{
HelmValuesYaml: string(b),
Expand Down
16 changes: 15 additions & 1 deletion internal/helm/airbyte_values.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ type ValuesOpts struct {
DisableAuth bool
LocalStorage bool
EnablePsql17 bool
Port int
}

const (
Expand Down Expand Up @@ -116,8 +117,21 @@ func buildAirbyteValuesV1(ctx context.Context, opts ValuesOpts) (string, error)
func buildAirbyteValuesV2(ctx context.Context, opts ValuesOpts) (string, error) {
span := trace.SpanFromContext(ctx)

// Validate port is in valid range
if opts.Port <= 0 || opts.Port > 65535 {
return "", fmt.Errorf("invalid port %d: must be between 1 and 65535", opts.Port)
}

airbyteURL := fmt.Sprintf("http://localhost:%d", opts.Port)

vals := []string{
"server.env_vars.WEBAPP_URL=http://airbyte-abctl-airbyte-server-svc:80",
// WEBAPP_URL is required for backward compatibility with v2 Helm charts prior to Airbyte 2.0.0.
// Starting with Airbyte 2.0.0, the platform uses AIRBYTE_URL instead (set via global.airbyteUrl).
// Both are set here to support all v2 chart versions. WEBAPP_URL can be removed once all
// supported chart versions are >= 2.0.0.
// Port is omitted to use HTTP default (80), allowing users to override the service port via Helm values.
"server.env_vars.WEBAPP_URL=http://airbyte-abctl-airbyte-server-svc",
"global.airbyteUrl=" + airbyteURL,
"global.env_vars.AIRBYTE_INSTALLATION_ID=" + opts.TelemetryUser,
"global.jobs.resources.limits.cpu=3",
"global.jobs.resources.limits.memory=4Gi",
Expand Down
27 changes: 20 additions & 7 deletions internal/helm/airbyte_values_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,13 +212,14 @@ global:
`,
},
{
name: "v2: default options",
opts: ValuesOpts{TelemetryUser: "test-user"},
name: "v2: minimal options",
opts: ValuesOpts{TelemetryUser: "test-user", Port: 8000},
chartVersion: "2.0.0",
want: `airbyte-bootloader:
env_vars:
PLATFORM_LOG_FORMAT: json
global:
airbyteUrl: http://localhost:8000
auth:
enabled: true
env_vars:
Expand All @@ -230,19 +231,20 @@ global:
memory: 4Gi
server:
env_vars:
WEBAPP_URL: http://airbyte-abctl-airbyte-server-svc:80
WEBAPP_URL: http://airbyte-abctl-airbyte-server-svc
`,
},
{
name: "v2: all options enabled",
opts: ValuesOpts{TelemetryUser: "test-user", LocalStorage: true, EnablePsql17: true, LowResourceMode: true, InsecureCookies: true, ImagePullSecret: "mysecret", DisableAuth: false},
opts: ValuesOpts{TelemetryUser: "test-user", LocalStorage: true, EnablePsql17: true, LowResourceMode: true, InsecureCookies: true, ImagePullSecret: "mysecret", DisableAuth: false, Port: 8000},
chartVersion: "2.0.0",
want: `airbyte-bootloader:
env_vars:
PLATFORM_LOG_FORMAT: json
connectorBuilderServer:
enabled: false
global:
airbyteUrl: http://localhost:8000
auth:
security:
cookieSecureSetting: '"false"'
Expand All @@ -267,7 +269,7 @@ postgresql:
server:
env_vars:
JOB_RESOURCE_VARIANT_OVERRIDE: lowresource
WEBAPP_URL: http://airbyte-abctl-airbyte-server-svc:80
WEBAPP_URL: http://airbyte-abctl-airbyte-server-svc
workloadLauncher:
env_vars:
CHECK_JOB_MAIN_CONTAINER_CPU_REQUEST: "0"
Expand Down Expand Up @@ -319,19 +321,30 @@ global:
`,
},
{
name: "v2: invalid values file returns error",
name: "v2: invalid values file",
opts: ValuesOpts{
TelemetryUser: "test-user",
ValuesFile: filepath.Join(testdataDir, "invalid.values.yaml"),
Port: 8000,
},
chartVersion: "2.0.0",
wantErr: true,
},
{
name: "v2: values file not found returns error",
name: "v2: values file not found",
opts: ValuesOpts{
TelemetryUser: "test-user",
ValuesFile: filepath.Join(testdataDir, "nonexistent.values.yaml"),
Port: 8000,
},
chartVersion: "2.0.0",
wantErr: true,
},
{
name: "v2: invalid port",
opts: ValuesOpts{
TelemetryUser: "test-user",
Port: 0,
},
chartVersion: "2.0.0",
wantErr: true,
Expand Down