feat: environment and stage addons (#13)

* feat: add env and stage addon

* fix: property value validation

* chore: improve type comparision and parsing

* feat: add AddonHandler interface

* feat: implement AddonHandler for project.Cluster

* feat: implement AddonHandler for project.Environment

* feat: implement AddonHandler for project.Stage

* feat: implement text color wraping
feat: implement text color wrapping

* chore: improve addon menu

* feat: implement environment based addon menu

* fix: check type unit tests

* chore: remove debug output

* feat: manage addons on stage level

* chore: sanitize go dependencies

* chore: improve env, stage and cluster gathering

* feat: add cluster properties to addon rendering

* feat: add cluster properties to addon config

* chore: remove overlays folder from .gitignore

* feat: add example PROJECT.yaml, templates and addons

* fix: check type for string

* chore: add further tests for cluster

* chore: add unit tests for environment

* chore: add unit tests for stage

* chore: add tests for addon handling

* fix: nil pointer when one of the addons is not defined on the stage or env level

* chore: update example

Author: leonsteinhaeuser

.gitignore

@@ -1,4 +1,3 @@
-overlays/
 dist/
 
 PROJECT.yaml

PROJECT.example.yaml

@@ -0,0 +1,76 @@
+addons:
+  cluster-policies:
+    defaultEnabled: true
+    group: cluster-configs/policies
+    path: _example/source/addons/cluster-policies
+  disco-operator:
+    defaultEnabled: true
+    group: cluster-configs/policies
+    path: _example/source/addons/disco-operator
+  kyverno:
+    defaultEnabled: true
+    group: cluster-configs
+    path: _example/source/addons/kyverno
+  monitoring:
+    defaultEnabled: false
+    group: cluster-configs
+    path: _example/source/addons/monitoring
+basePath: _example/overlays
+environments:
+  dev:
+    actions:
+      postCreateHooks: null
+      postUpdateHooks: null
+      preCreateHooks: null
+      preUpdateHooks: null
+    addons:
+      cluster-policies:
+        enabled: true
+        properties:
+          enableNetworkPolicies: true
+      disco-operator:
+        enabled: true
+        properties:
+          isSuperCool: true
+          requiredDefaultNotSet: 10
+          second: Hello World
+    properties:
+      gitBranch: develop
+      gitURL: https://github.com/leonsteinhaeuser/openshift-gitops-cli.git
+    stages:
+      dev:
+        actions:
+          postCreateHooks: null
+          postUpdateHooks: null
+          preCreateHooks: null
+          preUpdateHooks: null
+        addons:
+          cluster-policies:
+            enabled: true
+            properties:
+              enableNetworkPolicies: false
+        clusters:
+          hugi:
+            addons:
+              cluster-policies:
+                enabled: true
+                properties:
+                  enableNetworkPolicies: true
+              disco-operator:
+                enabled: true
+                properties:
+                  isSuperCool: false
+                  requiredDefaultNotSet: null
+                  second: Hello World
+              kyverno:
+                enabled: true
+                properties: {}
+              monitoring:
+                enabled: true
+                properties:
+                  ingress_host: https://monitoring.2.external.url
+            properties:
+              destinationNamespace: openshift-gitops
+        properties:
+          destinationServer: https://kubernetes.default.svc
+templateBasePath: _example/source/templates

README.md

@@ -246,3 +246,4 @@ No matter if you define an addon or a template, you always have access to the fo
 | `{{ .Stage }}` | addon, tempate | The stage variable returns the name of the stage we are currently in |
 | `{{ .Cluster }}` | addon, tempate | The cluster variable returns the name of the cluster we are currently in |
 | `{{ .Properties.<key> }}` | addon, tempate | The properties variable returns the value of the property with the key `<key>`. The property keys in addons differ from the property keys in the template, as the addon does not currently have access to the environment, stage or cluster properties. In order for the addon to have properties available, you must define a property key in the `manifest.yaml` file. All properties defined there are then available for your addon template files. |
+| `{{ .ClusterProperties.<key> }}` | addon | The cluster properties is a map that contains all properties that are defined for the cluster. |

_example/README.md

@@ -0,0 +1,3 @@
+# Example
+
+This folder contains an example for the openshift-gitops-cli. The `PROJECT.example.yaml` file contains the configuration for the example project. The `PROJECT.example.yaml` file is an example project config referencing the templates and addons in the `_example/source` folder. The `_example/overlys` folder contains the rendered configuration defined by the cluster defined in the PROJECT.example.yaml file.

_example/overlays/dev/dev/hugi/app-of-apps/kustomization.yaml

@@ -0,0 +1,11 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+helmGlobals:
+  chartHome: ../../../../../../charts/
+helmCharts:
+  - name: argocd-app-of-app
+    version: 0.4.0
+    valuesFile: values.yaml
+    namespace: openshift-gitops
+    releaseName: argocd-app-of-app-0.4.0

_example/overlays/dev/dev/hugi/app-of-apps/values.yaml

@@ -0,0 +1,68 @@
+---
+appSuffix: "hugi-dev"
+appSourceBasePath: overlays/dev/dev/hugi/cluster-configs
+
+default:
+  app:
+    annotations:
+      argocd.argoproj.io/compare-options: IgnoreExtraneous
+    enabled: true
+    enableAutoSync: true
+    autoSyncPrune: true
+    project: hub
+    destination:
+      namespace: openshift-gitops
+      server: https://kubernetes.default.svc
+    source:
+      repoURL: https://github.com/leonsteinhaeuser/openshift-gitops-cli.git
+      targetRevision: <no value>
+
+projects:
+  hub:
+    annotations:
+      argocd.argoproj.io/sync-wave: "-2"
+    description: Project for cluster hub
+    namespace: openshift-gitops
+    sourceRepos:
+      - https://github.com/leonsteinhaeuser/openshift-gitops-cli.git
+    destinations: |
+      - namespace: '*'
+        server: https://kubernetes.default.svc
+    extraFields: |
+      clusterResourceWhitelist:
+      - group: '*'
+        kind: '*'
+
+applications:
+  cluster-policies:
+    enabled: true
+    annotations:
+      argocd.argoproj.io/sync-wave: "0"
+    source:
+      path: cluster-policies
+    labels:
+      app.kubernetes.io/managed-by: argocd
+  disco-operator:
+    enabled: true
+    annotations:
+      argocd.argoproj.io/sync-wave: "0"
+    source:
+      path: disco-operator
+    labels:
+      app.kubernetes.io/managed-by: argocd
+  kyverno:
+    enabled: true
+    annotations:
+      argocd.argoproj.io/sync-wave: "0"
+    source:
+      path: kyverno
+    labels:
+      app.kubernetes.io/managed-by: argocd
+  monitoring:
+    enabled: true
+    annotations:
+      argocd.argoproj.io/sync-wave: "0"
+    source:
+      path: monitoring
+    labels:
+      app.kubernetes.io/managed-by: argocd

_example/overlays/dev/dev/hugi/cluster-configs/kyverno/kustomization.yaml

@@ -0,0 +1,5 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - "../../../../../../base/kyverno/"

_example/overlays/dev/dev/hugi/cluster-configs/kyverno/something.yaml

@@ -0,0 +1 @@
+value: pair

_example/overlays/dev/dev/hugi/cluster-configs/monitoring/kustomization.yaml

@@ -0,0 +1,5 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - "../../../../../../base/monitoring"

_example/overlays/dev/dev/hugi/cluster-configs/policies/cluster-policies/abc.yaml

@@ -0,0 +1,2 @@
+test:
+  hello: world