Allow deleting disappeared groups (#13)

* Allow passing additional parameters to GroupSync

* Update underlying version to `v0.2.0`

* Document new parameter `deleteDisappearedGroups`

* Remove annotation no longer required

class/defaults.yml

@@ -6,7 +6,7 @@ parameters:
       operator:
         registry: quay.io
         repository: appuio/group-sync-operator
-        tag: v0.1.0
+        tag: v0.2.0
 
     manifest_version: ${group_sync_operator:images:operator:tag}
     manifest_url: https://raw.githubusercontent.com/appuio/group-sync-operator/${group_sync_operator:manifest_version}/config

component/config.jsonnet

@@ -41,12 +41,8 @@ local groupSyncs = std.filter(
             name: k,
             namespace: params.namespace,
             labels+: labels,
-            annotations+: {
-              'argocd.argoproj.io/sync-options': 'SkipDryRunOnMissingResource=true',
-            },
           },
-          spec: {
-            schedule: params.sync[k].schedule,
+          spec: params.sync[k] {
             providers: [
               { name: p } + patchProvider(params.sync[k].providers[p])
               for p in std.objectFields(params.sync[k].providers)

docs/modules/ROOT/pages/references/parameters.adoc

@@ -14,15 +14,6 @@ The namespace in which to deploy this component.
 
 [horizontal]
 type:: dictionary
-default::
-+
-[source,yaml]
-----
-operator:
-  registry: quay.io
-  repository: redhat-cop/group-sync-operator
-  tag: v0.0.14
-----
 
 Dictionary containing the container images used by this component.
 
@@ -45,6 +36,15 @@ A crontab based schedule configuration, for when to synchronize the groups.
 If no schedule is provided, synchronization will only occur when the `GroupSync` object is reconciled by the platform.
 
 
+== `sync[].deleteDisappearedGroups`
+
+[horizontal]
+type:: bool
+default:: false
+
+Controls if groups disappeared from the source should be removed. The deletion of groups is provider scoped.
+
+
 == `sync[].providers`
 
 [horizontal]
@@ -92,6 +92,7 @@ parameters:
               scope: sub
       bar:
         schedule: '* * 2 * *'
+        deleteDisappearedGroups: true
         providers:
           bar-azure:
             azure:

tests/defaults.yml

@@ -23,6 +23,7 @@ parameters:
               scope: sub
       other:
         schedule: '* * 2 * *'
+        deleteDisappearedGroups: true
         providers:
           foo:
             azure:

tests/golden/defaults/group-sync-operator/group-sync-operator/00_crds/redhatcop.redhat.io_groupsyncs.yaml

@@ -30,6 +30,9 @@ spec:
             spec:
               description: GroupSyncSpec defines the desired state of GroupSync
               properties:
+                deleteDisappearedGroups:
+                  description: DeleteDisappearedGroups controls if disappeared groups should be removed. The deletion of groups is provider scoped.
+                  type: boolean
                 providers:
                   description: List of Providers that can be mounted by containers belonging to the pod.
                   items:
@@ -574,6 +577,27 @@ spec:
                           - credentialsSecret
                           - url
                         type: object
+                      static:
+                        description: Static represents the Static provider
+                        properties:
+                          groups:
+                            description: Groups represents a list of groups to synchronize
+                            items:
+                              description: StaticProvider allow statically setting Groups
+                              properties:
+                                name:
+                                  description: Name represents the name of the group
+                                  type: string
+                                users:
+                                  description: Users represents a list of users to apply to the synchronized group.
+                                  items:
+                                    type: string
+                                  type: array
+                              required:
+                                - name
+                              type: object
+                            type: array
+                        type: object
                     required:
                       - name
                     type: object

tests/golden/defaults/group-sync-operator/group-sync-operator/02_groupsync.yaml

@@ -1,8 +1,6 @@
 apiVersion: redhatcop.redhat.io/v1alpha1
 kind: GroupSync
 metadata:
-  annotations:
-    argocd.argoproj.io/sync-options: SkipDryRunOnMissingResource=true
   labels:
     app.kubernetes.io/managed-by: commodore
     app.kubernetes.io/name: group-sync-operator
@@ -35,15 +33,14 @@ spec:
 apiVersion: redhatcop.redhat.io/v1alpha1
 kind: GroupSync
 metadata:
-  annotations:
-    argocd.argoproj.io/sync-options: SkipDryRunOnMissingResource=true
   labels:
     app.kubernetes.io/managed-by: commodore
     app.kubernetes.io/name: group-sync-operator
     app.kubernetes.io/part-of: syn
   name: other
   namespace: syn-group-sync-operator
 spec:
+  deleteDisappearedGroups: true
   providers:
     - azure:
         credentialsSecret:

tests/golden/defaults/group-sync-operator/group-sync-operator/20_deployment_group-sync-controller-manager.yaml

@@ -27,7 +27,7 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.namespace
-          image: quay.io/appuio/group-sync-operator:v0.1.0
+          image: quay.io/appuio/group-sync-operator:v0.2.0
           livenessProbe:
             httpGet:
               path: /healthz

tests/golden/empty/group-sync-operator/group-sync-operator/00_crds/redhatcop.redhat.io_groupsyncs.yaml

@@ -30,6 +30,9 @@ spec:
             spec:
               description: GroupSyncSpec defines the desired state of GroupSync
               properties:
+                deleteDisappearedGroups:
+                  description: DeleteDisappearedGroups controls if disappeared groups should be removed. The deletion of groups is provider scoped.
+                  type: boolean
                 providers:
                   description: List of Providers that can be mounted by containers belonging to the pod.
                   items:
@@ -574,6 +577,27 @@ spec:
                           - credentialsSecret
                           - url
                         type: object
+                      static:
+                        description: Static represents the Static provider
+                        properties:
+                          groups:
+                            description: Groups represents a list of groups to synchronize
+                            items:
+                              description: StaticProvider allow statically setting Groups
+                              properties:
+                                name:
+                                  description: Name represents the name of the group
+                                  type: string
+                                users:
+                                  description: Users represents a list of users to apply to the synchronized group.
+                                  items:
+                                    type: string
+                                  type: array
+                              required:
+                                - name
+                              type: object
+                            type: array
+                        type: object
                     required:
                       - name
                     type: object

tests/golden/empty/group-sync-operator/group-sync-operator/20_deployment_group-sync-controller-manager.yaml

@@ -27,7 +27,7 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.namespace
-          image: quay.io/appuio/group-sync-operator:v0.1.0
+          image: quay.io/appuio/group-sync-operator:v0.2.0
           livenessProbe:
             httpGet:
               path: /healthz