Dynamicly determine portal settings (#253)

* Setup dynamic portal config map. - Includes tests * Add portal docs * Update charts/calibre-web/2.0.0/questions.yaml Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com> * Fix feedback from @stavros-k * Update charts/jackett/2.0.0/test_values.yaml * Update charts/jackett/2.0.0/test_values.yaml * Update charts/zwavejs2mqtt/2.0.0/questions.yaml Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com> * Update charts/home-assistant/2.0.0/questions.yaml Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com> * Update charts/esphome/2.0.0/questions.yaml Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com> * Update charts/handbrake/2.0.0/questions.yaml Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com> Co-authored-by: Troy Prelog <35702532+tprelog@users.noreply.github.com> Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
2021-03-11 17:41:17 +01:00
parent 34762190a3
commit 3eeaea10af
82 changed files with 1392 additions and 227 deletions
@@ -0,0 +1,74 @@
+# Portal Button
+
+After installation almost every app should have a "portal" button. This button is an easy and streamlined way of entering the Applications after installation. However, one should be aware that it does not magically follow changes inside the application (for example: from http to https).
+
+##### questions.yaml example
+
+Every questions.yaml file should contain the following snippets to enable the portal button. Please be aware to change `"https"` to `"http"` if your application uses http instead of https when running using "NodePort".
+
+Also please be aware that the portal only(!) points towards the main service and main ingress.
+
+```
+portals:
+  web_portal:
+    protocols:
+      - "$kubernetes-resource_configmap_portal_protocol"
+    host:
+      - "$kubernetes-resource_configmap_portal_host"
+    ports:
+      - "$kubernetes-resource_configmap_portal_port"
+	path: "/"
+
+questions:
+
+  - variable: portal
+    group: "Container Image"
+    label: "Configure Portal Button"
+    schema:
+      type: dict
+      hidden: true
+      attrs:
+        - variable: enabled
+          label: "Enable"
+          description: "enable the portal button"
+          schema:
+            hidden: true
+            editable: false
+            type: boolean
+            default: true
+        - variable: nodePortProtocol
+          label: "Protocol when using NodePort"
+          description: "Enter the protocol to use when using nodeport"
+          schema:
+            hidden: true
+            editable: false
+            type: string
+            default: "https"
+
+```
+
+There are also some additional (advanced) options availale, these can be added below the above required portion as required:
+
+**ingressPort:**
+```
+        - variable: ingressPort
+          label: "Port when ingress is not using 443"
+          description: "Advanced setting, please enter a different port to use if Ingress uses something other than port 443"
+          schema:
+            hidden: true
+            editable: false
+            type: int
+            default: 8443
+```
+
+**host:**
+```
+        - variable: host
+          label: "override Host when using NodePort"
+          description: "Overrides the host setting when using NodePort. Example usecase would be loadbalanced NodePorts."
+          schema:
+            hidden: true
+            editable: false
+            type: string
+            default: "test.com"
+```