Skip to content

Commit 99984d6

Browse files
authored
Add runner architecture diagram (#857)
* Add runner architecture diagram Added diagram for runner architecture * Update runtime-architecture.md
1 parent 301b61e commit 99984d6

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

_docs/installation/runtime-architecture.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Depending on the type of GitOps installation, the GitOps Runtime is installed ei
3636
### Codefresh Runner
3737
The Codefresh Runner, also known as the Agent, enables running Codefresh pipeline builds in the customer's environment. It provides a way to run pipeline builds, tests, and deployments within your private network or on-premises environment by making API calls to the Codefresh platform.
3838

39+
See [Codefresh Runner architecture](#codefresh-runner-architecture) in this article. Read more about how it works in [Runner behind firewalls]({{site.baseurl}}/docs/installation/behind-the-firewall/).
40+
3941
### GitOps Clients
4042

4143
GitOps Clients include the UI and the GitOps CLI.
@@ -66,7 +68,7 @@ max-width="100%"
6668
#### Codefresh Runner
6769
The Codefresh Runner can be installed on the same cluster as the On-Premises platform or on a remote cluster. It provides a way to run pipeline builds, tests, and deployments within your private network or on-premises environment by making API calls to the Codefresh platform.
6870

69-
Read more about how it works in [Runner behind firewalls]({{site.baseurl}}/docs/installation/behind-the-firewall/).
71+
See [Codefresh Runner architecture](#codefresh-runner-architecture) in this article. Read more about how it works in [Runner behind firewalls]({{site.baseurl}}/docs/installation/behind-the-firewall/).
7072

7173
<br>
7274

@@ -196,9 +198,18 @@ Each microservice within the Codefresh Pipeline and GitOps modules has its own d
196198

197199

198200
## Codefresh Runner architecture
199-
<!--- This section shows a detailed view of the Codefresh Runner architecture, and a description of the components. See also [Runner installation behind firewalls]({{site.baseurl}}/docs/installation/behind-the-firewall/). -->
201+
The diagram shows a high-level view of the Codefresh Runner and its components. See also [Runner installation behind firewalls]({{site.baseurl}}/docs/installation/behind-the-firewall/).
200202

201203

204+
{% include
205+
image.html
206+
lightbox="true"
207+
file="/images/runtime/architecture/arch-runner.png"
208+
url="/images/runtime/architecture/arch-runner.png"
209+
alt="Codefresh Runner architecture"
210+
caption="Codefresh Runner architecture"
211+
max-width="80%"
212+
%}
202213

203214

204215
The Codefresh Runner includes two main components:
@@ -238,9 +249,10 @@ Optional. When installed, provides visibility on cluster resources in Codefresh,
238249
Another optional component, the App-Proxy serves as an extension to the Codefresh platform. Its purpose is to enable remote operations, such as displaying Git repositories for Git providers behind firewalls and creating webhooks, while maintaining security.
239250

240251

241-
### Clients
252+
<!--- ### Clients
242253
243254
Codefresh offers a [public API]({{site.baseurl}}/docs/integrations/codefresh-api/), consumed both by the Web user interface and the [Codefresh CLI](https://codefresh-io.github.io/cli/){:target="\_blank"}. The API is also available for any custom integration with external tools or services.
255+
-->
244256

245257

246258

94 KB
Loading

0 commit comments

Comments
 (0)