Skip to content

Commit e78f185

Browse files
committed
Update hybrid-gitops-helm-installation.md
1 parent a71a8e0 commit e78f185

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

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

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This article walks you through the process of installing Hybrid GitOps Runtimes
2020
There are two options for Hybrid GitOps Runtime installation via Helm, each catering to specific use cases:
2121
* **Clean cluster installation with only GitOps**
2222
The _clean cluster_ installation option is suitable for environments where you want to deploy the GitOps Runtime on a cluster without Argo CD.
23-
The installation cluster should be free of Argo project components. GitOps Runtime installation on a clean cluster also installs Argo project components as part of the installation process,
23+
The installation cluster should be free of Argo Project components. GitOps Runtime installation on a clean cluster also installs Argo Project components as part of the installation process,
2424

2525
* **Cluster with existing Argo CD**
2626
If you have a cluster with Argo CD already installed, you can extend it with Codefresh's GitOps capabilities.
@@ -61,9 +61,10 @@ Whether you are installing GitOps on a clean cluster without Argo CD or on a clu
6161

6262
| Prerequisite | GitOps only | GitOps with Argo CD |
6363
|------------------------------------- |:------------: |:-------------: |
64-
| [Argo project components](#gitops-only-argo-project-components) || N/A |
65-
| [Argo project CRDs(Custom Resource Definitions)](#gitops-onlygitops-with-argo-cd-argo-project-crds) |||
66-
| [Synchronize Argo CD chart's minor versions](#gitops-onlygitops-with-argo-cd-argo-project-crds) | N/A ||
64+
| [Argo Project components](#gitops-only-argo-project-components) || N/A |
65+
| [Argo Project CRDs(Custom Resource Definitions)](#gitops-onlygitops-with-argo-cd-argo-project-crds) |||
66+
| [Argo Rollout CRDs(Custom Resource Definitions)](#gitops-onlygitops-with-argo-cd-argo-rollout-crds) |||
67+
| [Synchronize Argo CD chart's minor versions](#gitops-with-argo-cd-synchronize-argo-cd-charts-minor-versions) | N/A ||
6768
| [Set native Argo CD resource tracking to `label](#gitops-with-argo-cd-set-native-argo-cd-resource-tracking-to-label) | N/A ||
6869

6970
### GitOps only: Argo Project components
@@ -81,11 +82,11 @@ Run this script _before_ installation:
8182
```
8283
curl https://raw.githubusercontent.com/codefresh-io/gitops-runtime-helm/main/scripts/adopt-crds.sh | bash -s <runtime-helm-release name> <runtime-namespace>
8384
```
84-
#### Handle Argo project CRDs outside of the chart
85-
Disable CRD installation under the relevant section for each of the Argo projects in the Helm chart:<br>
85+
#### Handle Argo Project CRDs outside of the chart
86+
Disable CRD installation under the relevant section for each of the Argo Projects in the Helm chart:<br>
8687
`--set <argo-project>.crds.install=false`<br>
8788
where:<br>
88-
`<argo-project>` is the argo project component: `argo-cd`, `argo-workflows`, `argo-rollouts` and `argo-events`.
89+
`<argo-project>` is the Argo Project component: `argo-cd`, `argo-workflows`, `argo-rollouts` and `argo-events`.
8990

9091
See [Argo's readme on Helm charts](https://github.com/argoproj/argo-helm/blob/main/README.md){:target="\_blank"}.
9192

@@ -112,7 +113,7 @@ kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{p
112113
### GitOps with Argo CD: Synchronize Argo CD chart's minor versions
113114
To avoid potentially incompatible changes or mismatches, ensure that the native Argo CD instance uses the same upstream version of Argo CD as that used by Codefresh.
114115

115-
1. Get the Argo CD chart version used by Codefresh from the DEPENDENCIES either in ArtifactHub or from the gitops-runtime's `Chart.yaml` in Git:
116+
1. Get the Argo CD chart version used by Codefresh from the Dependencies either in ArtifactHub or from the GitOps Runtime's `Chart.yaml` in Git:
116117
* [ArtifactHub](https://artifacthub.io/packages/helm/codefresh-gitops-runtime/gitops-runtime){:target="\_blank"}:
117118

118119
{% include
@@ -125,7 +126,7 @@ To avoid potentially incompatible changes or mismatches, ensure that the native
125126
max-width="60%"
126127
%}
127128

128-
* [`Chart.yaml`](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/Chart.yaml):
129+
* [Chart.yaml](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/gitops-runtime/Chart.yaml){:target="\_blank"}:
129130

130131
{% include
131132
image.html
@@ -178,7 +179,7 @@ The Codefresh `values.yaml` located [here](https://github.com/codefresh-io/gitop
178179
* For GitOps installation with Argo CD, verify the following:
179180
* [Minor version of Argo CD's Helm chart](#side-by-side-gitops-minor-versions) is identical to the version used by Codefresh
180181
* [Native Argo CD's resource tracking is set to `label`](#side-by-side-gitops-set-native-argo-cd-resource-tracking-to-label)
181-
* Verify there are no Argo Project CRDs in the target namespace or that you have adopted the CRDs (see [Argo project components & CRDs](#argo-project-components--crds))
182+
* Verify there are no Argo Project CRDs in the target namespace or that you have adopted the CRDs (see [Argo Project components & CRDs](#argo-project-components--crds))
182183
* For ingress-based runtimes only, verify that these ingress controllers are configured correctly:
183184
* [Ambassador ingress configuration](#ambassador-ingress-configuration)
184185
* [AWS ALB ingress configuration](#aws-alb-ingress-configuration)
@@ -216,7 +217,7 @@ The Git provider you select for the first GitOps Runtime in your account is used
216217
**Shared Configuration Repository**
217218
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.
218219

219-
**Git provider**
220+
**Git provider**
220221
On-premises Git providers require you to define the API URL:
221222
* GitHub Enterprise: `https://<server-url>/api/v3`
222223
* GitLab Server: `<server-url>/api/v4`
@@ -234,10 +235,10 @@ On-premises Git providers require you to define the API URL:
234235
{% include
235236
image.html
236237
lightbox="true"
237-
file="/images/runtime/helm/helm-install-hybrid-runtime.png"
238-
url="/images/runtime/helm/helm-install-hybrid-runtime.png"
239-
alt="Install Hybrid GitOps Runtime"
240-
caption="Install Hybrid GitOps Runtime"
238+
file="/images/runtime/helm/helm-define-isc-git-provider.png"
239+
url="/images/runtime/helm/helm-define-isc-git-provider.png"
240+
alt="Define Shared Configuration Repo and Git provider"
241+
caption="Define Shared Configuration Repo and Git provider"
241242
max-width="40%"
242243
%}
243244

@@ -252,9 +253,10 @@ Install the Hybrid GitOps Runtime through the Helm chart. The Codefresh `values.
252253
>**TIP**:
253254
Before initiating the installation, Codefresh automatically validates the `values.yaml` file to verify that the supplied values are correct.<br>
254255
If the Helm installation is terminated with the error message: `Job has reached the specified backoff limit`, get more detailed information on the reason for the validation failure with:
255-
256256
`kubectl logs jobs/validate-values -n ${NAMESPACE}`, replacing `{NAMESPACE}` with the namespace of the Hybrid GitOps Runtime.
257257

258+
<br><br>
259+
258260
**Runtime Name**
259261
If you define a custom name for the Hybrid GitOps Runtime, it must start with a lower-case character, and can include up to 62 lower-case characters and numbers.
260262

@@ -271,7 +273,7 @@ You can define one of three different access modes:
271273
**GitOps with Argo CD and Argo Rollouts**
272274
* `fullnameOverride` configuration for resource conflicts
273275
Installing GitOps Runtime on the same cluster as Argo CD can cause conflicts when resources in both native and Codefresh's Argo CD instances have the same name or attempt to control the same objects.
274-
Customizing `fullnameOverride` values for Argo CD and Argo Rollouts if installed in the GitOps Runtime's `values` file prevents these conflicts.
276+
Customizing `fullnameOverride` values for Argo CD, and if installed, Argo Rollouts, in the GitOps Runtime's `values` file prevents these conflicts.
275277

276278
* Resource tracking with `annotation`
277279
Installing GitOps Runtime on the same cluster as Argo CD require that each Argo CD instance uses different methods to track resources. Using the same tracking method can result in conflicts when both instances have applications with the same names or when tracking the same resource. Setting the GitOps Runtime's Argo CD resource tracking to `annotation` prevents such conflicts.

0 commit comments

Comments
 (0)