feat: environment and stage addons

.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

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

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

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

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

_example/overlays/dev/dev/hugi/cluster-configs/policies/cluster-policies/config/sub/abc2.yaml

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

_example/overlays/dev/dev/hugi/cluster-configs/policies/cluster-policies/config/sub/kustomization.yaml

@@ -0,0 +1,5 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - config/abc.yaml

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

@@ -0,0 +1,6 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - config/abc.yaml
+  - "../../../../../../base/base-config/cluster-policies/"

_example/overlays/dev/dev/hugi/cluster-configs/policies/disco-operator/kustomization.yaml

@@ -0,0 +1,8 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - "../../../../../../base/disco-operator/"
+patches:
+- name: Hello World
+  file: patch.yaml

_example/overlays/dev/dev/hugi/cluster-configs/policies/disco-operator/patch.yaml

@@ -0,0 +1,3 @@
+---
+some: yaml
+key: false

_example/source/addons/cluster-policies/config/abc.yaml

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

_example/source/addons/cluster-policies/config/sub/abc2.yaml

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

_example/source/addons/cluster-policies/kustomization.yaml

@@ -0,0 +1,8 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - config/abc.yaml
+  {{- if .Properties.enableNetworkPolicies}}
+  - "../../../../../../base/base-config/cluster-policies/"
+  {{- end}}

_example/source/addons/cluster-policies/manifest.yaml

@@ -0,0 +1,12 @@
+name: cluster-policies
+group: cluster-policies
+annotations:
+  argocd.argoproj.io/sync-wave: "0"
+properties:
+  enableNetworkPolicies:
+    required: false
+    default: false
+    type: bool
+    description: "Whether to enable the cluster wide network policies"
+files:
+  - ./

_example/source/addons/disco-operator/kustomization.yaml

@@ -0,0 +1,8 @@
+---
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - "../../../../../../base/disco-operator/"
+patches:
+- name: {{ .Properties.second }}
+  file: patch.yaml

_example/source/addons/disco-operator/manifest.yaml

@@ -0,0 +1,23 @@
+name: disco-operator
+group: cluster-policies
+annotations:
+  argocd.argoproj.io/sync-wave: "0"
+properties:
+  isSuperCool:
+    required: false
+    default: false
+    type: bool
+    description: "Is this app super cool?"
+  second:
+    required: true
+    default: "Hello World"
+    type: string
+    description: "Second?"
+  requiredDefaultNotSet:
+    required: true
+    default: null
+    type: int
+    description: "An empty property that is required"
+files:
+  - kustomization.yaml
+  - patch.yaml

_example/source/addons/disco-operator/patch.yaml

@@ -0,0 +1,3 @@
+---
+some: yaml
+key: {{ .Properties.isSuperCool }}

_example/source/addons/kyverno/kustomization.yaml

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

_example/source/addons/kyverno/manifest.yaml

@@ -0,0 +1,7 @@
+name: kyverno
+group: cluster-policies
+annotations:
+  argocd.argoproj.io/sync-wave: "0"
+properties: {}
+files:
+  - ./

_example/source/addons/kyverno/something.yaml

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

_example/source/addons/monitoring/kustomization.yaml

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

_example/source/addons/monitoring/manifest.yaml

@@ -0,0 +1,12 @@
+name: cluster-policies
+group: cluster-policies
+annotations:
+  argocd.argoproj.io/sync-wave: "0"
+properties:
+  ingress_host:
+    required: false
+    default: false
+    type: string
+    description: "The host to expose grafana on"
+files:
+  - ./

_example/source/templates/appofapps/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/source/templates/appofapps/manifest.yaml

@@ -0,0 +1,13 @@
+name: app-of-apps
+properties:
+  gitURL:
+    required: true
+    default: ""
+    descriptionL: "Please define the git URL ArgoCD should reference"
+  targetRevision:
+    required: false
+    default: "develop"
+    description: "Please define the git target revision ArgoCD should reference"
+files:
+  - values.yaml
+  - kustomization.yaml

_example/source/templates/appofapps/values.yaml

@@ -0,0 +1,46 @@
+---
+appSuffix: "{{ .ClusterName }}-{{ .Stage }}"
+appSourceBasePath: overlays/{{ .Environment }}/{{ .Stage }}/{{ .ClusterName }}/cluster-configs
+
+default:
+  app:
+    annotations:
+      argocd.argoproj.io/compare-options: IgnoreExtraneous
+    enabled: true
+    enableAutoSync: true
+    autoSyncPrune: true
+    project: hub
+    destination:
+      namespace: {{ .Properties.destinationNamespace }}
+      server: {{ .Properties.destinationServer }}
+    source:
+      repoURL: {{ .Properties.gitURL }}
+      targetRevision: {{ .Properties.gitTargetRevision }}
+
+projects:
+  hub:
+    annotations:
+      argocd.argoproj.io/sync-wave: "-2"
+    description: Project for cluster hub
+    namespace: openshift-gitops
+    sourceRepos:
+      - {{ .Properties.gitURL }}
+    destinations: |
+      - namespace: '*'
+        server: {{ .Properties.destinationServer }}
+    extraFields: |
+      clusterResourceWhitelist:
+      - group: '*'
+        kind: '*'
+
+applications:
+  {{- range $key, $value := .Addons }}
+  {{ $key }}:
+    enabled: {{ $value.Enabled }}
+    annotations:
+    {{- $value.Annotations | toYaml | nindent 6 }}
+    source:
+      path: {{ $key }}
+    labels:
+      app.kubernetes.io/managed-by: argocd
+  {{- end }}