You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/administration/codefresh-runner.md
+40-33Lines changed: 40 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -311,60 +311,67 @@ All CNI providers/plugins are compatible with the runner components.
311
311
## Customized installation of the Codefresh Runner
312
312
### App Proxy installation
313
313
314
-
The App Proxy is an**optional** component of therunner that ismainlyusedwhen thegit provider server is installed on-premises behind the firewall.The App Proxy provides the following features once installed:
314
+
The App Proxy is an**optional** component of theRunner, usedmainly when theGit provider server is installed on-premises, behind the firewall.
315
315
316
-
* Enables you to automatically create webhooksforGitin the Codefresh UI (same as the SAAS experience)
317
-
* Sends commit status information back to your Git provider (same as the SAAS experience)
318
-
* Makes all Git Operationsin the GUI work exactly like the SAAS installation of Codefresh
319
-
320
-
The requirementsfor the App proxy is a Kubernetes cluster that:
321
-
322
-
1. has already the Codefresh runner installed
323
-
1. has an active [ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress/)
324
-
1. allows incoming connections from the VPC/VPN where users are browsing the Codefresh UI. The ingress connection**must** have a hostname assignedfor this route and**must** be configured to perform SSL termination
316
+
#### App-Proxy requirements
325
317
326
-
>Currently theApp-proxyworks onlyfor Github (SAAS and on-prem versions), Gitlab (SAAS and on-prem versions) and Bitbucket server.
alt="How App Proxy and the Codefresh runner work together"
335
-
caption="How App Proxy and the Codefresh runner work together"
336
-
max-width="80%"
337
-
%}
320
+
1. With the Codefresh runner installed<!--- is this correct? -->
321
+
1. Has an active [ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress/){:target="\_blank"}
322
+
1. Allows incoming connections from the VPC/VPN where users are browsing the Codefresh UI.
323
+
The ingress connection**must** have a hostname assignedfor this route and**must** be configured to perform SSL termination
338
324
339
-
Basically when a Git GET operation takes place, the Codefresh UI will contact the app-proxy (if itispresent) and it will route the request to the backing Git provider. The confidential Git information never leaves the firewall premisesandthe connection between the browserandthe ingress is SSL/HTTPS.
325
+
>Currently, App-Proxyissupported onlyfor SaaS and on-prem versions of GitHubandGitLab,andBitbucket Server.
340
326
341
-
The app-proxy has to work over HTTPS and by default it will use the ingress controller todo its SSL termination. Therefore, the ingress controller will need to be configured to perform SSL termination. Check the documentation of your ingress controller (for example [nginx ingress](https://kubernetes.github.io/ingress-nginx/examples/tls-termination/)). This means that the app-proxy does not compromise securityin any way.
327
+
#### Install App-Proxy
342
328
343
-
To install the app-proxy ona Kubernetes clusterthat already has aCodefreshrunner use the following command:
If you have multiple ingress controllersin the Kubernetes cluster, use the`--app-proxy-ingress-class` parameter to define which ingress will be used.
342
+
For additional security, to further limit the web browsers that can access the ingress, you can also define an allowlistfor IPs/ranges. Check the documentation of your ingress controllerfor the exact details.
354
343
355
-
If you have multiple ingress controllersin the Kubernetes cluster you can use the`--app-proxy-ingress-class` parameter to define which ingress will be used. For additional security you can also define an allowlistfor IPs/ranges that are allowed to use the ingress (to further limit the web browsers that can access the Ingress). Check the documentation of your ingress controllerfor the exact details.
356
-
357
-
By default the app-proxy ingress will use the path`hostname/app-proxy`. You can change that default by using the values filein the installation with the flag`--values values.yaml`.
358
-
359
-
See the`AppProxy` sectionin the example [values.yaml](https://github.com/codefresh-io/venona/blob/release-1.0/venonactl/example/values-example.yaml#L231-L253).
344
+
By default, the app-proxy ingress uses the path`hostname/app-proxy`. You can change that default by using the values filein the installation with the flag`--values values.yaml`.
345
+
See the`AppProxy` sectionin the example [values.yaml](https://github.com/codefresh-io/venona/blob/release-1.0/venonactl/example/values-example.yaml#L231-L253){:target="\_blank"}.
alt="How App Proxy and the Codefresh runner work together"
358
+
caption="How App Proxy and the Codefresh runner work together"
359
+
max-width="80%"
360
+
%}
361
+
362
+
The App-Proxy:
363
+
* Enables you to automatically create webhooksforGitin the Codefresh UI (same as the SAAS experience)
364
+
* Sends commit status information back to your Git provider (same as the SAAS experience)
365
+
* Makes all Git operationsin the GUI work exactly like the SAAS installation of Codefresh
366
+
367
+
For a Git GET operation, the Codefresh UI communicates with the App-Proxy to route the request to the backing Git provider. The confidential Git information never leaves the firewall premises and the connection between the browser and the ingress is SSL/HTTPS.
368
+
369
+
The App-Proxy has to work over HTTPS, and by default it uses the ingress controller to terminate the SSL. Therefore, the ingress controller must be configured to perform SSL termination. Check the documentation of your ingress controller (for example [nginx ingress](https://kubernetes.github.io/ingress-nginx/examples/tls-termination/){:target="\_blank"}). This means that the App-Proxy does not compromise securityin any way.
370
+
364
371
365
-
###Manual Installation ofRunnerComponents
372
+
###Manually installRunnercomponents
366
373
367
-
If you don't want to use thewizard, you can also install the components of the runner yourself.
374
+
If you don't want to use theWizard, you can also install the components of the runner yourself.