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 CLI version and remove git credentials step
Updated CLI version to 0.1.57 and removed step to configure Git credentials
* Update migrate-cli-runtimes-helm.md
* Update migrate-cli-runtimes-helm.md
* Update migrate-cli-runtimes-helm.md
Minor content edits
Copy file name to clipboardExpand all lines: _docs/installation/gitops/migrate-cli-runtimes-helm.md
+22-91Lines changed: 22 additions & 91 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,24 +13,34 @@ When you migrate the CLI-based Runtime, the Git Sources, external clusters, and
13
13
The `values.yaml` file for Helm installation is the central configuration hub for customizing and controlling various aspects of the Runtime installation. You need to replicate all patches and customizations applied to the CLI Runtime to the `values.yaml` for the new Helm Runtime.
14
14
15
15
>**NOTE**:
16
-
Migration from CLI-based to Helm-based Runtimes is supported from GitOps CLI version 0.1.54 and higher.
16
+
Migration from CLI-based to Helm-based Runtimes is supported from GitOps CLI version 0.1.57 and higher.
17
17
18
18
## Before you begin
19
19
Make sure you have:
20
20
* Git user token (see [Git tokens]({{site.baseurl}}/docs/reference/git-tokens/#git-user-access-token-scopes))
21
21
* Git username, based on the Git provider
22
22
* GitHub and GitHub Enterprise: Not required as Codefresh automatically retrieves and populates it.
23
23
* GitLab Cloud and GitLab Server: Required, and is either your username as the owner, or if your project is within a group, the front-slash separated path to the project. For example, `nr-codefresh` (owner), or `parent-group/child-group` (group hierarchy)
24
-
* Bitbucket Cloud and Bitbucket Server: Required, and is your username for the Bitbucket Cloud/Bitbucket Server account.
25
-
* CLI version 0.1.53 or higher
24
+
* Bitbucket Cloud and Bitbucket Server: Required, and is your username for the Bitbucket Cloud/Bitbucket Server account.
25
+
* CLI version 0.1.57 or higher
26
26
Run `cf upgrade` if needed to download the latest CLI version
27
27
28
28
## Step 1: Update `values.yaml`
29
29
30
-
Before migrating the CLI-based Runtime and installing the Helm-based Runtime, replicate all patches and customizations made to the CLI Runtime to the `values.yaml` file. This action is essential and ensures that the Helm-based Runtime inherits the configuration established in the CLI Runtime's setup.
30
+
Before migrating the CLI-based Runtime and installing the Helm-based Runtime, replicate all patches and customizations made to the CLI Runtime to the `values.yaml` file. This action is essential and ensures that the Helm-based Runtime inherits the configuration in the CLI Runtime's setup.
31
31
32
32
The Codefresh `values.yaml` is located [here](https://github.com/codefresh-io/gitops-runtime-helm/tree/main/charts/gitops-runtime){:target="\_blank"}. Every parameter is annotated in detail. If you have questions, reach out to Codefresh Support for guidance.
33
33
34
+
>TIP:
35
+
For info on customizing options for Argo components in the `values.yaml`, check out the following:
1. Wait for a few minutes, and then click **Close**.
220
230
You are taken to the List View for GitOps Runtimes where:
221
-
* The Hybrid GitOps Runtime you added is prefixed with a green dot indicating that it is online.
231
+
* The Hybrid GitOps Runtime you migrated is prefixed with a green dot indicating that it is online.
222
232
* The Type column for the Runtime displays **Helm**.
223
233
* The Sync Status column displays **Complete Installation**, indicating that there are pending steps to complete the installation.
224
234
* Drilling down into the Runtime shows empty tabs for Runtime Components, Git Sources, and Managed Clusters.
225
-
The Runtime Components are populated only when the GitOps Runtime is configured as an Argo Application, described later on in the installation process.
235
+
The Runtime Components are populated only when the GitOps Runtime is configured as an Argo Application, described in the step that follows.
1. Continue with [Step 5: Configure Git credentials for GitOps Runtime](#step-5-configure-git-credentials-for-gitops-runtime).
239
-
240
-
## Step 5: Configure Git credentials for GitOps Runtime
241
-
Configure Git credentials to authorize access to and ensure proper functioning of the Helm-based GitOps Runtime.
242
-
243
-
Git credentials include authorizing access to Git through OAuth2 or a Git Runtime token, and optionally configuring SSH access to the Git installation repo for the Runtime.
244
-
245
-
**Git authorization**
246
-
* OAuth2 authorization is possible if your admin has registered an OAuth Application for Codefresh. See [OAuth2 setup for GitOps]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/).
247
-
* Git access token authentication requires you to generate an access token in your Git provider account for the GitOps Runtime, with the correct scopes. See [GitOps Runtime token scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes).
248
-
249
-
**SSH access to Git**
250
-
By default, Git repositories use the HTTPS protocol. You can also use SSH to connect Git repositories by entering the SSH private key.
251
-
When SSH is configured for a GitOps Runtime, on creating/editing Git-Source applications, you can select HTTPS OR SSH as the protocol to connect to the Git repository. See [Repository URL in Application Source definitions]({{site.baseurl}}/docs/deployments/gitops/create-application/#source).
252
-
253
-
For more information on generating SSH private keys, see the official documentation:
Configure the Hybrid GitOps Runtime as an Argo Application as the final step in the installation process.
255
+
Configure the Hybrid GitOps Runtime as an Argo Application as the final step in the migration process.
325
256
We recommend completing this step, as by doing so, you can view the Runtime components, monitor health and sync statuses, and ensure that GitOps is the single source of truth for the Runtime.
326
257
327
-
>**NOTE**:
328
-
You cannot configure the Runtime as an Argo Application if you have not configured Git credentials for the Runtime, as described in the previous step.
258
+
<!--- >>**NOTE**:
259
+
You cannot configure the Runtime as an Argo Application if you have not configured Git credentials for the Runtime, as described in the previous step.-->
329
260
330
261
331
262
1. Go back to the List view.
@@ -353,7 +284,7 @@ You can also create [Environments]({{site.baseurl}}/docs/dashboards/gitops-envir
0 commit comments