Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit1475f7f

Browse files
committed
Update codefresh-runner.md
1 parent2e4bf57 commit1475f7f

File tree

1 file changed

+40
-33
lines changed

1 file changed

+40
-33
lines changed

‎_docs/administration/codefresh-runner.md‎

Lines changed: 40 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -311,60 +311,67 @@ All CNI providers/plugins are compatible with the runner components.
311311
## Customized installation of the Codefresh Runner
312312
### App Proxy installation
313313

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.
315315

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
325317

326-
>Currently theApp-proxyworks onlyfor Github (SAAS and on-prem versions), Gitlab (SAAS and on-prem versions) and Bitbucket server.
318+
Appproxyrequires a Kubernetes cluster that:
327319

328-
Here is the architecture of the app-proxy:
329-
330-
{% include image.html
331-
lightbox="true"
332-
file="/images/administration/runner/app-proxy-architecture.png"
333-
url="/images/administration/runner/app-proxy-architecture.png"
334-
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
338324

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.
340326

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
342328

343-
To install the app-proxy ona Kubernetes clusterthat already has aCodefreshrunner use the following command:
329+
***Ona Kubernetes clusterwith existingCodefreshRunner**:
344330

345331
```shell
346332
codefresh install app-proxy --host=<hostname-of-ingress>
347333
```
348334

349-
If you want to install theCodefresh runner and app-proxyin a singlecommand use the following:
335+
***InstallCodefresh runner and app-proxy**:
350336

351337
```shell
352338
codefresh runner init --app-proxy --app-proxy-host=<hostname-of-ingress>
353339
```
340+
***Define the ingress classfor app-proxy**:
341+
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.
354343

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"}.
360346

361347
```shell
362348
codefresh install app-proxy --values values.yaml
363349
```
350+
#### App-Proxy architecture
351+
Here is the architecture of the app-proxy:
352+
353+
{% include image.html
354+
lightbox="true"
355+
file="/images/administration/runner/app-proxy-architecture.png"
356+
url="/images/administration/runner/app-proxy-architecture.png"
357+
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+
364371

365-
###Manual Installation ofRunnerComponents
372+
###Manually installRunnercomponents
366373

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.
368375
369376
The Codefresh runner consists of the following:
370377
@@ -382,7 +389,7 @@ codefresh install agent --agent-kube-namespace codefresh --install-runtime
382389
383390
You can then follow the instructions for [using the runner](#using-the-codefresh-runner).
384391
385-
### Installing Multiple runtimes with a Single Agent
392+
#### Installing Multiple runtimes with a Single Agent
386393
387394
It is also possible, for advanced users to install a single agent that can manage multiple runtime environments.
388395

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp