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
+33-14Lines changed: 33 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,31 +8,48 @@ toc: true
8
8
9
9
10
10
11
-
For GitOps, Codefresh offers the option of installing Hosted and Hybrid GitOps Runtimes. Hosted GitOps Runtimes are fully managed and maintained by Codefresh. For a comparison, see[Hosted vs. Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/#hosted-vshybrid-gitops).
11
+
For GitOps, Codefresh offers the option of installing Hosted and Hybrid GitOps Runtimes.
12
+
Hosted GitOps Runtimes are fully managed and maintained by Codefresh.
13
+
14
+
This article describes how to install the Hosted GitOps Runtime to leverage GitOps capabilities.
15
+
16
+
17
+
For Hybrid GitOps Runtime installation, see[Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).
18
+
For a comparison between the two types of Runtime installations, see[Hosted vs. Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/#hosted-vshybrid-gitops).
19
+
20
+
{{site.data.callout.callout_warning}}
21
+
**IMPORTANT**
22
+
Codefresh is responsible for the_availability of Hosted GitOps Runtimes_.<br>
23
+
The Argo CD applications created in Hosted GitOps Runtimes are the customer's responsibility. Codefresh Support is happy to assist as needed.
24
+
{{site.data.callout.end}}
12
25
13
-
This article describes how to install the Hosted GitOps Runtime to leverage GitOps capabilities.<br>
14
-
For Hybrid GitOps Runtime installation, see[Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).
15
26
16
27
>**NOTE**
17
28
You can install a_single Hosted GitOps Runtime per Codefresh account_.
18
29
19
30
20
31
32
+
21
33
##System requirements for Hosted GitOps Runtimes
22
34
23
35
{: .table .table-bordered .table-hover}
24
36
| Item| Requirement|
25
37
| --------------| --------------|
26
-
|Kubernetes cluster| Server version 1.18 and higher to which to deploy applications|
|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>{:/}|
40
+
|Argo CD managed CRDs (Custom Resource Definitions)| Between 300 and 400 CRDs|
|CMP (Cloud Management Platform) plugins| Only for Enterprise customers|
28
44
45
+
For a comparison between Hosted and Hybrid GitOps Runtimes, see[Hosted vs. Hybrid GitOps]({{site.baseurl}}/docs/installation/installation-options/#hosted-vshybrid-gitops).
29
46
30
47
##Where to start with Hosted GitOps Runtimes
31
48
If you have not provisioned a Hosted GitOps Runtime, Codefresh presents you with the setup instructions in the**Home** dashboard.
32
49
33
50
34
51
35
-
* In the Codefresh UI, fromOPS in the sidebar, select[Home](https://g.codefresh.io/2.0/?time=LAST_7_DAYS){:target="\_blank"}.
52
+
* In the Codefresh UI, fromOps in the sidebar, select[Home](https://g.codefresh.io/2.0/?time=LAST_7_DAYS){:target="\_blank"}.
36
53
Codefresh guides you through the three-step setup, as described below.
37
54
38
55
{% include
@@ -116,7 +133,7 @@ max-width="70%"
116
133
Connect your Hosted GitOps Runtime to a Git provider for Codefresh to create the required Git repos.
117
134
118
135
**Authorize access**
119
-
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.
136
+
Based on the Git provider you select, you need to authorize access through OAuth oranaccess token, and then select the Git organizations or accounts in which to create the required Git repos.
120
137
121
138
**Git organizations/accounts**
122
139
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/).
@@ -239,7 +256,9 @@ max-width="70%"
239
256
#####Before you begin
240
257
* Make sure your cluster has internet access
241
258
242
-
#####How to
259
+
260
+
#####How to
261
+
243
262
1. Click**Connect**.
244
263
1. In the Add Managed Cluster panel, copy the command`cf cluster add`, and run it in the terminal.
245
264
1. When prompted to select the`kube-context`, select from the list of available clusters as defined in`kubeconfig`.
@@ -271,25 +290,25 @@ max-width="70%"
271
290
{:start="5"}
272
291
1. Configure access to the IP addresses required. See[Codefresh IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/).
273
292
274
-
<!-- If you could not connect a cluster, you may not have the latest version of the CLI:
275
-
[Upgrade the GitOps CLI]({{site.baseurl}}/docs/installation/gitops/upgrade-gitops-cli/).-->
293
+
276
294
277
295
You have completed setting up your Hosted GitOps Runtime. You are ready to create applications, and connect third-party CI tools for image enrichment.
278
296
279
-
##(Optional) Create application
280
-
Optional. Create an application in Codefresh, deploy it to the cluster, and track deployment and performance in the Applications dashboard.
297
+
##(Optional) Createan Argo CDapplication
298
+
Optional. Create anArgo CDapplication in Codefresh, deploy it to the cluster, and track deployment and performance in the Applications dashboard.
281
299
282
300
1. Follow our quick-start to create and deploy the`codefresh-guestbook` application. Start with[Create application resources]({{site.baseurl}}/docs/quick-start/gitops-quick-start/create-app-specs/).
283
301
OR
284
302
Create your own application. See[Create an application]({{site.baseurl}}/docs/deployments/gitops/create-application/).
285
303
286
304
{:start="2"}
287
-
2. In the Codefresh UI, view your application in the[Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}.
305
+
2. In the Codefresh UI, view your application in the[GitOps Apps dashboard](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}.
306
+
For more information, see[Monitoring Argo CD applications]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/).
288
307
289
308
##(Optional) Connect CI
290
309
Optional. Integrate Codefresh with the third-party tools you use for CI to enrich image information in deployments.
291
310
292
-
See[Image enrichment with integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/)
311
+
See[Image enrichment with integrations]({{site.baseurl}}/docs/gitops-integrations/image-enrichment-overview/).
Copy file name to clipboardExpand all lines: _docs/installation/gitops/hybrid-gitops-helm-installation.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,9 @@ You can migrate existing CLI-based GitOps Runtimes to Helm-based ones, as descri
16
16
17
17
For GitOps, Codefresh offers the option of installing Hosted and Hybrid GitOps Runtimes. For a comparison, see[Hosted vs. Hybrid GitOps]({{site.baseurl}}/docs/installation/gitops/#hosted-vshybrid-gitops).
18
18
19
-
This article walks you through the process of installing Hybrid GitOps Runtimes in your Codefresh accounts using Helm charts.
20
-
For Hosted GitOps Runtime installation, see[Hosted GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
19
+
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.
20
+
21
+
For Hosted GitOps Runtimes, see[Hosted GitOps Runtime Setup]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
21
22
22
23
#####Number of Hybrid GitOps Runtimes
23
24
Within the same account, you can install_one Hosted and one Hybrid GitOps Runtime on a cluster_.
@@ -50,6 +51,9 @@ Choose the installation option that best aligns with your specific requirements
50
51
***Additional GitOps Runtime installations**
51
52
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).
52
53
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.
54
+
55
+
56
+
53
57
54
58
{{site.data.callout.callout_warning}}
55
59
**ArgoCD password WARNING**
@@ -58,6 +62,7 @@ Choose the installation option that best aligns with your specific requirements
58
62
59
63
60
64
65
+
61
66
Terminology clarifications:
62
67
In the documentation, Hybrid GitOps Runtimes are also referred to as GitOps Runtimes.
63
68
@@ -950,6 +955,8 @@ 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/security/git-tokens/#git-user-access-token-scopes">Scopes</a> </li></ul>{:/}|
952
957
958
+
For a comparison between Hosted and Hybrid GitOps Runtimes, see [Hosted vs. hybrid GitOps]({{site.baseurl}}/docs/installation/installation-options/#hosted-vshybrid-gitops).
959
+
953
960
954
961
## Ingress controller configuration
955
962
@@ -1618,3 +1625,4 @@ providers:
1618
1625
[Managing external clusters in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/managed-cluster/)
Copy file name to clipboardExpand all lines: _docs/installation/installation-options.md
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ Read more on the platform architecture for [SaaS](#codefresh-saas-platform-archi
16
16
17
17
Both deployment options are compliant with[SOC2 - Type2](https://us.aicpa.org/interestareas/frc/assuranceadvisoryservices/aicpasoc2report){:target="\_blank"}.
@@ -28,6 +29,7 @@ Both deployment options are compliant with [SOC2 - Type2](https://us.aicpa.org/i
28
29
29
30
##Codefresh SaaS platform architecture
30
31
32
+
31
33
The diagram shows the high-level architecture for Codefresh SaaS deployment and its core components.
32
34
33
35
@@ -59,6 +61,7 @@ Managed clusters are external clusters added to provisioned GitOps Runtimes. You
59
61
60
62
61
63
64
+
62
65
###Codefresh Clients
63
66
64
67
Codefresh Clients include the UI and the CLI.
@@ -80,6 +83,8 @@ The CLI for Codefresh Pipelines can:
80
83
For installation instructions and CLI command descriptions, see the[CLI documentation](https://codefresh-io.github.io/cli/getting-started/){:target="\_blank"}.
81
84
82
85
86
+
87
+
83
88
##Codefresh on-premises platform architecture
84
89
85
90
The diagram shows a high-level view of the Codefresh on-premises deployment, and its core components.
@@ -96,6 +101,7 @@ max-width="100%"
96
101
97
102
98
103
104
+
99
105
###External components
100
106
101
107
@@ -143,11 +149,13 @@ The Pipelines API serves as the primary gateway for the Codefresh Pipelines modu
143
149
144
150
145
151
152
+
146
153
####Pipelines UI
147
154
The Pipelines UI acts as a static file server that hosts and delivers all the user interface pages for Codefresh Pipelines. It provides visualization of pipelines, builds, third-party integrations and more.
148
155
149
156
150
157
158
+
151
159
####GitOps API
152
160
The GitOps API serves as the primary gateway for the Codefresh GitOps module in the On-Premises platform. It interfaces between Codefresh GitOps, Git, and Argo CD, to sync
153
161
It utilizes a GraphQL interface to provide a user interface
@@ -158,7 +166,6 @@ It utilizes a GraphQL interface to provide a user interface
158
166
The GitOps UI provides a unified, enterprise-wide view of deployments, Runtimes, clusters, and applications in the same location.
159
167
160
168
161
-
162
169
####Pipelines
163
170
164
171
The Pipelines module comprises a set of microservices for managing Codefresh pipelines in the On-Premises platform.