Skip to content

Commit 42b24fb

Browse files
authored
Minor edits (#788)
1 parent 6a67590 commit 42b24fb

File tree

2 files changed

+24
-18
lines changed

2 files changed

+24
-18
lines changed

_docs/installation/gitops/on-prem-gitops-runtime-install.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ toc: true
77

88
Install the GitOps Runtime in your on-premises environments with Helm to create and manage Argo CD applications and deployments.
99

10+
>**NOTE**:
11+
Tunnel-based access mode is not supported for GitOps on-premises installations.
12+
1013

1114
## Install GitOps Runtime on-premises
1215

_docs/installation/runtime-architecture.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Architecture"
3-
description: "Codefresh platform and runtime architecture"
3+
description: "Codefresh platform and Runtime architecture"
44
group: installation
55
toc: true
66
---
@@ -38,8 +38,8 @@ Depending on the type of GitOps installation, the GitOps Runtime is installed ei
3838
### GitOps Clients
3939

4040
GitOps Clients include the UI and the GitOps CLI.
41-
The UI provides a unified, enterprise-wide view of deployments (runtimes, clusters, and applications), and CI/CD operations (Delivery Pipelines, workflows, and deployments) in the same location.
42-
The Codefresh CLI includes commands to install hybrid runtimes, add external clusters, and manage runtimes and clusters.
41+
The UI provides a unified, enterprise-wide view of deployments (Runtimes, clusters, and applications), and CI/CD operations (Delivery Pipelines, workflows, and deployments) in the same location.
42+
The Codefresh CLI includes commands to install Hybrid GitOps Runtimes, add external clusters, and manage Runtimes and clusters.
4343

4444
## Codefresh on-premises platform architecture
4545

@@ -212,9 +212,9 @@ See [Runner installation behind firewalls]({{site.baseurl}}/docs/installation/be
212212
## GitOps Runtime architecture
213213
The sections that follow show detailed views of the GitOps Runtime architecture for the different installation options, and descriptions of the GitOps Runtime components.
214214

215-
* [Hosted GitOps runtime architecture](#hosted-gitops-runtime-architecture)
215+
* [Hosted GitOps Runtime architecture](#hosted-gitops-runtime-architecture)
216216
For Hosted GitOps, the GitOps Runtime is installed on a _Codefresh-managed cluster_ in the Codefresh platform.
217-
* Hybrid GitOps runtime architecture:
217+
* Hybrid GitOps Runtime architecture:
218218
For Hybrid GitOps, the GitOps Runtime is installed on a _customer-managed cluster_ in the customer environment. The Hybrid GitOps Runtime can be tunnel- or ingress-based:
219219
* [Tunnel-based](#tunnel-based-hybrid-gitops-runtime-architecture)
220220
* [Ingress-based](#ingress-based-hybrid-gitops-runtime-architecture)
@@ -227,7 +227,7 @@ The sections that follow show detailed views of the GitOps Runtime architecture
227227

228228
<br>
229229

230-
### Hosted GitOps runtime architecture
230+
### Hosted GitOps Runtime architecture
231231
In the hosted environment, the Codefresh Runtime is installed on a K8s cluster managed by Codefresh.
232232

233233
{% include
@@ -240,8 +240,11 @@ In the hosted environment, the Codefresh Runtime is installed on a K8s cluster m
240240
max-width="100%"
241241
%}
242242

243-
### Tunnel-based Hybrid GitOps runtime architecture
244-
Tunnel-based Hybrid GitOps runtimes use tunneling instead of ingress controllers to control communication between the GitOps Runtime in the customer cluster and the Codefresh GitOps Platform. Tunnel-based runtimes are optimal when the cluster with the GitOps Runtime is not exposed to the internet.
243+
### Tunnel-based Hybrid GitOps Runtime architecture
244+
Tunnel-based Hybrid GitOps Runtimes use tunneling instead of ingress controllers to control communication between the GitOps Runtime in the customer cluster and the Codefresh GitOps Platform. Tunnel-based runtimes are optimal when the cluster with the GitOps Runtime is not exposed to the internet.
245+
246+
>**NOTE**:
247+
Tunnel-based access mode is not supported for GitOps on-premises installations.
245248

246249
Note: Tunnel-based architecture is not supported for on-prem instances.
247250

@@ -256,8 +259,8 @@ Note: Tunnel-based architecture is not supported for on-prem instances.
256259
%}
257260

258261

259-
### Ingress-based Hybrid GitOps runtime architecture
260-
Ingress-based runtimes use ingress controllers to control communication between the GitOps Runtime in the customer cluster and the Codefresh GitOps Platform. Ingress-based runtimes are optimal when the cluster with the GitOps Runtime is exposed to the internet.
262+
### Ingress-based Hybrid GitOps Runtime architecture
263+
Ingress-based Runtimes use ingress controllers to control communication between the GitOps Runtime in the customer cluster and the Codefresh GitOps Platform. Ingress-based Runtimes are optimal when the cluster with the GitOps Runtime is exposed to the internet.
261264

262265

263266

@@ -266,8 +269,8 @@ Ingress-based runtimes use ingress controllers to control communication between
266269
lightbox="true"
267270
file="/images/runtime/architecture/arch-hybrid-ingress.png"
268271
url="/images/runtime/architecture/arch-hybrid-ingress.png"
269-
alt="Ingress-based Hybrid GitOps runtime architecture"
270-
caption="Ingress-based Hybrid GitOps runtime architecture"
272+
alt="Ingress-based Hybrid GitOps Runtime architecture"
273+
caption="Ingress-based Hybrid GitOps Runtime architecture"
271274
max-width="100%"
272275
%}
273276

@@ -307,8 +310,8 @@ The Request Routing Service is installed on the same cluster as the GitOps Runti
307310
It receives requests from the the Tunnel Client (tunnel-based) or the ingress controller (ingress-based), and forwards the request URLs to the Application Proxy, and webhooks directly to the Event Sources.
308311

309312
>Important:
310-
The Request Routing Service is available from runtime version 0.0.543 and higher.
311-
Older runtime versions are not affected as there is complete backward compatibility, and the ingress controller continues to route incoming requests.
313+
The Request Routing Service is available from Runtime version 0.0.543 and higher.
314+
Older Runtime versions are not affected as there is complete backward compatibility, and the ingress controller continues to route incoming requests.
312315

313316
### Tunnel Server
314317
Applies only to _tunnel-based_ Hybrid GitOps Runtimes.
@@ -335,14 +338,14 @@ The Tunnel Client:
335338

336339
### Customer environment
337340
The customer environment that communicates with the GitOps Runtime and Codefresh, generally includes:
338-
* Ingress controller for ingress-based Hybrid runtimes
341+
* Ingress controller for ingress-based Hybrid GitOps Runtimes
339342
The ingress controller is configured on the same Kubernetes cluster as the GitOps Runtime, and implements the ingress traffic rules for the GitOps Runtime.
340343
See [Ingress controller requirements]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#ingress-controller).
341344
* Managed clusters
342-
Managed clusters are external clusters registered to provisioned Hosted or Hybrid GitOps runtimes for application deployment.
345+
Managed clusters are external clusters registered to provisioned Hosted or Hybrid GitOps Runtimes for application deployment.
343346
Hosted GitOps requires you to connect at least one external K8s cluster as part of setting up the Hosted GitOps environment.
344-
Hybrid GitOps allow you to add external clusters after provisioning the runtimes.
345-
See [Add external clusters to runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/).
347+
Hybrid GitOps allow you to add external clusters after provisioning the Runtimes.
348+
See [Add external clusters to Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/).
346349
* Organizational systems
347350
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.
348351
Either the ingress controller (ingress hybrid environments), or the Tunnel Client (tunnel-based hybrid environments), forwards incoming events to the GitOps Application Proxy.

0 commit comments

Comments
 (0)