Skip to content

Commit 66c3159

Browse files
authored
Update with title change (#266)
* Update with title change Changed ingress-less to tunnel-based * Update architecture.md
1 parent da66807 commit 66c3159

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

_docs/getting-started/architecture.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ The sections that follow show detailed views of runtime architecture in the diff
5858
In this installation environment, the Codefresh Runtime is installed on a _Codefresh-managed cluster_ in the Codefresh platform.
5959
* Hybrid runtime architecture:
6060
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:
61-
* [Ingress controller](#ingress-controller-hybrid-runtime-architecture)
62-
* [Ingress-less](#ingress-less-hybrid-runtime-architecture)
61+
* [Ingress-based](#ingress-based-hybrid-runtime-architecture)
62+
* [Tunnel-based](#tunnel-based-hybrid-runtime-architecture)
6363
* Runtime components
6464
* [Codefresh Application Proxy](#codefresh-application-proxy)
6565
* [Argo Project](#argo-project)
@@ -81,8 +81,8 @@ In the hosted environment, the Codefresh Runtime is installed on a K8s cluster m
8181
max-width="100%"
8282
%}
8383

84-
#### Ingress controller hybrid runtime architecture
85-
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.
8686

8787

8888

@@ -96,16 +96,16 @@ Runtimes with ingress use an ingress controller to control communication between
9696
max-width="100%"
9797
%}
9898

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

102102
{% include
103103
image.html
104104
lightbox="true"
105105
file="/images/getting-started/architecture/arch-hybrid-ingressless.png"
106106
url="/images/getting-started/architecture/arch-hybrid-ingressless.png"
107-
alt="Ingress-less hybrid runtime architecture"
108-
caption="Ingress-less hybrid runtime architecture"
107+
alt="Tunnel-based hybrid runtime architecture"
108+
caption="Tunnel-based hybrid runtime architecture"
109109
max-width="100%"
110110
%}
111111

@@ -114,7 +114,7 @@ Ingress-less runtimes uses tunneling to control communication between the Codefr
114114
#### Codefresh Application Proxy
115115
The Codefresh Application Proxy (App-Proxy) functions as the Codefresh agent, and is deployed as a service in the Codefresh Runtime.
116116
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.
118118

119119
The App-Proxy:
120120
* Accepts and serves requests from Codefresh Clients either via the Codefresh UI or CLI
@@ -142,14 +142,14 @@ The Argo Project includes:
142142

143143
#### Request Routing Service
144144
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.
146146

147147
>Important:
148148
The Request Routing Service is available from runtime version 0.0.543 and higher.
149149
Older runtime versions are not affected as there is complete backward compatibility, and the ingress controller continues to route incoming requests.
150150

151151
#### Tunnel Server
152-
Applies only to _ingress-less_ runtimes in hybrid installation environments.
152+
Applies only to _tunnel-based_ runtimes in hybrid installation environments.
153153
The Codefresh Tunnel Server is installed in the Codefresh platform. It communicates with the enterprise cluster located behind a NAT or firewall.
154154

155155
The Tunnel Server:
@@ -162,7 +162,7 @@ The Tunnel Server:
162162
{:/}
163163

164164
#### Tunnel Client
165-
Applies only to _ingress-less_ runtimes in hybrid installation environments.
165+
Applies only to _tunnel-based_ runtimes in hybrid installation environments.
166166

167167
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.
168168
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
188188
See [Add external clusters to runtimes]({{site.baseurl}}/docs/runtime/managed-cluster/).
189189
* Organizational systems
190190
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.
192192

193193
### Related articles
194194
[Set up a hosted runtime environment]({{site.baseurl}}/docs/runtime/hosted-runtime/)

_docs/runtime/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ The Git repository per runtime account with shared configuration manifests.
7777
</br>
7878
{:/}
7979

80-
#### Ingress-less flags
80+
#### Tunnel-based (ingress-less) runtime flags
8181
These flags are required to install the runtime without an ingress controller.
8282

8383
**Access mode**
8484
Required.
8585

86-
The access mode for ingress-less runtimes, the tunnel mode.
86+
The access mode for tunnel-based runtimes, the tunnel mode.
8787

8888

8989
* 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.
9393

9494
Optional.
9595

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

9898
When omitted, all incoming requests are authenticated regardless of the IPs from which they originated.
9999

0 commit comments

Comments
 (0)