Skip to content

Commit 52bc1f8

Browse files
committed
Update hybrid helm
Implemented feedback from Idan
1 parent e7a8bce commit 52bc1f8

File tree

1 file changed

+33
-28
lines changed

1 file changed

+33
-28
lines changed

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

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,11 @@ This article walks you through the process of installing Hybrid GitOps Runtimes
3535
### Argo project components & CRDs
3636
Hybrid GitOps installation requires a cluster without Argo project components (Argo Rollouts, Argo CD, Argo Events, and Argo Workflows), and CRDs.
3737

38-
If you already have Argo project CRDs on your cluster, you can handle Argo project CRDs outside the chart, or as recommended, adopt the CRDs to be managed by the GitOps Runtime Helm release. Allowing the Runtime to manage the CRDs also ensures that the CRDs are automatically upgraded whenever the Runtime is upgraded.
38+
If you already have Argo project CRDs on your cluster, you have two options: adopt the CRDs to be managed by the GitOps Runtime Helm release, or handle them outside of the chart.
3939

40+
#### Option 1: (Recommended) Adopt the Argo project CRDs
4041

41-
#### Handle Argo project CRDs outside of the chart
42-
Disable CRD installation under the relevant section for each of the Argo projects in the Helm chart:<br>
43-
`--set <argo-project>.crds.install=false`<br>
44-
where:<br>
45-
`<argo-project>` is the argo project component: `argo-cd`, `argo-workflows`, `argo-rollouts` and `argo-events`.
46-
47-
See [Argo's readme on Helm charts](https://github.com/argoproj/argo-helm/blob/main/README.md){:target="\_blank"}.
48-
49-
#### Adopt the Argo project CRDs (recommended)
50-
51-
Adopting the CRDs, switches ownership to the Hybrid GitOps Runtime, allowing them to be managed by the GitOps Runtime chart.
42+
Adopting the CRDs switches ownership to the Hybrid GitOps Runtime, allowing them to be managed by the GitOps Runtime chart.
5243

5344
Run this script _before_ installation:
5445

@@ -60,6 +51,17 @@ kubectl label --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{prin
6051
kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{print $1}' | xargs) meta.helm.sh/release-name=$RELEASE
6152
kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{print $1}' | xargs) meta.helm.sh/release-namespace=$NAMESPACE
6253
```
54+
55+
#### Option 2: Handle Argo project CRDs outside of the chart
56+
Disable CRD installation under the relevant section for each of the Argo projects in the Helm chart:<br>
57+
`--set <argo-project>.crds.install=false`<br>
58+
where:<br>
59+
`<argo-project>` is the argo project component: `argo-cd`, `argo-workflows`, `argo-rollouts` and `argo-events`.
60+
61+
See [Argo's readme on Helm charts](https://github.com/argoproj/argo-helm/blob/main/README.md){:target="\_blank"}.
62+
63+
64+
6365
### ArgoCD password
6466

6567
>**WARNING**:
@@ -77,8 +79,8 @@ The Codefresh `values.yaml` located [here](https://github.com/codefresh-io/gitop
7779
### Before you begin
7880
* Make sure you meet the [minimum requirements](#minimum-system-requirements) for installation
7981
* Git provider requirements:
80-
* [Runtime token with the required scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes) which you need to supply as part of the Helm install command
81-
* [Personal Access Token (PAT)]({{site.baseurl}}/docs/reference/git-tokens/#git-personal-tokens) with the required scopes for Git-based actions
82+
* [Git Runtime token with the required scopes]({{site.baseurl}}/docs/reference/git-tokens/#git-runtime-token-scopes) which you need to supply as part of the Helm install command
83+
* [Git user token]({{site.baseurl}}/docs/reference/git-tokens/#git-personal-tokens) with the required scopes for Git-based actions
8284
* Server URLs for on-premises Git providers
8385
* Verify there are no Argo project components and CRDs in the target namespace or that you have adopted the CRDs (see [Argo project components & CRDs](#argo-project-components--crds))
8486
* For ingress-based runtimes only, verify that these ingress controllers are configured correctly:
@@ -152,15 +154,13 @@ The table below lists the settings validated in the `values` file.
152154

153155
### Step 2: Select Hybrid Runtime install option
154156

155-
1. Do one of the following:
156-
* If this is your first Hybrid GitOps installation, in the Welcome page, select **+ Install Runtime**.
157-
* If you have already provisioned a Hybrid GitOps Runtime, to provision additional runtimes:
158-
1. In the Codefresh UI, on the toolbar, click the **Settings** icon, and from Runtimes in the sidebar, select [**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
159-
1. Click **+ Add Runtimes**, and then select **Hybrid Runtimes**.
157+
1. In the Welcome page, select **+ Install Runtime**.
160158
1. Continue with [Step 3: Set up GitOps Git provider](#step-3-set-up-gitops-git-provider).
161159

162160
### Step 3: Set up GitOps Git provider
163-
Select the Git provider, define the provider's API URL, and the Shared Configuration Repository for your account.
161+
Select the Git provider and the Shared Configuration Repository to associate with your account.
162+
163+
The same Git provider is used for other GitOps Runtimes in the same account.
164164
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.
165165

166166
>**NOTE**:
@@ -176,8 +176,8 @@ The [Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/
176176
* Bitbucket Server: `<server-url>/rest/api/1.0`
177177
1. Define the URL of the **Shared Configuration Repository**.
178178
>**NOTE**:
179-
>Because the Shared Configuration Repo is defined at the account-level, the Git provider you select for the first GitOps Runtime in your account is used for all the other Runtimes in the same account.
180-
>To change the Shared Configuration Repo or Git credentials after installation, see [Update Git credentials for GitOps Runtimes]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes).
179+
>Because the Git provider and the Shared Configuration Repo are defined at the account-level, the Git provider you select for the first GitOps Runtime in your account is used for all the other Runtimes in the same account.
180+
>To change the Shared Configuration Repo or Git credentials after installation, see [Reset Shared Configuration Repository]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#reset-shared-configuration-repository-for-gitops-runtimes) and [Update Git credentials]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#update-git-credentials-for-gitops-runtimes) for GitOps Runtimes.
181181
1. Click **Next**.
182182
1. Continue with [Step 4: Install Hybrid Runtime](#step-4-install-hybrid-gitops-runtime).
183183

@@ -193,8 +193,8 @@ If you define a custom name for the Hybrid GitOps Runtime, it must start with a
193193
The Namespace must conform to the naming conventions for Kubernetes objects.
194194

195195
**Access modes**
196-
You can define three different access modes:
197-
* Tunnel-based, the default mode, automatically enabled when ingress-based access is not defined in the installation command.
196+
You can define one of three different access modes:
197+
* Tunnel-based, the default mode, automatically enabled when the other access modes are not defined in the installation command.
198198
* Ingress-based, uses an ingress controller, which, depending on the type of ingress controller, may need to be configured both before and after installation.
199199
* Service-mesh-based, which may also need to be configured before and after installation. This mode requires explicitly disabling the tunnel- and ingress-based modes in the installation command.
200200

@@ -295,7 +295,7 @@ helm upgrade --install <helm-release-name> \
295295
### Step 5: Configure Git credentials for Hybrid GitOps Runtime
296296
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.
297297

298-
Git credentials include authorizing access to Git through OAuth2 or a personal access token, and optionally configuring SSH access to Git.
298+
Git credentials include authorizing access to Git through OAuth2 or a user (personal) access token, and optionally configuring SSH access to Git.
299299

300300
**Git authorization**
301301
* OAuth2 authorization is possible if your admin has registered an OAuth Application for Codefresh. See [OAuth2 setup for Codefresh]({{site.baseurl}}/docs/administration/account-user-management/oauth-setup/).
@@ -315,7 +315,7 @@ For more information on generating SSH private keys, see the official documentat
315315

316316

317317
**Before you begin**
318-
* To authenticate through a Git access token, make sure your token is valid and has the required scopes for GitOps Runtimes
318+
* To authenticate through a Git user access token, make sure your token is valid and has the required scopes for GitOps Runtimes
319319
* To use SSH, copy the SSH private key for your Git provider
320320

321321
**How to**
@@ -379,6 +379,10 @@ Required only for ALB AWS, Istio, or NGINX Enterprise ingress-controllers.<br>
379379

380380
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.
381381

382+
**Post-installation configuration**
383+
384+
Depending on your configuration, if you have private registries, you need to override specific image values, and if your Git servers are on-premises, you need to add custom repository certificates. See [Optional GitOps Runtime configuration](#optional-gitops-runtime-configuration) in this article.
385+
382386
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/).
383387

384388

@@ -399,7 +403,9 @@ The new Runtime must have a unique name in the same account.
399403

400404
**How to**
401405

402-
1. In the Codefresh UI, go to [Install Hybrid GitOps Runtime](https://g.codefresh.io/2.0/account-settings/runtimes/info/list?drawer=install-codefresh-runtime){:target="\_blank"}.
406+
<!--- 1. In the Codefresh UI, go to [Install Hybrid GitOps Runtime](https://g.codefresh.io/2.0/account-settings/runtimes/info/list?drawer=install-codefresh-runtime){:target="\_blank"}.-->
407+
1. In the Codefresh UI, on the toolbar, click the **Settings** icon, and from Runtimes in the sidebar, select [**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
408+
1. Click **+ Add Runtimes**, and then select **Hybrid Runtimes**.
403409
1. Copy the command in _Step 4_ and define the values that are not automatically populated.
404410

405411
{% include
@@ -431,7 +437,6 @@ You can now add [Git Sources]({{site.baseurl}}/installation/gitops/git-sources/)
431437

432438

433439

434-
435440
## Install GitOps Runtime via Terraform
436441

437442
You can also use Terraform to install a GitOps Runtime with the [Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs){:target="\_blank"}.

0 commit comments

Comments
 (0)