feat(cloudflareddns): BREAKING CHANGE - Rewrite GUI (#5995)

* fix(cloudflareddns) validate cf hosts and zones

* add _secrets.tpl and major gui overhaul

* fix _secret.tpl variables

* remove variable from zone variable

* fix zones variable

* fix variable

* make some cchanges

* update regex

* update doc

* whoops

* fix CF_HOSTS variable

* Update charts/stable/cloudflareddns/Chart.yaml

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

Signed-off-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

charts/stable/cloudflareddns/Chart.yaml

@@ -1,33 +1,31 @@
 apiVersion: v2
-kubeVersion: ">=1.16.0-0"
-name: cloudflareddns
-version: 3.0.10
 appVersion: "latest"
-description: Update your Cloudflare DNS records automatically for those with a dynamic IP
-type: application
-deprecated: false
-home: https://truecharts.org/charts/stable/cloudflareddns
-icon: https://truecharts.org/img/hotlink-ok/chart-icons/cloudflareddns.png
-keywords:
-  - ddns
-  - cloudflare
-  - cloudflareddns
-sources:
-  - https://github.com/truecharts/charts/tree/master/charts/stable/cloudflareddns
-  - https://github.com/hotio/cloudflareddns
-  - https://hotio.dev/containers/cloudflareddns/
 dependencies:
   - name: common
     repository: https://library-charts.truecharts.org
     version: 11.1.2
-    # condition:
+deprecated: false
+description: Automate Cloudflare DNS records for those with a dynamic IP.
+home: https://truecharts.org/charts/stable/cloudflareddns
+icon: https://truecharts.org/img/hotlink-ok/chart-icons/cloudflareddns.png
+keywords:
+  - cloudflareddns
+  - ddns
+  - cloudflare
+kubeVersion: ">=1.16.0-0"
 maintainers:
   - email: info@truecharts.org
     name: TrueCharts
     url: https://truecharts.org
+name: cloudflareddns
+sources:
+  - https://github.com/truecharts/charts/tree/master/charts/stable/cloudflareddns
+  - https://github.com/hotio/cloudflareddns
+  - https://hotio.dev/containers/cloudflareddns/
+type: application
+version: 4.0.0
 annotations:
   truecharts.org/catagories: |
-    - incubator
     - networking
   truecharts.org/SCALE-support: "true"
   truecharts.org/grade: U

charts/stable/cloudflareddns/docs/validation.md

@@ -0,0 +1,31 @@
+# Input Validation
+
+**`CF Hosts`**
+
+**Not** accepted domains are:
+
+- Domain ending in `.cf` (eg. `example.cf`)
+- Domain ending in `.ga` (eg. `example.ga`)
+- Domain ending in `.gq` (eg. `example.gq`)
+- Domain ending in `.ml` (eg. `example.ml`)
+- Domain ending in `.tk` (eg. `example.tk`)
+
+Regex used to match this: `^((?!(\.cf|\.ga|\.gq|\.ml|\.tk)$).)*$`
+You can try live [here](https://regex101.com/r/rZBln5/1)
+
+**`CF Zones`**
+
+**Not** accepted domains are:
+
+- Domain ending in `.cf` (eg. `example.cf`)
+- Domain ending in `.ga` (eg. `example.ga`)
+- Domain ending in `.gq` (eg. `example.gq`)
+- Domain ending in `.ml` (eg. `example.ml`)
+- Domain ending in `.tk` (eg. `example.tk`)
+
+Regex used to match this: `^((?!(\.cf|\.ga|\.gq|\.ml|\.tk)$).)*$`
+You can try live [here](https://regex101.com/r/rZBln5/1)
+
+---
+
+_If you find a field that you think it needs validation, please open an issue on github_

charts/stable/cloudflareddns/questions.yaml

@@ -6,111 +6,129 @@ questions:
 # Include{replicas}
 # Include{replica1}
 # Include{controllerExpertExtraArgs}
-  - variable: secretEnv
+  - variable: cloudflareddns
-    group: "App Configuration"
+    group: App Configuration
-    label: "Image Secrets"
+    label: Cloudflareddns Configuration
     schema:
       additional_attrs: true
       type: dict
       attrs:
-        - variable: CF_APITOKEN
+        - variable: user
-          label: "CF_APITOKEN"
+          label: CF User
+          description: Cloudflare Username (eg. your.cf.email@example.com)
+          schema:
+            type: string
+            default: ""
+        - variable: api_token
+          label: CF API Token
           schema:
             type: string
             private: true
             default: ""
-        - variable: CF_APIKEY
+        - variable: api_key
-          label: "CF_APIKEY"
+          label: CF API Key
           schema:
             type: string
             private: true
             default: ""
-        - variable: CF_APITOKEN_ZONE
+        - variable: api_token_zone
-          label: "CF_APITOKEN_ZONE"
+          label: CF API Token Zone
           schema:
             type: string
             private: true
             default: ""
-  - variable: env
+        - variable: interval
-    group: "App Configuration"
+          label: Interval
-    label: "Image Environment"
+          description: Update your DDNS interval in seconds
-    schema:
-      additional_attrs: true
-      type: dict
-      attrs:
-        - variable: INTERVAL
-          label: "INTERVAL"
-          description: "Update your DDNS interval in seconds"
           schema:
             type: int
             default: 300
-        - variable: LOG_LEVEL
+            min: 60
-          label: "LOG_LEVEL"
+        - variable: detect_mode
-          description: "Level of detail your logs need"
+          label: Detection Mode
+          description: How you want to get your WAN IP
+          schema:
+            type: string
+            default: dig-whoami.cloudflare
+            enum:
+              - value: dig-whoami.cloudflare
+                description: dig-whoami.cloudflare
+              - value: curl-ifconfig.co
+                description: curl-ifconfig.co
+              - value: curl-icanhazip.com
+                description: curl-icanhazip.com
+              - value: curl-wtfismyip.com
+                description: curl-wtfismyip.com
+              - value: curl-showmyip.ca
+                description: curl-showmyip.ca
+              - value: curl-da.gd
+                description: curl-da.gd
+              - value: curl-seeip.org
+                description: curl-seeip.org
+              - value: dig-google.com
+                description: dig-google.com
+              - value: dig-opendns.com
+                description: dig-opendns.com
+        - variable: detect_override
+          label: Detection mode Override
+          description: If you want to set DETECTION_MODE to 'local:eth0' for a local interface, this will override the dropdown selection
+          schema:
+            type: string
+            default: ""
+        - variable: log_level
+          label: Log Level
+          description: Level of detail your logs need
           schema:
             type: int
             default: 3
-        - variable: DETECT_MODE
-          label: "DETECTION_MODE"
-          description: "How you want to get your WAN IP"
-          schema:
-            type: string
-            default: "dig-whoami.cloudflare"
             enum:
-              - value: "dig-whoami.cloudflare"
+              - value: 0
-                description: "dig-whoami.cloudflare"
+                description: No log output
-              - value: "curl-ifconfig.co"
+              - value: 1
-                description: "curl-ifconfig.co"
+                description: UPDATE, WARNING, ERROR
-              - value: "curl-icanhazip.com"
+              - value: 2
-                description: "curl-icanhazip.com"
+                description: UPDATE, WARNING, ERROR, INFO
-              - value: "curl-wtfismyip.com"
+              - value: 3
-                description: "curl-wtfismyip.com"
+                description: UPDATE, WARNING, ERROR, INFO, DEBUG
-              - value: "curl-showmyip.ca"
+        - variable: host_zone_record
-                description: "curl-showmyip.ca"
+          label: Hosts, Zones and Record Types
-              - value: "curl-da.gd"
-                description: "curl-da.gd"
-              - value: "curl-seeip.org"
-                description: "curl-seeip.org"
-              - value: "dig-google.com"
-                description: "dig-google.com"
-              - value: "dig-opendns.com"
-                description: "dig-opendns.com"
-        - variable: DETECT_OVERRIDE
-          label: "DETECTION_MODE_OVERRIDE"
-          description: "If you want to set DETECTION_MODE to 'local:eth0' for a local interface, this will override the dropdown selection"
           schema:
-            type: string
+            type: list
-            default: ""
+            default: []
-        - variable: CF_USER
+            items:
-          label: "CF_USER"
+              - variable: hostRecordEntry
-          description: "Cloudflare Username (eg. your.cf.email@example.com)"
+                label: Host, Zone and Record Type Entry
-          schema:
+                schema:
-            type: string
+                  type: dict
-            default: ""
+                  additional_attrs: true
-        - variable: CF_HOSTS
+                  attrs:
-          label: "CF_HOSTS"
+                    - variable: domain
-          description: "Cloudflare Hosts (Domains) (eg. test.example.com;test.foobar.com)"
+                      label: Domain
-          schema:
+                      schema:
-            type: string
+                        type: string
-            default: ""
+                        required: true
-        - variable: CF_ZONES
+                        default: "example.com"
-          label: "CF_ZONES"
+                        valid_chars: '^((?!(\.cf|\.ga|\.gq|\.ml|\.tk)$).)*$'
-          description: "Cloudflare DNS Zones (eg. example.com;foobar.com;foobar.com)"
+                    - variable: zone
-          schema:
+                      label: Zone
-            type: string
+                      schema:
-            default: ""
+                        type: string
-        - variable: CF_RECORDTYPES
+                        required: true
-          label: "CF_RECORDTYPES"
+                        valid_chars: '^((?!(\.cf|\.ga|\.gq|\.ml|\.tk)$).)*$'
-          description: "Cloudflare DNS Zones"
+                        default: ""
-          schema:
+                    - variable: type
-            type: string
+                      label: Record Type
-            default: "A;A;AAAA"
+                      schema:
+                        type: string
+                        required: true
+                        default: "A"
+
 # Include{containerConfig}
 # Include{serviceList}
 # Include{persistenceRoot}
         - variable: config
-          label: "App Config Storage"
+          label: App Config Storage
-          description: "Stores the Application Configuration."
+          description: Stores the Application Configuration.
           schema:
             additional_attrs: true
             type: dict
@@ -120,41 +138,41 @@ questions:
 # Include{security}
 # Include{securityContextAdvancedRoot}
               - variable: privileged
-                label: "Privileged mode"
+                label: Privileged mode
                 schema:
                   type: boolean
                   default: false
               - variable: readOnlyRootFilesystem
-                label: "ReadOnly Root Filesystem"
+                label: ReadOnly Root Filesystem
                 schema:
                   type: boolean
                   default: false
               - variable: allowPrivilegeEscalation
-                label: "Allow Privilege Escalation"
+                label: Allow Privilege Escalation
                 schema:
                   type: boolean
                   default: false
               - variable: runAsNonRoot
-                label: "runAsNonRoot"
+                label: runAsNonRoot
                 schema:
                   type: boolean
                   default: false
 # Include{podSecurityContextRoot}
         - variable: runAsUser
-          label: "runAsUser"
+          label: runAsUser
-          description: "The UserID of the user running the application"
+          description: The UserID of the user running the application
           schema:
             type: int
             default: 0
         - variable: runAsGroup
-          label: "runAsGroup"
+          label: runAsGroup
-          description: "The groupID this App of the user running the application"
+          description: The groupID this App of the user running the application
           schema:
             type: int
             default: 0
         - variable: fsGroup
-          label: "fsGroup"
+          label: fsGroup
-          description: "The group that should own ALL storage."
+          description: The group that should own ALL storage.
           schema:
             type: int
             default: 568

charts/stable/cloudflareddns/templates/_secret.tpl

@@ -0,0 +1,40 @@
+{{/* Define the secret */}}
+{{- define "cloudflareddns.secret" -}}
+
+{{- $secretName := printf "%s-secret" (include "tc.common.names.fullname" .) }}
+{{- $cfddns := .Values.cloudflareddns -}}
+{{- $domains := list }}
+{{- $records := list }}
+{{- $zones := list }}
+{{- range $item := $cfddns.host_and_record }}
+  {{- $domains = mustAppend $domains $item.domain }}
+  {{- $records = mustAppend $records $item.record }}
+  {{- $zones = mustAppend $zones $item.zone }}
+{{- end }}
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ $secretName }}
+  labels:
+    {{- include "tc.common.labels" . | nindent 4 }}
+stringData:
+  {{- with $cfddns.user }}
+  CF_USER: {{ . | quote }}
+  {{- end }}
+  {{- with $cfddns.api_key }}
+  CF_APIKEY: {{ . | quote }}
+  {{- end }}
+  {{- with $cfddns.api_token }}
+  CF_APITOKEN: {{ . | quote }}
+  {{- end }}
+  {{- with $cfddns.api_token_zone }}
+  CF_APITOKEN_ZONE: {{ . | quote }}
+  {{- end }}
+  INTERVAL: {{ $cfddns.interval | quote }}
+  LOG_LEVEL: {{ $cfddns.log_level | quote }}
+  DETECTION_MODE: {{ $cfddns.detect_override | default $cfddns.detect_mode | quote }}
+  CF_ZONES: {{ join ";" $zones | quote }}
+  CF_HOSTS: {{ join ";" $domains | quote }}
+  CF_RECORDTYPES: {{ join ";" $records | quote }}
+{{- end -}}

charts/stable/cloudflareddns/templates/common.yaml

@@ -1 +1,8 @@
-{{ include "tc.common.loader.all" . }}
+{{/* Make sure all variables are set properly */}}
+{{- include "tc.common.loader.init" . }}
+
+{{/* Render secret */}}
+{{- include "cloudflareddns.secret" . }}
+
+{{/* Render the templates */}}
+{{ include "tc.common.loader.apply" . }}

charts/stable/cloudflareddns/values.yaml

@@ -11,23 +11,25 @@ podSecurityContext:
   runAsUser: 0
   runAsGroup: 0
 
-secretEnv:
+cloudflareddns:
-  CF_APITOKEN: ""
+  user: your.cf.email@example.com
-  CF_APIKEY: ""
+  api_token: ""
-  CF_APITOKEN_ZONE: ""
+  api_key: ""
-
+  api_token_zone: ""
-env:
+  interval: 300
-  DETECTION_MODE: '{{ ternary .Values.env.DETECT_MODE .Values.env.DETECT_OVERRIDE (eq .Values.env.DETECT_OVERRIDE "") }}'
+  detect_mode: dig-whoami.cloudflare
-  # Use Defined
+  detect_override: ""
-  INTERVAL: 300
+  log_level: 3
-  DETECT_MODE: "dig-whoami.cloudflare"
+  host_zone_record:
-  DETECT_OVERRIDE: ""
+    - domain: example.com
-  LOG_LEVEL: 3
+      zone: example.com
-  cloudflareddns: ""
+      record: A
-  CF_USER: "your.cf.email@example.com"
+    - domain: foobar.com
-  CF_HOSTS: "test.example.com;test.foobar.com;test2.foobar.com"
+      zone: foobar.com
-  CF_ZONES: "example.com;foobar.com;foobar.com"
+      record: A
-  CF_RECORDTYPES: "A;A;AAAA"
+    - domain: foobar.com
+      zone: foobar.com
+      record: AAAA
 
 probes:
   liveness:
@@ -37,6 +39,10 @@ probes:
   startup:
     enabled: false
 
+envFrom:
+  - secretRef:
+      name: '{{ include "tc.common.names.fullname" . }}-secret'
+
 service:
   main:
     enabled: false
@@ -47,7 +53,7 @@ service:
 persistence:
   config:
     enabled: true
-    mountPath: "/config"
+    mountPath: /config
   varrun:
     enabled: true