[installer]: add HTTP_PROXY envvars to the Installer #12726

mrsimonemms · 2022-09-07T10:08:09Z

Description

Adds preliminary support for HTTP_PROXY (and HTTPS_PROXY and NO_PROXY) in the Installer. This adds an optional secret which receives the proxy settings from the KOTS CLI settings - the NO_PROXY envvar also hard-codes some additional parameters required for the application to work.

Important - this is not a full feature. It is merely the initial work to enable other teams to help out in their areas of expertise. This adds the appropriate envvars to the resources and wires them all up in a fashion that allows the Gitpod stack to run without error. However, it DOES NOT allow an image to be built or workspace to be run. There are additional tickets in #10769 that detail these tasks

An interesting thing of note is that the @grpc/grpc-node library does not respect wildcard NO_PROXY URLs. To address that, the server adds an addition no_grpc_proxy (which is the primary envvar for this library) and changes all resources it calls to the FQDN. See the issue for more details.

Related Issue(s)

Fixes #12835
Fixes #12820
Fixes #12821

How to test

This will also need testing in a non-proxied instance to ensure no regressions are introduced

Create a new server with Squid installed. This server must have unrestricted internet access
Configure an airgapped installation and configure the k3s cluster to access the proxy
Run kubectl kots install gitpod --http-proxy <http-proxy> --https-proxy <https-proxy> --no-proxy <no-proxy> to install Gitpod

Configuring your cluster

A repo exists that will create a k3s cluster for you in Azure. Run make azure-k3s with the following settings in your .auto.tfvars file

domain_name = "<your domain name>"
azure_k3s = true
enable_airgapped = true
http_proxy = "<your proxy settings - eg http://user:password@ip-address:3128">

Release Notes

[installer]: add HTTP_PROXY envvars to the Installer

Documentation

Werft options:

/werft with-preview

mrsimonemms · 2022-09-07T13:01:29Z

/werft run

👍 started the job as gitpod-build-sje-installer-proxy-config.5
(with .werft/ from main)

install/installer/pkg/components/content-service/configmap.go

install/kots/manifests/gitpod-http-proxy-settings.yaml

Pothulapati

install/installer/pkg/components/server/deployment.go

werft-gitpod-dev-com · 2022-09-13T07:31:14Z

started the job as gitpod-build-sje-installer-proxy-config.26 because the annotations in the pull request description changed
(with .werft/ from main)

geropl · 2022-09-13T07:31:40Z

Waiting for the build ☝️ to see if the default case is running.

…vvar The @grpc/grpc-node package does not support wildcards in the no_proxy envvar. Add the FQDN's for the components that the server calls to the no_grpc_proxy envvar so that these calls are not proxied

mrsimonemms · 2022-09-13T07:42:56Z

install/installer/pkg/components/server/deployment.go

@@ -122,6 +125,20 @@ func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
 		},
 	)

+	if ctx.Config.HTTPProxy != nil {


@geropl have updated as-per your comment 👍🏻

mrsimonemms · 2022-09-13T08:22:19Z

/werft run

👍 started the job as gitpod-build-sje-installer-proxy-config.28
(with .werft/ from main)

werft-gitpod-dev-com · 2022-09-13T09:35:01Z

started the job as gitpod-build-sje-installer-proxy-config.29 because the annotations in the pull request description changed
(with .werft/ from main)

werft-gitpod-dev-com · 2022-09-13T09:54:20Z

started the job as gitpod-build-sje-installer-proxy-config.31 because the annotations in the pull request description changed
(with .werft/ from main)

geropl

(WebApp related) Code LGTM, tested the preview and workspaces still start 🙃 ✔️

mrsimonemms · 2022-09-13T10:46:26Z

Thanks @geropl

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/XXL labels Sep 7, 2022

mrsimonemms force-pushed the sje/installer-proxy-config branch 4 times, most recently from 4c3637c to 208853e Compare September 7, 2022 13:00

roboquat added release-note and removed do-not-merge/release-note-label-needed labels Sep 7, 2022

mrsimonemms force-pushed the sje/installer-proxy-config branch 15 times, most recently from 6cd0c30 to ef3867d Compare September 9, 2022 12:16

mrsimonemms changed the title ~~[installer]: add support for HTTP_PROXY~~ [installer]: add HTTP_PROXY envvars to the Installer Sep 9, 2022

mrsimonemms marked this pull request as ready for review September 9, 2022 13:34

mrsimonemms requested review from a team September 9, 2022 13:34

kylos101 mentioned this pull request Sep 9, 2022

allow for injection of envvars into imagebuild/workspace templates from the Installer #12829

Closed

sagor999 reviewed Sep 9, 2022

View reviewed changes

install/installer/pkg/components/content-service/configmap.go Show resolved Hide resolved

sagor999 approved these changes Sep 9, 2022

View reviewed changes

mrsimonemms force-pushed the sje/installer-proxy-config branch from ef3867d to a9c91bb Compare September 12, 2022 11:31

Pothulapati reviewed Sep 12, 2022

View reviewed changes

install/kots/manifests/gitpod-http-proxy-settings.yaml Outdated Show resolved Hide resolved

mrsimonemms force-pushed the sje/installer-proxy-config branch from a9c91bb to ee71ee5 Compare September 12, 2022 11:49

Pothulapati approved these changes Sep 12, 2022

View reviewed changes

mrsimonemms mentioned this pull request Sep 12, 2022

"new Git integration" page does not respect the proxy settings #12874

Closed

geropl self-assigned this Sep 13, 2022

geropl reviewed Sep 13, 2022

View reviewed changes

install/installer/pkg/components/server/deployment.go Outdated Show resolved Hide resolved

Simon Emms added 3 commits September 13, 2022 07:42

[installer]: set proxy server configuration in installer

0ba9406

[installer]: explicitly set all host addresses to 0.0.0.0

3dbf7b7

[installer]: set the server URLs to the FQDN and add no_grpc_proxy en…

1de08a6

…vvar The @grpc/grpc-node package does not support wildcards in the no_proxy envvar. Add the FQDN's for the components that the server calls to the no_grpc_proxy envvar so that these calls are not proxied

mrsimonemms force-pushed the sje/installer-proxy-config branch from ee71ee5 to 67a8365 Compare September 13, 2022 07:42

mrsimonemms commented Sep 13, 2022

View reviewed changes

Simon Emms added 2 commits September 13, 2022 09:45

[installer]: update golden files

7d3a5e8

[kots]: add proxy server configuration

f791db5

mrsimonemms force-pushed the sje/installer-proxy-config branch from 67a8365 to f791db5 Compare September 13, 2022 09:45

geropl approved these changes Sep 13, 2022

View reviewed changes

roboquat merged commit 3d55ab2 into main Sep 13, 2022

roboquat deleted the sje/installer-proxy-config branch September 13, 2022 10:38

roboquat added deployed: webapp Meta team change is running in production deployed: workspace Workspace team change is running in production labels Sep 14, 2022

AlexTugarev mentioned this pull request Feb 10, 2023

[OIDC] Check issuer URL for reachability #16331

Merged

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[installer]: add HTTP_PROXY envvars to the Installer #12726

[installer]: add HTTP_PROXY envvars to the Installer #12726

mrsimonemms commented Sep 7, 2022 •

edited

Loading

mrsimonemms commented Sep 7, 2022 •

edited by werft-gitpod-dev-com bot

Loading

Pothulapati left a comment

werft-gitpod-dev-com bot commented Sep 13, 2022

geropl commented Sep 13, 2022

mrsimonemms Sep 13, 2022

mrsimonemms commented Sep 13, 2022 •

edited by werft-gitpod-dev-com bot

Loading

werft-gitpod-dev-com bot commented Sep 13, 2022

werft-gitpod-dev-com bot commented Sep 13, 2022

geropl left a comment

mrsimonemms commented Sep 13, 2022

[installer]: add HTTP_PROXY envvars to the Installer #12726

[installer]: add HTTP_PROXY envvars to the Installer #12726

Conversation

mrsimonemms commented Sep 7, 2022 • edited Loading

Description

Related Issue(s)

How to test

Configuring your cluster

Release Notes

Documentation

Werft options:

mrsimonemms commented Sep 7, 2022 • edited by werft-gitpod-dev-com bot Loading

Pothulapati left a comment

Choose a reason for hiding this comment

werft-gitpod-dev-com bot commented Sep 13, 2022

geropl commented Sep 13, 2022

mrsimonemms Sep 13, 2022

Choose a reason for hiding this comment

mrsimonemms commented Sep 13, 2022 • edited by werft-gitpod-dev-com bot Loading

werft-gitpod-dev-com bot commented Sep 13, 2022

werft-gitpod-dev-com bot commented Sep 13, 2022

geropl left a comment

Choose a reason for hiding this comment

mrsimonemms commented Sep 13, 2022

mrsimonemms commented Sep 7, 2022 •

edited

Loading

mrsimonemms commented Sep 7, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mrsimonemms commented Sep 13, 2022 •

edited by werft-gitpod-dev-com bot

Loading