Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitea2ebc1

Browse files
authored
Update runtime-prerequisites.md (#1223)
* Update runtime-prerequisites.md* Update runtime-prerequisites.md* Update runtime-prerequisites.md* Update runtime-prerequisites.md* Update runtime-prerequisites.md* Update runtime-prerequisites.md* Update runtime-prerequisites.md* Update runtime-prerequisites.md* Update runtime-prerequisites.md
1 parent5574816 commitea2ebc1

File tree

1 file changed

+52
-37
lines changed

1 file changed

+52
-37
lines changed

‎_docs/installation/gitops/runtime-prerequisites.md‎

Lines changed: 52 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,50 @@ Before installing GitOps Runtimes, ensure you meet the [system requirements]({{s
1010
##Prerequisites summary
1111
This table lists the prerequisites for installing a GitOps Runtime, depending on the installation mode.
1212

13+
{% if page.collection != site.gitops_collection %}
1314
{: .table .table-bordered .table-hover}
14-
|**Prerequisite** |**Runtime with existing Argo CD** |**Runtime with new Argo CD** |{% if page.collection != site.gitops_collection %}**Runtime with Community Argo CD** |{% endif %}
15-
|--------------------|---------------------------|----------------------------|{% if page.collection != site.gitops_collection %} ----------------------------|{% endif %}
16-
|[Switch ownership of Argo Project CRDs](#switch-ownership-of-argo-project-crds) | ✅ | ✅ |{% if page.collection != site.gitops_collection %}✅ |{% endif %}
17-
|[Configure connectivity with Argo CD services](#configure-connectivity-with-argo-cd-services-existing-argo-only) | ✅ | - | {% if page.collection != site.gitops_collection %}-|{% endif %}
18-
|[Verify Argo CD root path configuration](#verify-argo-cd-root-path-configuration-existing-argo-only) | ✅ | - | {% if page.collection != site.gitops_collection %}-|{% endif %}
19-
|[Remove Argo Project and SealedSecret components](#remove-argo-project-and-sealedsecret-components-new-argo-only) | - | ✅ | {% if page.collection != site.gitops_collection %}-|{% endif %}
20-
{% if page.collection != site.gitops_collection %}|[Align Argo CD chart’s minor versions](#align-argo-cd-charts-minor-versions-community-argo-only) | - | - | ✅ |
21-
|[Set Community Argo CD resource tracking to label](#set-resource-tracking-to-label-for-existing-argo-cd-instance-community-argo-only) | - | - | ✅ |{% endif %}
15+
|**Prerequisite**|**Runtime with existing Argo CD**|**Runtime with new Argo CD**|**Runtime with Community Argo CD**|
16+
|--------------------|---------------------------|----------------------------| ----------------------------|
17+
|[Remove Argo Project and SealedSecret components](#remove-argo-project-and-sealedsecret-components-new-argo-only)| ✅| ✅| -|
18+
|[Switch ownership of Argo Project CRDs](#switch-ownership-of-argo-project-crds)| -| ✅|✅|
19+
|[Configure connectivity with Argo CD services](#configure-connectivity-with-argo-cd-services-existing-argo-only)| ✅| -| -|
20+
|[Verify Argo CD root path configuration](#verify-argo-cd-root-path-configuration-existing-argo-only)| ✅| -| -|
21+
|[Align Argo CD chart’s minor versions](#align-argo-cd-charts-minor-versions-community-argo-only)| -| -| ✅|
22+
|[Set Community Argo CD resource tracking to label](#set-resource-tracking-to-label-for-existing-argo-cd-instance-community-argo-only)| -| -| ✅|
23+
{% endif %}
24+
25+
{% if page.collection == site.gitops_collection %}
26+
{: .table .table-bordered .table-hover}
27+
|**Prerequisite**|**Runtime with existing Argo CD**|**Runtime with new Argo CD**|
28+
|--------------------|---------------------------|----------------------------|
29+
|[Remove Argo Project and SealedSecret components](#remove-argo-project-and-sealedsecret-components-new-argo-only)| ✅| ✅|
30+
|[Configure connectivity with Argo CD services](#configure-connectivity-with-argo-cd-services-existing-argo-only)| ✅| -|
31+
|[Verify Argo CD root path configuration](#verify-argo-cd-root-path-configuration-existing-argo-only)| ✅| -|
32+
{% endif %}
2233

34+
{% if page.collection == site.gitops_collection %}
35+
##Remove Argo Project and SealedSecret components
36+
For GitOps Runtime installation with_an existing Argo CD instance, the target cluster should not have_:
37+
* Argo Project components:
38+
* Argo Workflows
39+
* Argo Events
40+
* Argo Rollouts
41+
* SealedSecret controller components
42+
{% endif %}
2343

44+
{% if page.collection != site.gitops_collection %}
45+
##Remove Argo Project and SealedSecret components
46+
For GitOps Runtime installation, the_target cluster should not have_:
47+
* SealedSecret controller components
48+
* For an_existing Argo CD instance_:
49+
* Argo Workflows
50+
* Argo Events
51+
* Argo Rollouts
52+
* For a_new Argo CD instance_:
53+
* Argo Rollouts
54+
* Argo CD
55+
* Argo Events
56+
* Argo Workflows
2457

2558
##Switch ownership of Argo Project CRDs
2659
If you have Argo Project CRDs on your cluster, you must decide how to manage them when installing the GitOps Runtime.
@@ -29,38 +62,24 @@ The table below lists the options available depending on your installation mode.
2962
{: .table .table-bordered .table-hover}
3063
|**Option**|**Description**|**Applicable Installation Modes**|
3164
|------------|---------------|---------------------------------|
32-
|**Adopt all Argo Project CRDs**| Transfers ownership of all CRDs to the GitOps Runtime, ensuring they are automatically upgraded with the Runtime.| {::nomarkdown}<ul><li>Runtime with new Argo CD</li>{% if page.collection != site.gitops_collection %}<li>Runtime alongside Community Argo CD</li>{% endif %}</ul>{:/}|
33-
|**Adopt all Argo Project CRD except Argo CD CRDs**| Transfers ownership of Workflows, Rollouts, and Events CRDs to the GitOps Runtime but leaves Argo CD CRDs managed by an existing Argo CD installation.| {::nomarkdown}<ul><li>Runtime with existing Argo CD</li></ul>{:/}|
34-
|**Adopt only Argo Rollout CRDs**| Transfers ownership of only Rollout CRDs to the GitOps Runtime.| {::nomarkdown}<ul><li>Runtime with existing Argo CD</li><li>Runtime with new Argo CD</li>{% if page.collection != site.gitops_collection %}<li>Runtime alongside Community Argo CD</li>{% endif %}</ul>{:/}|
35-
|**Handle CRDs outside the GitOps Runtime**| Manage CRDs externally, by disabling installation for each type of CRD in the Helm chart. This options requires to manually upgrade and maintain the CRDs.| {::nomarkdown}<ul><li>Runtime with existing Argo CD</li><li>Runtime with new Argo CD</li>{% if page.collection != site.gitops_collection %}<li>Runtime alongside Community Argo CD</li>{% endif %}</ul>{:/}|
36-
65+
|**Adopt all Argo Project CRDs**| Transfers ownership of all CRDs to the GitOps Runtime, ensuring they are automatically upgraded with the Runtime.| {::nomarkdown}<ul><li>Runtime with new Argo CD</li><li>Runtime alongside Community Argo CD</li></ul>{:/}|
66+
|**Adopt only Argo Rollout CRDs**| Transfers ownership of only Rollout CRDs to the GitOps Runtime.| {::nomarkdown}<ul><li>Runtime with new Argo CD</li><li>Runtime alongside Community Argo CD</li></ul>{:/}|
67+
|**Handle CRDs outside the GitOps Runtime**| Manage CRDs externally, by disabling installation for each type of CRD in the Helm chart.| {::nomarkdown}<ul><li>Runtime with new Argo CD</li><li>Runtime alongside Community Argo CD</li></ul>{:/}|
3768

3869

39-
###Option 1: Adopt all Argo Project CRDs
70+
###Option: Adopt all Argo Project CRDs
4071
Adopt all Argo Project CRDs to transfer their ownership to the GitOps Runtime.
4172
The GitOps Runtime manages them as part of the GitOps Runtime Helm chart:
4273
* The CRDs are automatically upgraded whenever the Runtime is upgraded.
4374
* They remain compatible with the GitOps environment.
4475

45-
4676
#####Script to adopt all Argo Project CRDs
4777
* Run this script_before_ installation:
4878
```
4979
curl https://raw.githubusercontent.com/codefresh-io/gitops-runtime-helm/main/scripts/adopt-crds.sh | bash -s <runtime-helm-release name> <runtime-namespace>
5080
```
5181

52-
53-
###Option 2: Adopt All CRDs except Argo CD CRDs (Existing Argo CD only)
54-
If you are installing the GitOps Runtime with an existing Argo CD instance, you can adopt all Argo Project CRDs, excluding Argo CD CRDs.
55-
This ensures that:
56-
* Workflows, Rollouts, and Events CRDs are managed by the GitOps Runtime.
57-
* Argo CD CRDs remain under the control of your existing Argo CD installation, avoiding conflicts.
58-
59-
#####Script to exclude Argo CD CRDs
60-
Run this script before installation:
61-
62-
63-
###Option 3: Adopt only Argo Rollout CRDs
82+
###Option: Adopt only Argo Rollout CRDs
6483
Adopting only Argo Rollouts CRDs ensures that there is only one active Argo Rollouts controller active on the cluster with the GitOps Runtime.
6584

6685

@@ -74,14 +93,16 @@ kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{p
7493
kubectl annotate --overwrite crds $(kubectl get crd | grep argoproj.io | awk '{print $1}' | xargs) meta.helm.sh/release-namespace=$NAMESPACE
7594
```
7695

77-
###Option 4: Handle Argo Project CRDs outside of the Runtime chart
96+
###Option: Handle Argo Project CRDs outside of the Runtime chart
7897

7998
* Disable CRD installation under the relevant section for each of the Argo Projects in the Helm chart:<br>
8099
`--set <argo-project>.crds.install=false`<br>
81100
where:<br>
82101
`<argo-project>` is the Argo Project component:`argo-cd`,`argo-workflows`,`argo-rollouts` and`argo-events`.
83102

103+
84104
See[Argo's readme on Helm charts](https://github.com/argoproj/argo-helm/blob/main/README.md){:target="\_blank"}.
105+
{% endif %}
85106

86107
##Configure connectivity with Argo CD services (Existing Argo only)
87108

@@ -95,14 +116,15 @@ There are two options to configure service discovery:
95116
* Auto-detection via labels
96117
* Configuring service names and ports in the Runtime's`values.yaml` file.
97118

119+
98120
###Configure auto-detect for Argo CD services
99121
Assign the correct labels to the Argo CD services for the GitOps Runtime to auto-detect them.
100122
*`argocd-server`:`app.kubernetes.io/component=server,app.kubernetes.io/part-of=argocd`
101123
*`argocd-repo-server`:`app.kubernetes.io/component=repo-server,app.kubernetes.io/part-of=argocd`
102124
*`argocd-redis`:`app.kubernetes.io/component=redis,app.kubernetes.io/part-of=argocd`
103125

104-
Run this script to verify if the labels are correctly assigned:
105-
<!--- add the script-->
126+
127+
<!---Run this script to verify if the labels are correctly assigned:add the script-->
106128

107129
###Manually configure service names and ports in values.yaml
108130
If auto-detection is not feasible, configure the names and ports for each of the Argo CD services in the Runtime's`values.yaml` file located[here](https://github.com/codefresh-io/gitops-runtime-helm/blob/main/charts/installation/gitops/){:target="\_blank"}.
@@ -138,13 +160,6 @@ global:
138160
...
139161
```
140162

141-
##Remove Argo Project and SealedSecret components (New Argo only)
142-
For GitOps Runtime installation with a new Argo CD instance, the_target cluster should not have_:
143-
* Argo Project components: Argo Rollouts, Argo CD, Argo Events, and Argo Workflows.
144-
* SealedSecret controller components.
145-
146-
147-
148163
{% if page.collection != site.gitops_collection %}
149164
##Align Argo CD chart's minor versions (Community Argo only)
150165
To avoid potentially incompatible changes or mismatches, ensure that the Runtime installation with an existing Argo CD instance uses the same upstream version of Argo CD used by Codefresh.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp