Merge pull request #114 from projectsyn/set-noprune

Disable automatic pruning for ArgoCD app

component/app.jsonnet

@@ -30,7 +30,15 @@ local root_app = argocd.App('root', params.namespace, secrets=false) {
   },
 };
 
-local app = argocd.App('argocd', params.namespace, secrets=false);
+local app = argocd.App('argocd', params.namespace, secrets=false) {
+  spec+: {
+    syncPolicy+: {
+      automated+: {
+        prune: false,
+      },
+    },
+  },
+};
 
 {
   '00_syn-project': syn_project,

docs/modules/ROOT/pages/how-tos/upgrade-v5-v6.adoc

@@ -0,0 +1,41 @@
+= Upgrade `component-argocd` from `v5.5.x` to `v6.x`
+
+== Migration to ArgoCD Operator
+
+As of component version 6, the ArgoCD operator is used to manage ArgoCD on the cluster.
+To avoid ArgoCD becoming unavailable during the migration, it has to be prevented from pruning itself until the migration is complete.
+
+
+=== 1. Ensure component-argocd version v5.5.0 or higher is rolled out
+
+component-argocd v5.5.0 or higher disables auto-pruning by default.
+This is required for the migration to succeed.
+Ensure your cluster uses component-argocd v5.5.0 or higher.
+
+=== 2. Ensure Steward version v0.9.0 or higher is installed on the cluster
+
+Steward v0.9.0 and newer supports the migration to component-argocd v6.x.
+Older versions of Steward will interfere with the operator-managed ArgoCD deployment.
+
+Steward version v0.9.0 is introduced in component-steward v3.6.0.
+If you manage Steward via Project Syn, ensure that component-steward v3.6.0 or higher is rolled out on the cluster.
+
+=== 3. Upgrade component-argocd with migration flag
+
+The first time you roll out component-argocd v6.x, set the following configuration in your hierarchy:
+
+[source,yaml]
+----
+parameters:
+  argocd:
+    operator:
+      migrate: true
+----
+
+Roll out the upgrade with this configuration, and wait until the new pods for `syn-argocd` appear in the configured namespace.
+
+=== 4. Remove the migration flag to complete the migration
+
+After the first rollout of v6.x, the migration flag can be removed.
+Once this change is rolled out, ArgoCD can become unavailable for up to 15 minutes, after which it should recover without manual intervention.
+

docs/modules/ROOT/partials/nav.adoc

@@ -2,6 +2,7 @@
 
 .How-tos
 * xref:how-tos/upgrade-v3-v4.adoc[Upgrade from `v3.x` to `v4.x`]
+* xref:how-tos/upgrade-v5-v6.adoc[Upgrade from `v5.5.x` to `v6.x`]
 
 .References
 * xref:references/parameters.adoc[Parameters]

tests/golden/defaults/argocd/apps/10_argocd.yaml

@@ -18,5 +18,5 @@ spec:
     targetRevision: HEAD
   syncPolicy:
     automated:
-      prune: true
+      prune: false
       selfHeal: true

tests/golden/openshift/argocd/apps/10_argocd.yaml

@@ -18,5 +18,5 @@ spec:
     targetRevision: HEAD
   syncPolicy:
     automated:
-      prune: true
+      prune: false
       selfHeal: true

tests/golden/params/argocd/apps/10_argocd.yaml

@@ -18,5 +18,5 @@ spec:
     targetRevision: HEAD
   syncPolicy:
     automated:
-      prune: true
+      prune: false
       selfHeal: true