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
* Update runtime quick starts for gitops
Updated content for all gitops runtime quick start topics to align with new Helm
* Update with Helm reqs
Replaced CLI commands with Helm command
* Update hybrid-gitops-helm-installation.md
Updated helm install procedure with latest changes
* Update runtime.md
Added Argo project and CRDs to Quick start assumptions
* Remove --devel from quick start
Aligned quick start with Helm and removed --devel flag
* Update quick start content for gitops runtimes
Fixed terminology and removed screenshot --devel from screenshot
### Step 5: Configure Git credentials for Hybrid GitOps Runtime
408
-
Configure Git credentials to authorize access to and ensure proper functioning of the GitOps Runtime.
408
+
Configure Git credentials to authorize access to and ensure proper functioning of the GitOps Runtime. This is one of the two steps to complete installing Hybrid GitOps Runtimes, the other being to configure the Runtime as an Argo Application, described in the next step.
409
409
410
410
Git credentials include authorizing access to Git through OAuth2 or a personal access token, and optionally configuring SSH access to Git.
411
411
@@ -489,7 +489,7 @@ Required only for ALB AWS, Istio, or NGINX Enterprise ingress-controllers.<br>
That's it! You have successfully completed installing a Hybrid GitOps Runtime with Helm. See the Runtime in the [Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#gitops-runtime-views) page.
492
+
That's it! You have successfully completed installing a Hybrid GitOps Runtime with Helm. View the Runtime in the [Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#gitops-runtime-views) page.
493
493
494
494
You can now add [external clusters to the Runtime]({{site.baseurl}}/docs/installation/gitops/managed-cluster/), and [create and deploy GitOps applications]({{site.baseurl}}/docs/deployments/gitops/create-application/).
Copy file name to clipboardExpand all lines: _docs/quick-start/gitops-quick-start.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,31 +8,31 @@ toc: true
8
8
Check out our GitOps quick starts to get up and running with GitOps in Codefresh.
9
9
10
10
The quick start guides you through:
11
-
* Provisioning runtimes
11
+
* Provisioning GitOps Runtimes
12
12
* Creating and deploying an application
13
13
14
14
15
-
## Provision runtimes
16
-
Based on your deployment model, start by provisioning the hosted or hybrid runtime. Hosted and hybrid runtimes can co-exist with each other.
15
+
## Provision GitOps Runtimes
16
+
Based on your deployment model, start by provisioning the Hosted or Hybrid GitOps Runtime. Hosted and Hybrid GitOps Runtimes can co-exist with each other.
17
17
18
18
19
19
### Hosted
20
-
Hosted runtimes are hosted on a Codefresh cluster and managed by Codefresh. You need to provision your hosted runtime once for your account.
20
+
Hosted GitOps Runtimes are hosted on a Codefresh cluster and managed by Codefresh. You need to provision your Hosted Runtime once for your account.
21
21
22
-
1.[Provision a hosted runtime]({{site.baseurl}}/docs/quick-start/gitops-quick-start/install-hosted)
23
-
Provision the hosted runtime with a single click, and complete the setup for your hosted environment.
22
+
1.[Provision a Hosted GitOps Runtime]({{site.baseurl}}/docs/quick-start/gitops-quick-start/install-hosted)
23
+
Provision the Hosted GitOps Runtime with a single click, and complete the setup for your hosted environment.
24
24
25
25
{::nomarkdown}
26
26
<br>
27
27
{:/}
28
28
29
29
### Hybrid
30
-
Hybrid runtimes are hosted on a customer cluster and managed by the customer. You can provision multiple hybrid runtimes in the same account.
30
+
Hybrid GitOps Runtimes are hosted on a customer cluster and managed by the customer. You can provision multiple Hybrid GitOps Runtimes in the same account.
31
31
32
-
1.[Prepare for hybrid runtime installation]({{site.baseurl}}/docs/quick-start/gitops-quick-start/verify-requirements)
33
-
Verify your environment matches the requirements for installing Codefresh runtime.
Copy file name to clipboardExpand all lines: _docs/quick-start/gitops-quick-start/install-hosted.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,22 @@
1
1
---
2
-
title: "Provision a hosted runtime"
3
-
description: ""
2
+
title: "Provision a Hosted GitOps Runtime"
3
+
description: "Install the GitOps Runtime hosted by Codefresh"
4
4
group: getting-started
5
5
sub-group: gitops-quick-start
6
6
toc: true
7
7
---
8
8
9
9
If you have Hosted GitOps, set up your hosted runtime environment:
10
10
11
-
1. Provision the hosted runtime with a single click
11
+
1. Provision the Hosted GitOps Runtime with a single click
12
12
1. Authorize access through your OAuth token to the organization where Codefresh creates the Git runtime repo and the shared configuration repo
13
13
1. Connect to an external K8s cluster with access to the internet, to which you can deploy applications
14
14
1. Install Argo Rollouts on the cluster
15
15
16
16
Read our [blog on Hosted GitOps](https://codefresh.io/blog/codefresh-upends-continuous-delivery-with-hosted-gitops-platform-featuring-dora-dashboards-and-first-class-integrations-for-ci/).
17
-
For detailed information on each of the steps below, see [Set up a hosted runtime environment]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
17
+
For detailed information on each of the steps below, see [Set up a Hosted GitOps Runtime environment]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/).
18
18
19
-
**Before you begin**
19
+
## Before you begin
20
20
21
21
Verify the following:
22
22
* If you have hybrid runtimes installed, make sure you have latest version of the CLI
@@ -27,8 +27,8 @@ Verify the following:
27
27
* Kubernetes cluster with access to the internet
28
28
* OAuth token
29
29
30
-
**How to**
31
-
1. In the Codefresh UI, go to Codefresh [Home](https://g.codefresh.io/2.0/?time=LAST_7_DAYS){:target="\_blank"}.
30
+
## How to
31
+
1. In the Codefresh UI, go to Codefresh [Home Dashboard](https://g.codefresh.io/2.0/?time=LAST_7_DAYS){:target="\_blank"}.
32
32
33
33
{% include
34
34
image.html
@@ -41,8 +41,8 @@ max-width="80%"
41
41
%}
42
42
43
43
{:start="2"}
44
-
1. Provision the hosted runtime:
45
-
* Click **Install**, and wait for Codefresh to complete provisioning your hosted runtime (may take up to ten minutes).
44
+
1. Provision the Hosted GitOps Runtime:
45
+
* Click **Install**, and wait for Codefresh to complete provisioning your Hosted GitOps Runtime (may take up to ten minutes).
46
46
47
47
{% include
48
48
image.html
@@ -105,6 +105,6 @@ max-width="70%"
105
105
max-width="50%"
106
106
%}
107
107
108
-
###What to do next
108
+
## What to do next
109
109
[Create resources for codefresh-guestbook application]({{site.baseurl}}/docs/quick-start/gitops-quick-start/create-app-specs/)
description: "Install the Helm-based Hybrid GitOps Runtime"
4
4
group: getting-started
5
5
sub-group: quick-start
6
6
toc: true
7
7
---
8
8
9
9
10
-
Install the hybrid runtime on your K8s cluster. Installing the hybrid runtime installs Argo-project and Codefresh-specific components. The Argo Project is an enterprise-supported version of the Argo CD components, derived from a conformed fork of the Argo ecosystem.
11
10
12
-
### About hybrid runtime installation
13
-
Installing a hybrid runtime includes installing the:
14
-
1. GitOps CLI
15
-
2. Codefresh hybrid runtime from the CLI in a specific namespace on your cluster.
16
-
Every hybrid runtime installation makes commits to three Git repos:
17
-
* Runtime installation repo: The installation repo that manages the runtime itself with Argo CD. If the repo URL you provide does not exist, the runtime creates it automatically.
18
-
* Git Source repo: Created automatically during runtime installation. The repo with the demo resources required for the sample `Hello World` pipelines we provide.
19
-
* Shared Configuration Repository: A repository that stores configuration manifests shared across runtimes.
11
+
Get up and running with Codefresh by installing the Hybrid Runtime for GitOps via Helm.
12
+
The Runtime is installed through a Helm chart. The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/){:target="\_blank"}. It contains all the arguments that can be configured, including optional ones.
20
13
21
-
### Before you begin
14
+
##Quick start assumptions
22
15
23
-
#### Tunnel-based runtime
24
-
Hybrid GitOps runtimes supports tunnel-based and ingress-based configurations.
25
-
For the quick start, we will use the tunnel-based mode which is the default access mode and does not require an ingress controller.
26
-
For details, review [GitOps Runtime architecture]({{site.baseurl}}/docs/installation/runtime-architecture/#gitops-runtime-architecture).
16
+
The quick start assumes that you are installing the first Hybrid GitOps Runtime in your Codefresh account.
27
17
28
-
#### Git provider tokens
29
-
A hybrid runtime requires a Git token for authentication to the Git installation repository based on your Git provider.
30
-
The quick start uses GitHub as the Git provider. For other Git providers and token requirements, see [Git provider and repo flags]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/#git-provider-and-repo-flags).
18
+
## Argo project components & CRDs
19
+
Hybrid GitOps installation requires a cluster without Argo project components and CRDs (Custom Resource Definitions).
31
20
32
-
Have your GitHub Personal Authentication Token (PAT) ready with a valid expiration date and access permissions:
33
-
* Expiration: Either the default of 30 days or any duration you consider logical.
34
-
* Access scopes: Set to `repo` and `admin-repo.hook`
21
+
Argo project components include Argo Rollouts, Argo CD, Argo Events, and Argo Workflows.
22
+
23
+
You can handle Argo project CRDs outside the chart, or as recommended, adopt the CRDs to be managed by the GitOps Runtime Helm release.
24
+
25
+
If you already have Argo project CRDs on your cluster, do one of the following:
26
+
* Handle Argo projects CRDs outside of the chart (see [Argo's readme on Helm charts](https://github.com/argoproj/argo-helm/blob/main/README.md){:target="\_blank"})
27
+
Disable CRD installation under the relevant section for each of the Argo projects in the Helm chart:<br>
28
+
`--set <argo-project>.crds.install=false`<br>
29
+
where:<br>
30
+
`<argo-project>` is the argo project component: `argo-cd`, `argo-workflows`, `argo-rollouts` and `argo-events`.
31
+
32
+
* Adopt the CRDs<br>
33
+
Adopting the CRDs allows them to be managed by the `gitops-runtime helm release`. Doing so ensures when you upgrade the Hybrid GitOps Runtime, the CRDs are also automatically upgraded.
Hybrid GitOps Runtimes supports tunnel-based, ingress-based, and service-mesh-based access modes.
48
+
For the quick start, we'll use the tunnel-based mode which is the default access mode, not requiring an ingress controller.
49
+
For details on these access modes, review [GitOps Runtime architecture]({{site.baseurl}}/docs/installation/runtime-architecture/#gitops-runtime-architecture).
50
+
51
+
### GitHub as Git provider
52
+
Hybrid GitOps Runtimes require a Git Runtime token for authentication to the Git installation repository based on your Git provider, and a Git user token to authenticate Git-based actions for the Runtime.
53
+
The quick start uses GitHub as the Git provider. For other Git providers and token requirements, see [Git providers and Git runtime tokens]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes).
54
+
55
+
Have your GitHub Runtime token ready for Runtime installation with a valid expiration date and access permissions:
56
+
* Expiration: Either the default of 30 days or any duration you consider logical.
57
+
* Access scopes: Set to `repo` and `admin-repo.hook`
35
58
36
59
{% include
37
60
image.html
@@ -45,74 +68,58 @@ For details, review [GitOps Runtime architecture]({{site.baseurl}}/docs/installa
45
68
46
69
If you need detailed information on GitHub tokens, see the [GitHub article](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
47
70
48
-
### Download the Codefresh CLI
49
-
Downloading the Codefresh CLI requires you to select the download mode and OS, generate an API key, and authentication context, as instructed in the UI.
50
-
1. In the Welcome page, select **+ Install Runtime**.
51
-
1. Download the Codefresh CLI:
52
-
* Select one of the methods.
53
-
* Generate the API key and create the authentication context.
71
+
### Shared Configuration Repository
72
+
When you select the Git provider, Codefresh prompts you to also select the Shared Configuration Repository for your account. The repo stores account-level configuration settings and manifests.
73
+
Because the Shared Configuration Repo is defined at the account-level, the Git provider you select for the first Runtime in your account is used for all the other Runtimes in the same account.
74
+
Read up on the [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/).
54
75
55
-
{% include
56
-
image.html
57
-
lightbox="true"
58
-
file="/images/runtime/gitops-cli-download.png"
59
-
url="/images/runtime/gitops-cli-download.png"
60
-
alt="Download GitOps CLI to install runtime"
61
-
caption="Download GitOps CLI to install runtime"
62
-
max-width="30%"
63
-
%}
64
-
### Install hybrid runtime
65
-
For the quick start, we will use the CLI wizard to install the Hybrid GitOps Runtime.
66
-
67
-
1. To start runtime installation, run `cf runtime install`.
68
-
>If you don't have a valid SSL certificate for the Ingress controller, and want to continue with the installation, add the `--insecure` flag to the runtime command.
69
-
1. Follow the prompts in the CLI wizard to complete the installation:
70
-
***Runtime name**: The name of your runtime, starting with a lower-case character, and including up to 63 characters and numbers. Example: `codefreshproduction`
71
-
* **Select Kube context**: Your current context is highlighted. Press Enter to select it, or use the arrow keys to select a different context.
72
-
* **Repository URL**: The GitHub repo for the installation definitions, in the format `https://github.com/[user-or-org-name]/[repo_name]`. Example: `https//:github.com/codefresh/cf_production_install`.
73
-
* **Git runtime token**: The GitHub PAT for access to the installation repo.
74
-
* **Install Codefresh demo resources?** Press Enter to confirm. Demo resources are saved in a new Git Source repo, created by Codefresh. They include resources for two Hello World pipelines, one with a Cron trigger condition, and the other with a Git event trigger condition.
75
-
* **Do you wish to continue with runtime install?** Press Enter to confirm and start runtime installation.
76
-
1. Wait for the runtime installed successfully message.
77
-
78
-
### Validate successful installation
79
-
The **Runtimes** dashboard shows the hybrid runtime you just installed. You can drill down into the runtime to see its components and Git Sources.
80
-
81
-
1. In the Codefresh UI, go to the [**Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"} dashboard.
1. In the Welcome page, select **+ Install Runtime**.
84
+
1. From Runtimes in the sidebar, select **GitOps Runtimes**.
85
+
1. Set up your Git provider account:
86
+
1. If not GitHub, select the Git provider.
87
+
1. Define the provider's API URL.
88
+
1. Define the URL of the **Shared Configuration Repository**.
89
+
1. Click **Next**.
90
+
1. Install the Hybrid GitOps Runtime:
91
+
1. Click **Generate** to create a new API key.
92
+
1. Retain the default values for the GitOps Runtime name and namespace, `codefresh`.
93
+
1. Copy the command in _Step 3_ and run it to add the repository in which to store the Helm chart. You don't need to change anything in the command.
94
+
1. Copy the command in _Step 4_ and run it to install the Helm chart for the Hybrid GitOps Runtime:
95
+
where:
96
+
*`cf-gitops-runtime` is the default name of the Helm release, which you can change if needed.
97
+
*`codefresh` is the default namespace in which to install the Hybrid GitOps runtime.
98
+
*`<codefresh-account-id>` is mandatory for _tunnel-based Hybrid GitOps Runtimes_, and is automatically populated by Codefresh in the command.
99
+
*`<codefresh-token>` is the API key you generated, and is automatically populated in the command.
100
+
*`codefresh` is the default name of the runtime.
101
+
*`<cf-gitops-runtime/gitops-runtime>` is the name of the repo and must be identical to the one specified in _Step 3_, and is by default, `cf-gitops-runtime`. `gitops-runtime` is the name of the Helm chart predefined by Codefresh, and cannot be changed.
1. Wait for a few minutes, and then click **Close**.
115
+
You are taken to the List View for GitOps Runtimes where you can see the Hybrid GitOps Runtime you added with a green dot indicating that it is online, and the Type column for the Runtime displaying Helm.
116
+
1. Optional. Complete the installation by clicking **Configure as Argo Application**.
117
+
There is no need for any action from you, as Codefresh takes care of the configuration.
118
+
By configuring the Hybrid GitOps Runtime as an Argo Application, you can ensure that GitOps is the single source of truth for the Runtime and view and monitor Runtime components.
119
+
120
+
You are now ready to create and deploy a GitOps application in Codefresh.
121
+
122
+
123
+
## What to do next
117
124
[Create resources for codefresh-guestbook application]({{site.baseurl}}/docs/quick-start/gitops-quick-start/create-app-specs/)
0 commit comments