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/installation/gitops/hosted-runtime.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,24 +10,15 @@ toc: true
10
10
11
11
Set up your environment with the Hosted GitOps Runtime to leverage Codefresh GitOps capabilities.
12
12
13
-
>**IMPORTANT**:
14
-
Codefresh is responsible for the _availability of Hosted GitOps Runtimes_.<br>
15
-
The Argo CD applications created in Hosted GitOps Runtimes are the customer's responsibility. Codefresh Support is happy to assist as needed.
16
-
17
13
18
14
## System requirements for Hosted GitOps Runtimes
19
15
20
16
{: .table .table-bordered .table-hover}
21
17
| Item | Requirement |
22
18
| -------------- | -------------- |
23
-
|Kubernetes cluster | Server version 1.18|
24
-
|Target Kubernetes clusters | {::nomarkdown} <ul><li>At least one target cluster to which to deploy Argo CD applications. <br>The actual number of target clusters depends on package sizing.</li><li>Must have public access from Internet</li></ul>{:/}|
25
-
|Argo CD managed CRDs (Custom Resource Definitions) | Between 300 and 400 CRDs |
For a comparison between Hosted and Hybrid GitOps Runtimes, see [Hosted vs. Hybrid GitOps]({{site.baseurl}}/docs/installation/installation-options/#hosted-vshybrid-gitops).
31
22
32
23
## Where to start with Hosted GitOps Runtimes
33
24
If you have not provisioned a Hosted GitOps Runtime, Codefresh presents you with the setup instructions in the **Home** dashboard.
@@ -145,7 +136,7 @@ max-width="70%"
145
136
Connect your Hosted GitOps Runtime to a Git provider for Codefresh to create the required Git repos.
146
137
147
138
**Authorize access**
148
-
Based on the Git provider you select, you need to authorize access through OAuth or an access token, and then select the Git organizations or accounts in which to create the required Git repos.
139
+
Based on the Git provider you select, you need to authorize access through OAuth or access token, and then select the Git organizations or accounts in which to create the required Git repos.
149
140
150
141
**Git organizations/accounts**
151
142
Only authorized organizations are displayed in the list. To authorize organizations for the Codefresh application in GitHub, see [Authorize organizations/projects]({{site.baseurl}}/docs/administration/account-user-management/hosted-authorize-orgs/).
Copy file name to clipboardExpand all lines: _docs/installation/gitops/hybrid-gitops-helm-installation.md
+3-8Lines changed: 3 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,8 @@ We have transitioned to a Helm-based installation for Hybrid GitOps Runtimes for
12
12
The CLI-based installation for Hybrid GitOps is considered legacy. We will deprecate this installation mode permanently in the coming months.<br>
13
13
You can migrate existing CLI-based GitOps Runtimes to Helm-based ones, as described in [Migrating GitOps Runtimes from CLI to Helm]({{site.baseurl}}/docs/installation/gitops/migrate-cli-runtimes-helm/).
14
14
15
-
This article walks you through the process of installing Hybrid GitOps Runtimes in your Codefresh accounts using Helm charts. You can install a single GitOps Runtime on a cluster. To install additional Runtimes in the same account, each account must be on a different cluster. Every Runtime within your account must have a unique name.
16
-
17
-
For Hosted GitOps Runtimes, see [Hosted GitOps Runtime Setup]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
18
15
16
+
This article walks you through the process of installing Hybrid GitOps Runtimes in your Codefresh accounts using Helm charts. You can install a single GitOps Runtime on a cluster. To install additional Runtimes in the same account, each account must be on a different cluster. Every Runtime within your account must have a unique name.
19
17
20
18
**Installation options for GitOps Runtimes**
21
19
There are two options for Hybrid GitOps Runtime installation via Helm, each catering to specific use cases:
@@ -44,8 +42,7 @@ Choose the installation option that best aligns with your specific requirements
44
42
***Additional GitOps Runtime installation**
45
43
If you have already installed a GitOps Runtime in your account and want to install additional Runtimes on different clusters within the same account, you can continue with a [simplified installation](#install-additional-gitops-runtimes-in-account) from the Codefresh UI, or use [Terraform](/install-gitops-runtime-via-terraform).
46
44
When installing additional GitOps Runtimes, Git provider, Shared Configuration Repository, and the repository for the Helm chart, for example, are not required, as they have been already set up for your account.
47
-
48
-
45
+
49
46
>**ArgoCD password WARNING**:
50
47
Avoid changing the Argo CD password using the `argocd-initial-admin-secret` via the Argo CD UI. Doing so can cause system instability and disrupt the Codefresh platform.
51
48
@@ -939,8 +936,6 @@ You can [monitor]({{site.baseurl}}/docs/deployments/gitops/applications-dashboar
| |Git user token:{::nomarkdown}<ul><li>Valid expiration date</li><li><a href="https://codefresh.io/docs/docs/reference/git-tokens/#git-user-access-token-scopes">Scopes</a> </li></ul>{:/}|
941
938
942
-
For a comparison between Hosted and Hybrid GitOps Runtimes, see [Hosted vs. hybrid GitOps]({{site.baseurl}}/docs/installation/installation-options/#hosted-vshybrid-gitops).
943
-
944
939
945
940
## Ingress controller configuration
946
941
@@ -1646,4 +1641,4 @@ providers:
1646
1641
[Add Git Sources to GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
1647
1642
[Add external clusters to GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
The Codefresh platform supports different installation options for Codefresh pipelines and Codefresh GitOps, all compliant with [SOC2 - Type2](https://us.aicpa.org/interestareas/frc/assuranceadvisoryservices/aicpasoc2report){:target="\_blank"}.
10
+
The Codefresh platform supports three different installation options, all compliant with [SOC2 - Type2](https://us.aicpa.org/interestareas/frc/assuranceadvisoryservices/aicpasoc2report){:target="\_blank"}.
11
11
12
12
{% include image.html
13
13
lightbox="true"
@@ -18,7 +18,7 @@ The Codefresh platform supports different installation options for Codefresh pip
18
18
%}
19
19
20
20
21
-
**Codefresh pipeline installation options**
21
+
22
22
***Hybrid Runner**
23
23
The Runner installation is the hybrid installation mode for Codefresh pipelines. The Codefresh UI runs in the Codefresh cloud, and the builds run on customer premises. The Runner combines flexibility with security, and is optimal for Enterprise customers looking for a "behind-the-firewall" solution.
24
24
See [Hybrid Runner](#hybrid-runner).
@@ -27,19 +27,19 @@ The Codefresh platform supports different installation options for Codefresh pip
27
27
***On-Premises**
28
28
On-Premises installation is for customers who want full control over their environments. Both the UI and the builds run on the Kubernetes cluster in an environment fully managed by you as our customer.
29
29
30
-
While Codefresh can still help with maintenance of the On-Premises platform, we would recommend the Hybrid Runner installation for Codefresh piplines as it combines flexibility without compromising on security.
30
+
While Codefresh can still help with maintenance of the On-Premises platform, we would recommend the Hybrid Runner as it combines flexibility without compromising on security.
31
31
See [On-premises](#on-premises).
32
32
33
-
**Codefresh GitOps installation options**
34
33
35
-
GitOps is a full-featured solution for application deployments and releases powered by the Argo Project. Codefresh uses Argo CD, Argo Workflows, Argo Events, and Argo Rollouts, extended with unique functionality and features essential for enterprise deployments.
34
+
***GitOps**
35
+
GitOps installation is a full-featured solution for application deployments and releases powered by the Argo Project. Codefresh uses Argo CD, Argo Workflows, Argo Events, and Argo Rollouts, extended with unique functionality and features essential for enterprise deployments.
36
+
37
+
GitOps installations support Hosted and Hybrid options.
38
+
See [GitOps](#gitops).
36
39
37
-
GitOps supports Hosted and Hybrid Runtime installation options.
38
-
See [GitOps](#gitops).
39
40
40
-
## Codefresh pipelines
41
+
## Note on Cloud Builds for Codefresh pipelines
41
42
42
-
### Note on Cloud Builds for Codefresh pipelines
43
43
44
44
Cloud Builds for Codefresh pipelines are disabled for all accounts by default.
45
45
Account admins can request Codefresh to enable Cloud Builds for an account. There is no manual action required except to click on the Enable Cloud Builds button as shown below. The timeframe for the response is up to 24 hours.<br>
@@ -60,7 +60,7 @@ If you [create a free account]({{site.baseurl}}/docs/quick-start/create-codefres
60
60
61
61
62
62
63
-
###Hybrid Runner
63
+
## Hybrid Runner
64
64
65
65
The Hybrid Runner installation is for organizations who want their source code to live within their premises, or have other security constraints. For implementation details, see [[Runner installation behind firewalls]({{site.baseurl}}/docs/installation/behind-the-firewall).
66
66
The UI runs on Codefresh infrastructure, while the builds happen in a Kubernetes cluster in the customer's premises.
@@ -112,21 +112,21 @@ The table lists the security implications of Hybrid Runner installation.
112
112
113
113
114
114
115
-
###On-premises
115
+
## On-premises
116
116
117
-
For customers who want full control over Codefresh pipelines, Codefresh also offers on-premises installation option. Both the UI and builds run on a Kubernetes cluster fully managed by the customer.
117
+
For customers who want full control, Codefresh also offers on-premises installation. Both the UI and builds run on a Kubernetes cluster fully managed by the customer.
118
118
119
119
See [Codefresh On-Prem Installation & Configuration]({{site.baseurl}}/docs/installation/codefresh-on-prem).
120
120
121
121
122
-
## Codefresh GitOps
122
+
## GitOps
123
123
124
-
Codefresh GitOps supports SaaS and hybrid installation options for GitOps Runtimes. For the main differences between Hosted and Hybrid GitOps, see [Hosted vs. Hybird GitOps]({{site.baseurl}}/docs/installation/installation-options/#hosted-vshybrid-gitops).
124
+
Codefresh GitOps also supports SaaS and hybrid installation options:
125
125
126
126
127
-
### Hosted GitOps Runtimes
127
+
### Hosted GitOps
128
128
The SaaS version of GitOps, Hosted GitOps has Argo CD installed in the Codefresh cluster.
129
-
The Hosted GitOps Runtime is installed and provisioned on a Codefresh cluster, and managed by Codefresh.
129
+
Hosted GitOps Runtime is installed and provisioned in a Codefresh cluster, and managed by Codefresh.
130
130
Hosted environments are full-cloud environments, where all updates and improvements are managed by Codefresh, with zero-maintenance overhead for you as the customer.
131
131
Currently, you can add one Hosted GitOps Runtime per account.
132
132
For the architecture, see [Hosted GitOps Runtime architecture]({{site.baseurl}}/docs/installation/runtime-architecture/).
@@ -146,8 +146,8 @@ For the architecture, see [Hosted GitOps Runtime architecture]({{site.baseurl}}/
146
146
147
147
### Hybrid GitOps
148
148
The hybrid version of GitOps, has Argo CD installed in the customer's cluster.
149
-
The Hybrid GitOps Runtime is installed in the customer's cluster, and managed by the customer.
150
-
Hybrid GitOps is optimal for organizations with security constraints, wanting to manage CI/CD operations within their premises. Hybrid GitOps strikes the perfect balance between security, flexibility, and ease of use. Codefresh maintains and manages most aspects of the platform, apart from installing and upgrading Hybrid GitOps Runtimes which are managed by the customer.
149
+
Hybrid GitOps is installed in the customer's cluster, and managed by the customer.
150
+
The Hybrid GitOps Runtime is optimal for organizations with security constraints, wanting to manage CI/CD operations within their premises. Hybrid GitOps strikes the perfect balance between security, flexibility, and ease of use. Codefresh maintains and manages most aspects of the platform, apart from installing and upgrading Hybrid GitOps Runtimes which are managed by the customer.
151
151
152
152
153
153
{% include
@@ -160,7 +160,7 @@ Hybrid GitOps is optimal for organizations with security constraints, wanting to
160
160
max-width="70%"
161
161
%}
162
162
163
-
For more information on Hybrid GitOps, see [Hybrid GitOps Runtime requirements]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/#minimum-system-requirements) and [Hybrid GitOps Runtime Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).
163
+
For more information on Hybrid GitOps, see [Hybrid GitOps Runtime requirements]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/#minimum-system-requirements) and [Hybrid GitOps Runtime Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).
164
164
165
165
166
166
@@ -177,43 +177,37 @@ The runtime:
177
177
* Receives events and information from the user's organization systems to execute workflows
178
178
By default, the ingress controller directs all requests and events to the Codefresh Application Proxy. When internal and an external ingress hosts are configured, the ingress comtroller directs webhook events to the relevant Event Source and then to Argo Events (not via the Codefresh Application Proxy). -->
179
179
180
-
### Hosted vs.Hybrid GitOps Runtimes
180
+
### Hosted vs.Hybrid GitOps
181
181
182
-
The table below highlights the main differences in functionality and resources between Hosted and Hybrid GitOps.
182
+
The table below highlights the main differences between Hosted and Hybrid GitOps.
| Runtime | Installation | Provisioned by Codefresh | Provisioned by customer |
188
188
|| Runtime cluster | Managed by Codefresh | Managed by customer |
189
-
|| Number per account | One Runtime| Multiple Runtimes, one per cluster |
190
-
||Target cluster | {::nomarkdown}<ul><li>Managed by customer</li><li>Number supported depends on package size and can range from 5 to 20 or higher</li><li>Network access: Public access from internet</li></ul>{:/} | {::nomarkdown}<ul><li>Managed by customer</li><li>Any number</li><li>Network access: Public or private access</li></ul>{:/}|
189
+
|| Number per account | One runtime| Multiple runtimes, one per cluster |
190
+
||External cluster |Managed by customer|Managed by customer|
191
191
|| Upgrade | Managed by Codefresh | Managed by customer |
192
192
|| Uninstall | Managed by customer | Managed by customer |
193
-
|Resources |Argo CD managed CRDs (Custom Resource Definitions)| Between 300 and 400 CRDs |Unlimited |
194
-
||Mono Git repo for manifests | Max size up to 100MB | Unlimited |
||Workflow Templates | Not supported | Supported |
200
-
| CD Ops |Applications |{::nomarkdown}<ul><li>Deployment supported only on target clusters</li><li>Self-healing interval: 90 seconds<br>See <ahref="https://argo-cd.readthedocs.io/en/stable/user-guide/auto_sync/#automatic-self-healing">Argo CD automatic self-healing</a></li></ul> {:/} | {::nomarkdown}<ul><li>Deployment supported on both in-cluster and target clusters</li><li>Self-healing interval: 5 seconds (Argo CD default)<br>See <ahref="https://argo-cd.readthedocs.io/en/stable/user-guide/auto_sync/#automatic-self-healing">Argo CD automatic self-healing</a></li></ul> {:/}|
0 commit comments