doc(argocd): add ignoreDifferences to prevent application out of sync

Signed-off-by: Yang Chiu <[email protected]>

Author: yangchiu

content/docs/1.10.0/deploy/install/install-with-argocd.md

@@ -56,6 +56,36 @@ weight: 13
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```

content/docs/1.6.0/deploy/install/install-with-argocd.md

@@ -50,12 +50,42 @@ weight: 13
           repoURL: https://charts.longhorn.io/
           targetRevision: v{{< current-version >}} # Replace with the Longhorn version you'd like to install or upgrade to
           helm:
-            valuesObject:
+            values: |
               preUpgradeChecker:
                 jobEnabled: false
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```

content/docs/1.6.1/deploy/install/install-with-argocd.md

@@ -56,6 +56,36 @@ weight: 13
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```

content/docs/1.6.2/deploy/install/install-with-argocd.md

@@ -41,6 +41,9 @@ weight: 13
       name: longhorn
       namespace: argocd
     spec:
+      syncPolicy:
+        syncOptions:
+          - CreateNamespace=true
       project: default
       sources:
         - chart: longhorn
@@ -53,6 +56,36 @@ weight: 13
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```

content/docs/1.6.3/deploy/install/install-with-argocd.md

@@ -41,18 +41,51 @@ weight: 13
       name: longhorn
       namespace: argocd
     spec:
+      syncPolicy:
+        syncOptions:
+          - CreateNamespace=true
       project: default
       sources:
         - chart: longhorn
           repoURL: https://charts.longhorn.io/
           targetRevision: v{{< current-version >}} # Replace with the Longhorn version you'd like to install or upgrade to
           helm:
             values: |
-              helmPreUpgradeCheckerJob:
-                enabled: false
+              preUpgradeChecker:
+                jobEnabled: false
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```

content/docs/1.6.4/deploy/install/install-with-argocd.md

@@ -41,18 +41,51 @@ weight: 13
       name: longhorn
       namespace: argocd
     spec:
+      syncPolicy:
+        syncOptions:
+          - CreateNamespace=true
       project: default
       sources:
         - chart: longhorn
           repoURL: https://charts.longhorn.io/
           targetRevision: v{{< current-version >}} # Replace with the Longhorn version you'd like to install or upgrade to
           helm:
             values: |
-              helmPreUpgradeCheckerJob:
-                enabled: false
+              preUpgradeChecker:
+                jobEnabled: false
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```

content/docs/1.6.5/deploy/install/install-with-argocd.md

@@ -41,18 +41,51 @@ weight: 13
       name: longhorn
       namespace: argocd
     spec:
+      syncPolicy:
+        syncOptions:
+          - CreateNamespace=true
       project: default
       sources:
         - chart: longhorn
           repoURL: https://charts.longhorn.io/
           targetRevision: v{{< current-version >}} # Replace with the Longhorn version you'd like to install or upgrade to
           helm:
             values: |
-              helmPreUpgradeCheckerJob:
-                enabled: false
+              preUpgradeChecker:
+                jobEnabled: false
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```

content/docs/1.7.0/deploy/install/install-with-argocd.md

@@ -56,6 +56,36 @@ weight: 13
       destination:
         server: https://kubernetes.default.svc
         namespace: longhorn-system
+      # add ignoreDifferences to prevent preserveUnknownFields field from make causing the application to be out of sync
+      ignoreDifferences:
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engineimages.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: engines.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: instancemanagers.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: nodes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: replicas.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: settings.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
+        - group: apiextensions.k8s.io
+          kind: CustomResourceDefinition
+          name: volumes.longhorn.io
+          jsonPointers: ["/spec/preserveUnknownFields"]
     EOF
     kubectl apply -f longhorn-application.yaml
     ```