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/getting-started/architecture.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,8 +58,8 @@ The sections that follow show detailed views of runtime architecture in the diff
58
58
In this installation environment, the Codefresh Runtime is installed on a _Codefresh-managed cluster_ in the Codefresh platform.
59
59
* Hybrid runtime architecture:
60
60
In this installation environment, the Codefresh Runtime is installed on a _customer-managed cluster_ in the customer environment. The Codefresh Runtime with or without ingress controllers:
Runtimes with ingress use an ingress controller to control communication between the Codefresh Runtime in the customer cluster and the Codefresh Platform. Ingress controllers are optimal when the cluster with the Codefresh Runtime is exposed to the internet.
84
+
#### Ingress-based hybrid runtime architecture
85
+
Ingress-based runtimes use ingress controllers to control communication between the Codefresh Runtime in the customer cluster and the Codefresh Platform. Ingress-based runtimes are optimal when the cluster with the Codefresh Runtime is exposed to the internet.
86
86
87
87
88
88
@@ -96,16 +96,16 @@ Runtimes with ingress use an ingress controller to control communication between
96
96
max-width="100%"
97
97
%}
98
98
99
-
#### Ingress-less hybrid runtime architecture
100
-
Ingress-less runtimes uses tunneling to control communication between the Codefresh Runtime in the customer cluster and the Codefresh Platform. Ingress-less runtimes are optimal when the cluster with the Codefresh Runtime is not exposed to the internet.
99
+
#### Tunnel-based hybrid runtime architecture
100
+
Tunnel-based hybrid runtimes use tunneling instead of ingress controllers to control communication between the Codefresh Runtime in the customer cluster and the Codefresh Platform. Tunnel-based, ingress-less, runtimes are optimal when the cluster with the Codefresh Runtime is not exposed to the internet.
@@ -114,7 +114,7 @@ Ingress-less runtimes uses tunneling to control communication between the Codefr
114
114
#### Codefresh Application Proxy
115
115
The Codefresh Application Proxy (App-Proxy) functions as the Codefresh agent, and is deployed as a service in the Codefresh Runtime.
116
116
For hybrid runtimes with ingress, the App-Proxy is the single point-of-contact between the Codefresh Runtime, and the Codefresh Clients, the Codefresh Platform, and any organizational systems in the customer environment.
117
-
For ingress-less hybrid runtimes, the Tunnel Client forwards the incoming traffic from the Tunnel Server using internal reverse proxy to the App-Proxy.
117
+
For tunnel-based hybrid runtimes, the Tunnel Client forwards the incoming traffic from the Tunnel Server using the Request Routing Service to the App-Proxy.
118
118
119
119
The App-Proxy:
120
120
* Accepts and serves requests from Codefresh Clients either via the Codefresh UI or CLI
@@ -142,14 +142,14 @@ The Argo Project includes:
142
142
143
143
#### Request Routing Service
144
144
The Request Routing Service is installed on the same cluster as the Codefresh Runtime in the customer environment.
145
-
It receives requests from the ingress controller (ingress) or the Tunnel Client (ingress-less), and forwards the request URLs to the Application Proxy, and webhooks directly to the Event Sources.
145
+
It receives requests from the ingress controller (ingress) or the Tunnel Client (tunnel-based), and forwards the request URLs to the Application Proxy, and webhooks directly to the Event Sources.
146
146
147
147
>Important:
148
148
The Request Routing Service is available from runtime version 0.0.543 and higher.
149
149
Older runtime versions are not affected as there is complete backward compatibility, and the ingress controller continues to route incoming requests.
150
150
151
151
#### Tunnel Server
152
-
Applies only to _ingress-less_ runtimes in hybrid installation environments.
152
+
Applies only to _tunnel-based_ runtimes in hybrid installation environments.
153
153
The Codefresh Tunnel Server is installed in the Codefresh platform. It communicates with the enterprise cluster located behind a NAT or firewall.
154
154
155
155
The Tunnel Server:
@@ -162,7 +162,7 @@ The Tunnel Server:
162
162
{:/}
163
163
164
164
#### Tunnel Client
165
-
Applies only to _ingress-less_ runtimes in hybrid installation environments.
165
+
Applies only to _tunnel-based_ runtimes in hybrid installation environments.
166
166
167
167
Installed on the same cluster as the Codefresh Runtime, the Codefresh Tunnel Client establishes the tunneling connection to the Codefresh Tunnel Server via the WebSocket Secure (WSS) protocol.
168
168
A single Codefresh Runtime can have a single Tunnel Client.
@@ -188,7 +188,7 @@ The customer environment that communicates with the Codefresh Runtime and the Co
188
188
See [Add external clusters to runtimes]({{site.baseurl}}/docs/runtime/managed-cluster/).
189
189
* Organizational systems
190
190
Organizational Systems include the customer's tracking, monitoring, notification, container registries, Git providers, and other systems. They can be entirely on-premises or in the public cloud.
191
-
Either the ingress controller (ingress hybrid environments), or the Tunnel Client (ingress-less hybrid environments), forwards incoming events to the Codefresh Application Proxy.
191
+
Either the ingress controller (ingress hybrid environments), or the Tunnel Client (tunnel-based hybrid environments), forwards incoming events to the Codefresh Application Proxy.
192
192
193
193
### Related articles
194
194
[Set up a hosted runtime environment]({{site.baseurl}}/docs/runtime/hosted-runtime/)
Copy file name to clipboardExpand all lines: _docs/runtime/installation.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,13 +77,13 @@ The Git repository per runtime account with shared configuration manifests.
77
77
</br>
78
78
{:/}
79
79
80
-
#### Ingress-less flags
80
+
#### Tunnel-based (ingress-less) runtime flags
81
81
These flags are required to install the runtime without an ingress controller.
82
82
83
83
**Access mode**
84
84
Required.
85
85
86
-
The access mode for ingress-less runtimes, the tunnel mode.
86
+
The access mode for tunnel-based runtimes, the tunnel mode.
87
87
88
88
89
89
* CLI wizard and Silent install: Add the flag, `--access-mode`, and define `tunnel` as the value.
@@ -93,7 +93,7 @@ The access mode for ingress-less runtimes, the tunnel mode.
93
93
94
94
Optional.
95
95
96
-
The allowed list of IPs from which to forward requests to the internal customer cluster for ingress-less runtime installations. The allowlist can include IPv4 and IPv6 addresses, with/without subnet and subnet masks. Multiple IPs must be separated by commas.
96
+
The allowed list of IPs from which to forward requests to the internal customer cluster for tunnel-based runtime installations. The allowlist can include IPv4 and IPv6 addresses, with/without subnet and subnet masks. Multiple IPs must be separated by commas.
97
97
98
98
When omitted, all incoming requests are authenticated regardless of the IPs from which they originated.
0 commit comments