Skip to content

Commit 6052937

Browse files
NimRegevNimRegev
committed
Update Git provider and ISC step
Updated content for Git provider and ISC to align with the new design and added screenshots
1 parent c10e2c1 commit 6052937

File tree

2 files changed

+59
-19
lines changed

2 files changed

+59
-19
lines changed

‎_docs/installation/gitops/hybrid-gitops-helm-installation.md

Lines changed: 59 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -181,23 +181,40 @@ The Codefresh `values.yaml` located [here](https://github.com/codefresh-io/gitop
181181
1. Continue with [Step 2: Set up GitOps Git provider](#step-2-set-up-gitops-git-provider).
182182

183183
### Step 2: Set up GitOps Git provider
184-
As a one-time action, select the Git provider and the Shared Configuration Repository to associate with your account.
184+
As a one-time action, define the Shared Configuration Repository and the Git provider to associate with your account.
185+
The Git provider you select for the first GitOps Runtime in your account is used for all the other Runtimes installed in the same account.
185186

186-
The Git provider you select for the first GitOps Runtime in your account is used for all the other Runtimes installed in the same account.
187187

188-
The [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) is a Git repository with configuration manifests shared between all the Hybrid GitOps Runtimes within the same account.
189188

190-
<br><br>
189+
**Shared Configuration Repository**
190+
The [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/shared-configuration/) is a Git repository with configuration manifests shared between all the Hybrid GitOps Runtimes within the same account. Codefresh identifies the Git provider from the URL of the Shared Configuration Repo, and for cloud providers, automatically populates the Git Provider and the API URL fields.
191191

192-
1. Select the **Git provider** from the list.
193-
1. Define the **API URL** for the Git provider you selected, as one of the following:
194-
* GitHub Cloud: `https://api.github.com`
192+
**Git provider**
193+
On-premises Git providers require you to define the API URL:
195194
* GitHub Enterprise: `https://<server-url>/api/v3`
196-
* GitLab Cloud: `https://gitlab.com/api/v4`
197195
* GitLab Server: `<server-url>/api/v4`
198-
* Bitbucket Cloud: `https://api.bitbucket.org/2.0`
199196
* Bitbucket Server: `<server-url>/rest/api/1.0`
197+
198+
199+
200+
<br>
201+
202+
**How to**
200203
1. Define the URL of the **Shared Configuration Repository**.
204+
1. If required, select the **Git provider** from the list.
205+
1. If required, define the **API URL** for the Git provider you selected.
206+
207+
{% include
208+
image.html
209+
lightbox="true"
210+
file="/images/runtime/helm/helm-install-hybrid-runtime.png"
211+
url="/images/runtime/helm/helm-install-hybrid-runtime.png"
212+
alt="Install Hybrid GitOps Runtime"
213+
caption="Install Hybrid GitOps Runtime"
214+
max-width="40%"
215+
%}
216+
217+
{:start="4"}
201218
1. Click **Next**.
202219
1. Continue with [Step 3: Install Hybrid Runtime](#step-3-install-hybrid-gitops-runtime).
203220

@@ -363,7 +380,7 @@ helm upgrade --install <helm-release-name> \
363380

364381

365382
### Step 4: Configure Git credentials for Hybrid GitOps Runtime
366-
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.
383+
Configure Git credentials to authorize access to and ensure proper functioning of the GitOps Runtime. This is the first of the three steps needed to complete installing Hybrid GitOps Runtimes, the others being to add a Git user token and configure the Runtime as an Argo Application, described in the next steps.
367384

368385
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.
369386

@@ -388,9 +405,21 @@ For more information on generating SSH private keys, see the official documentat
388405
* To use SSH, copy the SSH private key for your Git provider
389406

390407
**How to**
391-
1. In the Sync Status column for the Runtime you just installed, click **Complete Installation**.
408+
1. In the Sync Status column for the Runtime you just installed, click **Complete Installation**.
409+
Codefresh displays the steps needed to complete the installation.
410+
You may see a message that the Runtime is missing a Git user token. You can ignore this message and continue to complete the installation.
392411

412+
{% include
413+
image.html
414+
lightbox="true"
415+
file="/images/runtime/helm/helm-complete-install-widgets.png"
416+
url="/images/runtime/helm/helm-complete-install-widgets.png"
417+
alt="Steps to complete installing Hybrid GitOps Runtime"
418+
caption="Steps to complete installing Hybrid GitOps Runtime"
419+
max-width="60%"
420+
%}
393421

422+
{:start="2"}
394423
1. Do one of the following:
395424
* If your admin has set up OAuth access, click **Authorize Access to Git Provider**. Go to _step 3_.
396425
* Alternatively, authenticate with an access token from your Git provider. Go to _step 4_.
@@ -431,10 +460,21 @@ For more information on generating SSH private keys, see the official documentat
431460
{:start="6"}
432461
1. Click **Update Credentials**.
433462
Codefresh displays a message that the Git Runtime credentials have been updated.
434-
1. Continue with [Step 5: (Optional) Configure Hybrid GitOps Runtime as Argo Application](#step-5-optional-configure-hybrid-gitops-runtime-as-argo-application).
463+
1. Continue with [Step 5: Add Git user token](#step-5-add-git-user-token).
464+
465+
### Step 5: Add Git user token
466+
Add a Git user token, as a personal access token unique to every user. The permissions for the Git user token are different from those of the Git Runtime token.
467+
Verify that you have an [access token from your Git provider with the correct scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-user-access-token-scopes).
468+
469+
>**TIP**:
470+
If you already have a Git user token defined, you can skip this step.
471+
472+
1. Click **Git user token** to add your personal access token to authorize actions to Git repositories.
473+
1. Continue with [Step 6: (Optional) Configure Hybrid GitOps Runtime as Argo Application](#step-6-optional-configure-hybrid-gitops-runtime-as-argo-application).
474+
435475

436476

437-
### Step 5: (Optional) Configure Hybrid GitOps Runtime as Argo Application
477+
### Step 6: (Optional) Configure Hybrid GitOps Runtime as Argo Application
438478

439479
Configure the Hybrid GitOps Runtime as an Argo Application as the final step in the installation process.
440480
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.
@@ -458,28 +498,28 @@ You cannot configure the Runtime as an Argo Application if you have not configur
458498
%}
459499

460500
{:start="3"}
461-
1. Continue with [Step 6: GitOps with Argo CD: Remove Rollouts controller deployment](#step-6-gitops-with-argo-cd-remove-rollouts-controller-deployment).
501+
1. Continue with [Step 7: GitOps with Argo CD: Remove Rollouts controller deployment](#step-7-gitops-with-argo-cd-remove-rollouts-controller-deployment).
462502

463-
### Step 6: GitOps with Argo CD: Remove Rollouts controller deployment
503+
### Step 7: GitOps with Argo CD: Remove Rollouts controller deployment
464504
For GitOps with Argo CD, after confirming successful installation, remove the duplicate Argo Rollouts controller deployment to avoid having two controllers in the cluster.
465505

466506
>**IMPORTANT**:
467507
Make sure to remove only the `deployment` and not the CRDs. Removing the CRDs also removes Rollout objects resulting in downtime for workloads.
468508

469509
1. Remove the duplicate Argo Rollouts controller:
470510
`kubectl delete deployment <argo-rollouts-controller-name> -n <argo-rollouts-controller-namespace>`
471-
1. Continue with [Step 7: (Optional) Create a Git Source](#step-7-optional-create-a-git-source).
511+
1. Continue with [Step 8: (Optional) Create a Git Source](#step-8-optional-create-a-git-source).
472512

473513

474-
### Step 7: (Optional) Create a Git Source
514+
### Step 8: (Optional) Create a Git Source
475515

476516
Create a Git Source for the Runtime. A Git Source is a Git repository with an opinionated folder structure, managed by Codefresh.
477517
You can always create Git Sources after installation whenever you need to from the Codefresh UI.
478518

479519
1. Optional. Create a [Git Source]({{site.baseurl}}/docs/installation/gitops/git-sources/#create-a-git-source).
480-
1. Continue with [Step 8: (Optional) Configure ingress-controllers](#step-8-optional-configure-ingress-controllers).
520+
1. Continue with [Step 9: (Optional) Configure ingress-controllers](#step-9-optional-configure-ingress-controllers).
481521

482-
### Step 8: (Optional) Configure ingress-controllers
522+
### Step 9: (Optional) Configure ingress-controllers
483523
Required only for ALB AWS and NGINX Enterprise ingress-controllers, and Istio service meshes.<br>
484524

485525
* Complete configuring these ingress controllers:

‎images/runtime/helm/helm-define-isc-git-provider.png

65.8 KB
Loading

0 commit comments

Comments
 (0)