Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitd358122

Browse files
authored
Install bucket refactor (#923)
* Restructure install bucket* Refactor installation & runtimeRestructure separating platform & runtime installation* Update install topics* Update structureAlign structure with nav yaml organization* Add redirects to install topics* Update content* Updates* Update xrefsUpdated xrefs according to new structure* Update home-content.ymlAligned topic titles with nav yaml* Reorganize runtime topicsMoved GitOps and Runner topics up one level, created separate topics for architectures runtime* Update arch diagrams* Fix links* Update installation-options.md* Update installation-options.md* Add diagram for app reporterAdded diagram and description of data flow for app event reporter* Update app reporter diagram* Update helm install image* Update hybrid-gitops-helm-installation.md* Update home-content.yml
1 parent0e6109d commitd358122

File tree

33 files changed

+877
-2187
lines changed

33 files changed

+877
-2187
lines changed

‎_data/home-content.yml‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -211,22 +211,20 @@
211211
icon:images/home-icons/runtimes.svg
212212
url:""
213213
links:
214-
-title:Installation options
214+
-title:Codefresh platform deployment
215215
localurl:/docs/installation/installation-options/
216-
-title:Codefresh Runner installation
217-
localurl:/docs/installation/codefresh-runner/
218-
-title:On-Premises platform installation
219-
localurl:/docs/installation/on-premises/codefresh-on-prem/
216+
-title:On-Premises platform installation & configuration
217+
localurl:/docs/installation/installation-options/on-premises/
220218
-title:On-Premises platform account & user setup
221-
localurl:/docs/installation/on-premises/on-prem-configuration/
219+
localurl:/docs/installation/installation-options/on-premises/on-prem-configuration/
222220
-title:On-Premises platform upgrade
223-
localurl:/docs/installation/on-premises/codefresh-on-prem-upgrade/
221+
localurl:/docs/installation/installation-options/on-premises/codefresh-on-prem-upgrade/
222+
-title:Codefresh Runner installation
223+
localurl:/docs/installation/runner/
224224
-title:Hosted GitOps Runtime installation
225225
localurl:/docs/installation/gitops/hosted-runtime/
226226
-title:Hybrid GitOps Runtime installation
227227
localurl:/docs/installation/gitops/hybrid-gitops-helm-installation/
228-
-title:On-premises GitOps Runtime installation
229-
localurl:/docs/installation/gitops/on-prem-gitops-runtime-install/
230228
-title:Migrate Hybrid GitOps Runtimes from CLI to Helm
231229
localurl:/docs/installation/gitops/migrate-cli-runtimes-helm/
232230

‎_data/nav.yml‎

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -490,28 +490,34 @@
490490
-title:Installation
491491
url:"/installation"
492492
pages:
493-
-title:Options
493+
-title:Platform deployment
494494
url:"/installation-options"
495-
-title:Architecture
496-
url:"/runtime-architecture"
497-
-title:Runner installation behind firewalls
498-
url:"/behind-the-firewall"
499-
-title:Runner
500-
url:"/codefresh-runner"
501-
-title:On-premises
502-
url:
503495
sub-pages:
504-
-title:Platform installation & configuration
505-
url:"/codefresh-on-prem"
506-
-title:Platform upgrade
507-
url:"/codefresh-on-prem-upgrade"
508-
-title:Account and user setup
509-
url:"/on-prem-configuration"
510-
-title:Feature management
511-
url:"/on-prem-feature-management"
512-
-title:GitOps
513-
url:
496+
-title:On-premises deployment
497+
url:"/on-premises"
498+
sub-pages:
499+
-title:Installation & configuration
500+
url:"/codefresh-on-prem"
501+
-title:Upgrade
502+
url:"/codefresh-on-prem-upgrade"
503+
-title:Account and user setup
504+
url:"/on-prem-configuration"
505+
-title:Feature management
506+
url:"/on-prem-feature-management"
507+
-title:Runner for pipelines
508+
url:"/runner"
509+
sub-pages:
510+
-title:Runner architecture
511+
url:"/runner-architecture"
512+
-title:Runner installation for pipelines
513+
url:"/install-codefresh-runner"
514+
-title:Runner installation behind firewalls
515+
url:"/behind-the-firewall"
516+
-title:GitOps Runtimes
517+
url:"/gitops"
514518
sub-pages:
519+
-title:GitOps Runtime architecture
520+
url:"/runtime-architecture"
515521
-title:Hosted GitOps Runtime
516522
url:"/hosted-runtime"
517523
-title:Hybrid GitOps Runtime
@@ -522,18 +528,15 @@
522528
url:"/on-prem-gitops-runtime-install"
523529
-title:Migrating Hybrid GitOps Runtimes from CLI to Helm
524530
url:"/migrate-cli-runtimes-helm"
525-
-title:Monitoring & managing GitOps Runtimes
526-
url:"/monitor-manage-runtimes"
527531
-title:Shared Configuration Repository
528532
url:"/shared-configuration"
533+
-title:Monitoring & managing GitOps Runtimes
534+
url:"/monitor-manage-runtimes"
529535
-title:Managing external clusters in GitOps Runtimes
530536
url:"/managed-cluster"
531537
-title:Managing Git Sources in GitOps Runtimes
532538
url:"/git-sources"
533-
-title:Download/upgrade GitOps CLI
534-
url:"/upgrade-gitops-cli"
535-
-title:CLI
536-
url:"/cli"
539+
537540

538541
-title:Administration
539542
url:"/administration"

‎_docs/installation/cli.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title:"CLI"
3-
description:"Run Codefresh pipelines in your own secure infrastructure"
3+
description:"Use the CLI to interact with Codefresh"
44
group:installation
55
toc:true
66
---
77

88
Codefresh has two different CLIs, one for Codefresh pipelines, and one for Codefresh GitOps.
99

10-
**Codefresh CLI**
10+
#####Codefresh CLI for pipelines
1111
Interact with Codefresh through the CLI and:
1212
* Perform any UI operation
1313
* Create complex automation from your local machine
@@ -17,9 +17,9 @@ For installation instructions and CLI command descriptions, see the [CLI documen
1717

1818
<br />
1919

20-
**GitOps CLI**
20+
#####GitOps CLI
2121
Keep up to date with the latest features through the GitOps CLI.
22-
The GitOps CLI is required to installGitOps runtimes. As several new features are available only with the latestGitOpsCLI release, it's important to have the latest one.
22+
The GitOps CLI is required to installthe Shared Configuration Repository forGitOpsruntimes.
2323
Upgrade is easy as you don't have to keep track of the different versions. The GitOps CLI automatically checks its own version and prints a banner if there is a newer version.
2424

2525
For details, see[Download/Upgrade the GitOps CLI]({{site.baseurl}}/docs/installation/gitops/upgrade-gitops-cli/).

‎_docs/installation/gitops.md‎

Lines changed: 79 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,87 @@
11
---
2-
title:"GitOpsinstallation"
3-
description:"Use GitOpswithCodefresh"
2+
title:"GitOpsRuntimes"
3+
description:" Create and deploy Argo CD applicationswithGitOps Runtimes"
44
group:installation
5+
redirect_from:
6+
-/docs/installation/gitops/
57
toc:true
68
---
79

8-
Codefresh supports several modes to work with GitOps applications:
910

10-
* The easiest way to get started is to use[a Hosted GitOps Runtime]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/)
11-
* Alternatively, you can install[a Hybrid GitOps Runtime]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/) in your own cluster
11+
The Codefresh GitOps module requires you to install GitOps Runtimes.
12+
13+
GitOps Runtimes are available as hosted Runtimes with Argo CD installed in the Codefresh cluster, and hybrid Runtimes with Argo CD installed in the customer's cluster. Review the[comparison](#hosted-vshybrid-gitops) between both Runtime modes.
14+
15+
16+
##Hosted GitOps
17+
The SaaS version of GitOps, Hosted GitOps has Argo CD installed in the Codefresh cluster.
18+
Hosted GitOps Runtime is installed and provisioned in a Codefresh cluster, and managed by Codefresh.
19+
Hosted environments are full-cloud environments, where all updates and improvements are managed by Codefresh, with zero-maintenance overhead for you as the customer.
20+
Currently, you can add one Hosted GitOps Runtime per account.
21+
For the architecture, see[Hosted GitOps Runtime architecture]({{site.baseurl}}/docs/installation/gitops/runtime-architecture/).
22+
23+
24+
{% include
25+
image.html
26+
lightbox="true"
27+
file="/images/runtime/hosted-gitops-initial-view.png"
28+
url="/images/runtime/hosted-gitops-initial-view.png"
29+
alt="Hosted GitOps runtime setup"
30+
caption="Hosted GitOps runtime setup"
31+
max-width="80%"
32+
%}
33+
34+
For more information on how to set up the hosted environment, including provisioning hosted runtimes, see[Set up Hosted GitOps]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
35+
36+
##Hybrid GitOps
37+
The hybrid version of GitOps, has Argo CD installed in the customer's cluster.
38+
Hybrid GitOps is installed in the customer's cluster, and managed by the customer.
39+
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.
40+
41+
42+
{% include
43+
image.html
44+
lightbox="true"
45+
file="/images/runtime/runtime-list-view.png"
46+
url="/images/runtime/runtime-list-view.png"
47+
alt="Runtime List View"
48+
caption="Runtime List View"
49+
max-width="70%"
50+
%}
51+
52+
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 installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).
53+
54+
55+
##Hosted vs.Hybrid GitOps
56+
57+
The table below highlights the main differences between Hosted and Hybrid GitOps.
58+
59+
{: .table .table-bordered .table-hover}
60+
| GitOps Functionality|Feature| Hosted| Hybrid|
61+
| --------------| --------------|---------------| ---------------|
62+
| Runtime| Installation| Provisioned by Codefresh| Provisioned by customer|
63+
|| Runtime cluster| Managed by Codefresh| Managed by customer|
64+
|| Number per account| One runtime| Multiple runtimes, one per cluster|
65+
|| External cluster| Managed by customer| Managed by customer|
66+
|| Upgrade| Managed by Codefresh| Managed by customer|
67+
|| Uninstall| Managed by customer| Managed by customer|
68+
| Argo CD|| Codefresh cluster| Customer cluster|
69+
| CI Ops| Delivery Pipelines|Not supported| Supported|
70+
||Workflows| Not supported| Supported|
71+
||Workflow Templates| Not supported| Supported|
72+
| CD Ops|Applications| Supported| Supported|
73+
||Image enrichment| Supported| Supported|
74+
|| Rollouts| Supported| Supported|
75+
|Integrations|| Supported| Supported|
76+
|Dashboards|Home| Hosted runtime and deployments|Runtimes, deployments, Delivery Pipelines|
77+
||DORA metrics| Supported|Supported|
78+
||Applications| Supported|Supported|
79+
80+
81+
##Related articles
82+
[Codefresh Runner for pipelines]({{site.baseurl}}/docs/installation/runner/)
83+
[Codefresh pricing](https://codefresh.io/pricing/){:target="\_blank"}
84+
[Codefresh features](https://codefresh.io/features/){:target="\_blank"}
85+
1286

13-
You can then manage and monitor the Runtimes by adding[external clusters]({{site.baseurl}}/docs/installation/gitops/managed-cluster/) and[Git Sources]({{site.baseurl}}/docs/installation/gitops/git-sources/).
1487

‎_docs/installation/gitops/argo-with-gitops-side-by-side.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ spec:
112112
113113
### Step 3: Commit Argo CD application to Git Source
114114
As the final step in migrating your Argo CD Application to a Codefresh GitOps Runtime, manually commit the updated application manifest to the Git Source you created in Step 1.
115-
Once you commit the manifest to the Git Source, it is synced with the Git repo. You can view it in the Codefresh UI, modify definitions, track it through our different dashboards, and in short, manage it as youwould any GitOps resource in Codefresh.
115+
Once you commit the manifest to the Git Source, it is synced with the Git repo. You can view it in the Codefresh UI, modify definitions, track it through our different dashboards, and in short, manage it as you would any GitOps resource in Codefresh.
116116
117117
1. Go to the Git repo where you created the Git Source.
118118
1. Add and commit the Argo CD Application manifest to the Git Source.

‎_docs/installation/gitops/hosted-runtime.md‎

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ toc: true
88

99

1010

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/installation-options/#hosted-vshybrid-gitops).
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).
1212

1313
This article describes how to install the Hosted GitOps Runtime to leverage GitOps capabilities.<br>
1414
For Hybrid GitOps Runtime installation, see[Hybrid GitOps Runtime installation]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops-helm-installation/).
@@ -116,35 +116,7 @@ caption="Hosted GitOps Runtime in List view"
116116
max-width="70%"
117117
%}
118118

119-
<!--- Ask Idan if to keep this:
120-
### Troubleshoot failed Hosted GitOps Runtime installation
121-
Your Hosted GitOps Runtime may fail to install with an error as in the image below. We are closely moinitoring the Hosted GitOps Runtime installation process and activley working to prevent and iron out all installation errors. Follow the instructions to uninstall and reinstall the Hosted GitOps Runtime.
122119

123-
{% include
124-
image.html
125-
lightbox="true"
126-
file="/images/runtime/hosted-runtime-error.png"
127-
url="/images/runtime/hosted-runtime-error.png"
128-
alt="Hosted runtime installation error"
129-
caption="Hosted runtime installation error"
130-
max-width="70%"
131-
%}
132-
133-
134-
1. Download the CLI
135-
* If you have installed the Codefresh CLI already, make sure you have the latest version:
136-
`cf version`
137-
To compare with the latest version from Codefresh, [click here](https://github.com/codefresh-io/cli-v2/releases){:target="\_blank"}.
138-
* [Download the CLI]({{site.baseurl}}/docs/clients/csdp-cli/).
139-
140-
1. Uninstall the failed Hosted GitOps Runtime:
141-
`cf runtime uninstall codefresh-hosted --force`
142-
where:
143-
`hosted-codefresh` is the name of your Hosted GitOps Runtime, automatically assigned by Codefresh.
144-
1. In the Codefresh UI, return to Codefresh [Home](https://g.codefresh.io/2.0/?time=LAST_7_DAYS){:target="\_blank"}.
145-
1. Refresh the page and start with [Step 1: Install Hosted GitOps Runtime](#step-1-install-hosted-gitops-runtime).
146-
147-
-->
148120
##Step 2: Connect Git provider
149121
Connect your Hosted GitOps Runtime to a Git provider for Codefresh to create the required Git repos.
150122

@@ -169,7 +141,7 @@ max-width="80%"
169141
Once you authorize access, Codefresh creates two Git repositories, one to store the configuration settings for GitOps Runtimes, and the other to store the Runtime's application settings:
170142
* Shared Configuration Repository
171143
The Shared Configuration Repository is a centralized Git repository that stores configuration settings for the Hosted GitOps Runtime. Additional Hybrid runtimes provisioned for the account can point to this repo to retrieve and reuse the configuration.
172-
Read about[Shared ConfigurationRepositories]({{site.baseurl}}/docs/installation/gitops/shared-configuration/).
144+
Read about[Shared ConfigurationRepository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/).
173145

174146

175147
* Git Source application repo
@@ -304,8 +276,8 @@ max-width="70%"
304276
{:start="5"}
305277
1. Configure access to the IP addresses required. See[Codefresh IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/).
306278

307-
If you could not connect a cluster, you may not have the latest version of the CLI:
308-
[Upgrade the GitOps CLI]({{site.baseurl}}/docs/installation/gitops/upgrade-gitops-cli/).
279+
<!--If you could not connect a cluster, you may not have the latest version of the CLI:
280+
[Upgrade the GitOps CLI]({{site.baseurl}}/docs/installation/gitops/upgrade-gitops-cli/).-->
309281

310282
You have completed setting up your Hosted GitOps Runtime. You are ready to create applications, and connect third-party CI tools for image enrichment.
311283

@@ -314,7 +286,7 @@ Optional. Create an application in Codefresh, deploy it to the cluster, and trac
314286

315287
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/).
316288
OR
317-
Create your own application. See[Create an application]({{site.baseurl}}/docs/deployments/gitops/create-application/)
289+
Create your own application. See[Create an application]({{site.baseurl}}/docs/deployments/gitops/create-application/).
318290

319291
{:start="2"}
320292
2. In the Codefresh UI, view your application in the[Applications dashboard](https://g.codefresh.io/2.0/applications-dashboard/list){:target="\_blank"}.
@@ -327,7 +299,7 @@ See [Image enrichment with integrations]({{site.baseurl}}/docs/gitops-integratio
327299
##Related articles
328300
[Monitoring & managing GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/)
329301
[Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
330-
[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration)
302+
[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/)
331303
[Home Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/)
332304
[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/)
333305

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp