Skip to content

Commit 7911c46

Browse files
authored
Cli runtime migration fixes (#874)
* 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
1 parent fadae20 commit 7911c46

File tree

1 file changed

+22
-91
lines changed

1 file changed

+22
-91
lines changed

_docs/installation/gitops/migrate-cli-runtimes-helm.md

Lines changed: 22 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,34 @@ When you migrate the CLI-based Runtime, the Git Sources, external clusters, and
1313
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.
1414

1515
>**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.
1717

1818
## Before you begin
1919
Make sure you have:
2020
* Git user token (see [Git tokens]({{site.baseurl}}/docs/reference/git-tokens/#git-user-access-token-scopes))
2121
* Git username, based on the Git provider
2222
* GitHub and GitHub Enterprise: Not required as Codefresh automatically retrieves and populates it.
2323
* 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
2626
Run `cf upgrade` if needed to download the latest CLI version
2727

2828
## Step 1: Update `values.yaml`
2929

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.
3131

3232
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.
3333

34+
>TIP:
35+
For info on customizing options for Argo components in the `values.yaml`, check out the following:
36+
>[Argo CD](https://github.com/codefresh-io/argo-helm/blob/argo-cd/charts/argo-cd/README.md){:target="\_blank"}
37+
>[Argo Events](https://github.com/codefresh-io/argo-helm/blob/argo-cd/charts/argo-events/README.md){:target="\_blank"}
38+
>[Argo Workflows](https://github.com/codefresh-io/argo-helm/blob/argo-cd/charts/argo-workflows/README.md){:target="\_blank"}
39+
>[Argo Rollouts](https://github.com/codefresh-io/argo-helm/blob/argo-cd/charts/argo-rollouts/README.md){:target="\_blank"}
40+
41+
42+
43+
3444
1. Update `values.yaml`.
3545
1. Continue with [Step 2: Migrate CLI-based GitOps Runtime](#step-2-migrate-cli-based-gitops-runtime).
3646

@@ -218,11 +228,11 @@ helm upgrade --install <helm-release-name> \
218228
{:start="4"}
219229
1. Wait for a few minutes, and then click **Close**.
220230
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.
222232
* The Type column for the Runtime displays **Helm**.
223233
* The Sync Status column displays **Complete Installation**, indicating that there are pending steps to complete the installation.
224234
* 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.
226236

227237
{% include
228238
image.html
@@ -235,97 +245,18 @@ helm upgrade --install <helm-release-name> \
235245
%}
236246

237247
{:start="5"}
238-
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:
254-
* [GitHub](https://help.github.com/en/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent){:target="\_blank"}
255-
* [GitLab](https://docs.gitlab.com/ee/ssh/#generating-a-new-ssh-key-pair){:target="\_blank"}
256-
* [Bitbucket](https://confluence.atlassian.com/bitbucket/set-up-an-ssh-key-728138079.html){:target="\_blank"}
257-
* [Azure](https://docs.microsoft.com/en-us/azure/devops/repos/git/use-ssh-keys-to-authenticate?view=azure-devops&tabs=current-page){:target="\_blank"}
258-
259-
<br>
260-
261-
**Before you begin**
262-
* To authenticate through a Git Runtime access token, make sure your token is valid and has the required scopes for GitOps Runtimes
263-
* To use SSH, copy the SSH private key for your Git provider
264-
265-
<br>
266-
267-
**How to**
268-
1. In the Sync Status column for the Runtime you just installed, click **Complete Installation**.
269-
Codefresh displays the steps needed to complete the installation.
270-
271-
{% include
272-
image.html
273-
lightbox="true"
274-
file="/images/runtime/helm/helm-complete-install-widgets.png"
275-
url="/images/runtime/helm/helm-complete-install-widgets.png"
276-
alt="Steps to complete installing Hybrid GitOps Runtime"
277-
caption="Steps to complete installing Hybrid GitOps Runtime"
278-
max-width="60%"
279-
%}
280-
281-
{:start="2"}
282-
1. Do one of the following:
283-
* If your admin has set up OAuth access, click **Authorize Access to Git Provider**. Go to _step 3_.
284-
* Alternatively, authenticate with an access token from your Git provider. Go to _step 4_.
285-
286-
{% include
287-
image.html
288-
lightbox="true"
289-
file="/images/runtime/helm/helm-git-runtime-token.png"
290-
url="/images/runtime/helm/helm-git-runtime-token.png"
291-
alt="Configure Git Runtime credentials"
292-
caption="Configure Git Runtime credentials"
293-
max-width="50%"
294-
%}
295-
296-
{:start="3"}
297-
1. For OAuth2 authorization:
298-
> **NOTE**:
299-
If the application is not registered and you get an error, contact your admin for help.
300-
* Enter your credentials, and select **Sign In**.
301-
* If required, as for example with two-factor authentication, complete the verification.
302-
303-
{% include
304-
image.html
305-
lightbox="true"
306-
file="/images/administration/user-settings/oauth-user-authentication.png"
307-
url="/images/administration/user-settings/oauth-user-authentication.png"
308-
alt="Authorizing access with OAuth2"
309-
caption="Authorizing access with OAuth2"
310-
max-width="60%"
311-
%}
312-
313-
{:start="4"}
314-
1. For Git token authentication, in the **Git Runtime Token** field, paste the Git Runtime token you generated.
315-
1. Optional. To configure SSH access to Git, expand **Connect Repo using SSH**, and then paste the raw SSH private key into the field.
316-
1. Click **Update Credentials**. Codefresh displays a message that the Git Runtime credentials have been updated.
317-
1. Continue with [Step 6: (Optional) Configure Hybrid GitOps Runtime as Argo Application](#step-6-optional-configure-hybrid-gitops-runtime-as-argo-application).
248+
1. Continue with [Step 5: (Optional) Configure Hybrid GitOps Runtime as Argo Application](#step-6-optional-configure-hybrid-gitops-runtime-as-argo-application).
318249

319250

320251

321252

322-
## Step 6: (Optional) Configure Hybrid GitOps Runtime as Argo Application
253+
## Step 5: (Optional) Configure Hybrid GitOps Runtime as Argo Application
323254

324-
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.
325256
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.
326257

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. -->
329260

330261

331262
1. Go back to the List view.
@@ -353,7 +284,7 @@ You can also create [Environments]({{site.baseurl}}/docs/dashboards/gitops-envir
353284

354285
## Related articles
355286
[Monitor & manage GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/)
356-
[Add Git Sources to runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
287+
[Managing Git Sources in GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/git-sources/)
357288
[Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration)
358289
[Home Dashboard]({{site.baseurl}}/docs/dashboards/home-dashboard/)
359290
[DORA metrics]({{site.baseurl}}/docs/dashboards/dora-metrics/)

0 commit comments

Comments
 (0)