feat(browserless-chrome): Add browserless-chrome (#2238)

* feat(browserless-chrome): Add browserless-chrome * ports * probes * nop * try clean * enable metrics * data path * more workspace * host * enable vars * more * more * host * hostport * test * more vars * test again * keepalive * don;t keep alive * queues * preboot no, keepalive yes * remvove preboot and keepaliuve * hosty * empty * cleanup
2022-03-21 23:04:14 +02:00
parent bedf39a453
commit bf04bdabc8
7 changed files with 577 additions and 0 deletions
--- a/charts/incubator/browserless-chrome/Chart.yaml
+++ b/charts/incubator/browserless-chrome/Chart.yaml
@@ -0,0 +1,28 @@
+apiVersion: v2
+appVersion: "10.6.2"
+dependencies:
+- name: common
+  repository: https://truecharts.org
+  version: 9.1.6
+description: Browserless is a web-service that allows for remote clients to connect, drive, and execute headless work
+home: https://github.com/truecharts/apps/tree/master/charts/stable/browserless-chrome
+icon: https://truecharts.org/_static/img/appicons/browserless-chrome.png
+keywords:
+- browserless
+- chrome
+- puppeteer
+kubeVersion: '>=1.16.0-0'
+maintainers:
+- email: info@truecharts.org
+  name: TrueCharts
+  url: https://truecharts.org
+name: browserless-chrome
+sources:
+- https://docs.browserless.io/docs/docker.html
+- https://hub.docker.com/r/browserless/chrome/
+version: 0.0.1
+annotations:
+  truecharts.org/catagories: |
+    - productivity
+  truecharts.org/SCALE-support: "true"
+  truecharts.org/grade: U
--- a/charts/incubator/browserless-chrome/ci/puppeteer-values.yaml
+++ b/charts/incubator/browserless-chrome/ci/puppeteer-values.yaml
@@ -0,0 +1 @@
+imageSelector: "imagePuppeteer"
--- a/charts/incubator/browserless-chrome/questions.yaml
+++ b/charts/incubator/browserless-chrome/questions.yaml
@@ -0,0 +1,480 @@
+# Include{groups}
+portals:
+  open:
+    protocols:
+      - "$kubernetes-resource_configmap_portal_protocol"
+    host:
+      - "$kubernetes-resource_configmap_portal_host"
+    ports:
+      - "$kubernetes-resource_configmap_portal_port"
+  metrics:
+    protocols:
+      - "$kubernetes-resource_configmap_portal_protocol"
+    host:
+      - "$kubernetes-resource_configmap_portal_host"
+    ports:
+      - "$kubernetes-resource_configmap_portal_port"
+    path: "/metrics"    
+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
+# Include{global}
+  - variable: imageSelector
+    group: "Container Image"
+    label: "Select Image"
+    schema:
+      type: string
+      default: "image"
+      enum:
+        - value: "image"
+          description: "Chrome"
+        - value: "imagePuppeteer"
+          description: "Puppeteer"
+  - variable: controller
+    group: "Controller"
+    label: ""
+    schema:
+      additional_attrs: true
+      type: dict
+      attrs:
+        - variable: advanced
+          label: "Show Advanced Controller Settings"
+          schema:
+            type: boolean
+            default: false
+            show_subquestions_if: true
+            subquestions:
+              - variable: type
+                description: "Please specify type of workload to deploy"
+                label: "(Advanced) Controller Type"
+                schema:
+                  type: string
+                  default: "deployment"
+                  required: true
+                  enum:
+                    - value: "deployment"
+                      description: "Deployment"
+                    - value: "statefulset"
+                      description: "Statefulset"
+                    - value: "daemonset"
+                      description: "Daemonset"
+              - variable: replicas
+                description: "Number of desired pod replicas"
+                label: "Desired Replicas"
+                schema:
+                  type: int
+                  default: 1
+                  required: true
+              - variable: strategy
+                description: "Please specify type of workload to deploy"
+                label: "(Advanced) Update Strategy"
+                schema:
+                  type: string
+                  default: "Recreate"
+                  required: true
+                  enum:
+                    - value: "Recreate"
+                      description: "Recreate: Kill existing pods before creating new ones"
+                    - value: "RollingUpdate"
+                      description: "RollingUpdate: Create new pods and then kill old ones"
+                    - value: "OnDelete"
+                      description: "(Legacy) OnDelete: ignore .spec.template changes"
+# Include{controllerExpert}
+  - variable: secret
+    group: "Container Configuration"
+    label: "Image Secrets"
+    schema:
+      additional_attrs: true
+      type: dict
+      attrs:
+        - variable: TOKEN
+          label: "TOKEN"
+          description: "You can optionally apply a TOKEN param that will restrict calls without a token query-string parameter"
+          schema:
+            type: string
+            default: "admin"
+            private: true
+  - variable: env
+    group: "Container Configuration"
+    label: "Image Environment"
+    schema:
+      additional_attrs: true
+      type: dict
+      attrs:
+        - variable: HOST
+          label: "HOST"
+          schema:
+            type: string
+            default: ""
+        - variable: WORKSPACE_DELETE_EXPIRED
+          label: "WORKSPACE_DELETE_EXPIRED"
+          description: "This will have browserless delete files older than 30 days in the workspace, checking once a day"
+          schema:
+            type: boolean
+            default: false
+        - variable: WORKSPACE_EXPIRE_DAYS
+          label: "WORKSPACE_EXPIRE_DAYS"
+          description: "Attempts to delete files older than X days in the workspace directory"
+          schema:
+            type: int
+            default: 30
+        - variable: CHROME_REFRESH_TIME
+          label: "CHROME_REFRESH_TIME"
+          description: "The CHROME_REFRESH_TIME flag accepts a value in milliseconds to keep Chrome running before it attempts to close it."
+          schema:
+            type: int
+            default: 3600000
+        - variable: MAX_CONCURRENT_SESSIONS
+          label: "MAX_CONCURRENT_SESSIONS"
+          description: "Since running Chrome can be rather resource intensive you'll probably want to limit the number of concurrent sessions."
+          schema:
+            type: int
+            default: 5
+        - variable: MAX_QUEUE_LENGTH
+          label: "MAX_QUEUE_LENGTH"
+          description: "This value determines how many items in the queue are allowed before requests are issued a 429 response code and closed."
+          schema:
+            type: int
+            default: 5
+        - variable: DEFAULT_BLOCK_ADS
+          label: "DEFAULT_BLOCK_ADS"
+          schema:
+            type: boolean
+            default: false
+        - variable: DEFAULT_HEADLESS
+          label: "DEFAULT_HEADLESS"
+          schema:
+            type: boolean
+            default: false
+        - variable: DEFAULT_IGNORE_HTTPS_ERRORS
+          label: "DEFAULT_IGNORE_HTTPS_ERRORS"
+          schema:
+            type: boolean
+            default: false
+        - variable: DEFAULT_IGNORE_DEFAULT_ARGS
+          label: "DEFAULT_IGNORE_DEFAULT_ARGS"
+          schema:
+            type: boolean
+            default: false
+        - variable: ENABLE_API_GET
+          label: "ENABLE_API_GET"
+          schema:
+            type: boolean
+            default: false
+        - variable: FUNCTION_ENABLE_INCOGNITO_MODE
+          label: "FUNCTION_ENABLE_INCOGNITO_MODE"
+          schema:
+            type: boolean
+            default: false
+        - variable: EXIT_ON_HEALTH_FAILURE
+          label: "EXIT_ON_HEALTH_FAILURE"
+          schema:
+            type: boolean
+            default: false
+        - variable: DISABLE_AUTO_SET_DOWNLOAD_BEHAVIOR
+          label: "DISABLE_AUTO_SET_DOWNLOAD_BEHAVIOR"
+          schema:
+            type: boolean
+            default: false
+        - variable: ENABLE_DEBUGGER
+          label: "ENABLE_DEBUGGER"
+          schema:
+            type: boolean
+            default: false
+        - variable: ENABLE_CORS
+          label: "ENABLE_CORS"
+          schema:
+            type: boolean
+            default: false
+        - variable: ENABLE_XVBF
+          label: "ENABLE_XVBF"
+          schema:
+            type: boolean
+            default: false
+# Include{containerConfig}
+
+  - variable: service
+    group: "Networking and Services"
+    label: "Configure Service(s)"
+    schema:
+      additional_attrs: true
+      type: dict
+      attrs:
+        - variable: main
+          label: "Main Service"
+          description: "The Primary service on which the healthcheck runs, often the webUI"
+          schema:
+            additional_attrs: true
+            type: dict
+            attrs:
+# Include{serviceSelector}
+                    - variable: main
+                      label: "Main Service Port Configuration"
+                      schema:
+                        additional_attrs: true
+                        type: dict
+                        attrs:
+                          - variable: port
+                            label: "Port"
+                            description: "This port exposes the container port on the service"
+                            schema:
+                              type: int
+                              default: 10194
+                              required: true
+                          - variable: advanced
+                            label: "Show Advanced settings"
+                            schema:
+                              type: boolean
+                              default: false
+                              show_subquestions_if: true
+                              subquestions:
+                                - variable: protocol
+                                  label: "Port Type"
+                                  schema:
+                                    type: string
+                                    default: "HTTP"
+                                    enum:
+                                      - value: HTTP
+                                        description: "HTTP"
+                                      - value: "HTTPS"
+                                        description: "HTTPS"
+                                      - value: TCP
+                                        description: "TCP"
+                                      - value: "UDP"
+                                        description: "UDP"
+                                - variable: nodePort
+                                  label: "Node Port (Optional)"
+                                  description: "This port gets exposed to the node. Only considered when service type is NodePort, Simple or LoadBalancer"
+                                  schema:
+                                    type: int
+                                    min: 9000
+                                    max: 65535
+                                - variable: targetPort
+                                  label: "Target Port"
+                                  description: "The internal(!) port on the container the Application runs on"
+                                  schema:
+                                    type: int
+                                    default: 3000
+
+  - variable: serviceexpert
+    group: "Networking and Services"
+    label: "Show Expert Config"
+    schema:
+      type: boolean
+      default: false
+      show_subquestions_if: true
+      subquestions:
+        - variable: hostNetwork
+          group: "Networking and Services"
+          label: "Host-Networking (Complicated)"
+          schema:
+            type: boolean
+            default: false
+
+# Include{serviceExpert}
+
+# Include{serviceList}
+
+  - variable: persistence
+    label: "Integrated Persistent Storage"
+    description: "Integrated Persistent Storage"
+    group: "Storage and Persistence"
+    schema:
+      additional_attrs: true
+      type: dict
+      attrs:
+        - variable: downloads
+          label: "App Downloads Storage"
+          description: "Stores the Application Downloads."
+          schema:
+            additional_attrs: true
+            type: dict
+            attrs:
+              - variable: type
+                label: "Type of Storage"
+                description: "Sets the persistence type, Anything other than PVC could break rollback!"
+                schema:
+                  type: string
+                  default: "simplePVC"
+                  enum:
+                    - value: "simplePVC"
+                      description: "PVC (simple)"
+                    - value: "simpleHP"
+                      description: "HostPath (simple)"
+                    - value: "emptyDir"
+                      description: "emptyDir"
+                    - value: "pvc"
+                      description: "pvc"
+                    - value: "hostPath"
+                      description: "hostPath"
+# Include{persistenceBasic}
+              - variable: hostPath
+                label: "hostPath"
+                description: "Path inside the container the storage is mounted"
+                schema:
+                  show_if: [["type", "=", "hostPath"]]
+                  type: hostpath
+              - variable: medium
+                label: "EmptyDir Medium"
+                schema:
+                  show_if: [["type", "=", "emptyDir"]]
+                  type: string
+                  default: ""
+                  enum:
+                    - value: ""
+                      description: "Default"
+                    - value: "Memory"
+                      description: "Memory"
+# Include{persistenceAdvanced}
+        - variable: metrics
+          label: "App Metrics Storage"
+          description: "Stores the Application Metrics."
+          schema:
+            additional_attrs: true
+            type: dict
+            attrs:
+              - variable: type
+                label: "Type of Storage"
+                description: "Sets the persistence type, Anything other than PVC could break rollback!"
+                schema:
+                  type: string
+                  default: "simplePVC"
+                  enum:
+                    - value: "simplePVC"
+                      description: "PVC (simple)"
+                    - value: "simpleHP"
+                      description: "HostPath (simple)"
+                    - value: "emptyDir"
+                      description: "emptyDir"
+                    - value: "pvc"
+                      description: "pvc"
+                    - value: "hostPath"
+                      description: "hostPath"
+# Include{persistenceBasic}
+              - variable: hostPath
+                label: "hostPath"
+                description: "Path inside the container the storage is mounted"
+                schema:
+                  show_if: [["type", "=", "hostPath"]]
+                  type: hostpath
+              - variable: medium
+                label: "EmptyDir Medium"
+                schema:
+                  show_if: [["type", "=", "emptyDir"]]
+                  type: string
+                  default: ""
+                  enum:
+                    - value: ""
+                      description: "Default"
+                    - value: "Memory"
+                      description: "Memory"
+# Include{persistenceAdvanced}
+
+# Include{persistenceList}
+
+  - variable: ingress
+    label: ""
+    group: "Ingress"
+    schema:
+      additional_attrs: true
+      type: dict
+      attrs:
+        - variable: main
+          label: "Main Ingress"
+          schema:
+            additional_attrs: true
+            type: dict
+            attrs:
+# Include{ingressDefault}
+
+# Include{ingressTLS}
+
+# Include{ingressTraefik}
+
+# Include{ingressExpert}
+
+# Include{ingressList}
+
+# Include{security}
+
+  - variable: advancedSecurity
+    label: "Show Advanced Security Settings"
+    group: "Security and Permissions"
+    schema:
+      type: boolean
+      default: false
+      show_subquestions_if: true
+      subquestions:
+        - variable: securityContext
+          label: "Security Context"
+          schema:
+            additional_attrs: true
+            type: dict
+            attrs:
+              - variable: privileged
+                label: "Privileged mode"
+                schema:
+                  type: boolean
+                  default: false
+              - variable: readOnlyRootFilesystem
+                label: "ReadOnly Root Filesystem"
+                schema:
+                  type: boolean
+                  default: true
+              - variable: allowPrivilegeEscalation
+                label: "Allow Privilege Escalation"
+                schema:
+                  type: boolean
+                  default: false
+              - variable: runAsNonRoot
+                label: "runAsNonRoot"
+                schema:
+                  type: boolean
+                  default: true
+# Include{securityContextAdvanced}
+
+  - variable: podSecurityContext
+    group: "Security and Permissions"
+    label: "Pod Security Context"
+    schema:
+      additional_attrs: true
+      type: dict
+      attrs:
+        - variable: runAsUser
+          label: "runAsUser"
+          description: "The UserID of the user running the application"
+          schema:
+            type: int
+            default: 568
+        - variable: runAsGroup
+          label: "runAsGroup"
+          description: The groupID this App of the user running the application"
+          schema:
+            type: int
+            default: 568
+        - variable: fsGroup
+          label: "fsGroup"
+          description: "The group that should own ALL storage."
+          schema:
+            type: int
+            default: 568
+# Include{podSecurityContextAdvanced}
+
+# Include{resources}
+
+# Include{advanced}
+
+# Include{addons}
--- a/charts/incubator/browserless-chrome/templates/common.yaml
+++ b/charts/incubator/browserless-chrome/templates/common.yaml
@@ -0,0 +1 @@
+{{ include "common.all" . }}
--- a/charts/incubator/browserless-chrome/values.yaml
+++ b/charts/incubator/browserless-chrome/values.yaml
@@ -0,0 +1,66 @@
+image:
+  repository: browserless/chrome
+  tag: version-v10.6.2@sha256:f0065aa44fb1c38b7fc30d34e220138dc0a0c6477b78eb7f59015622c2052030
+  pullPolicy: IfNotPresent
+
+imagePuppeteer:
+  repository: browserless/chrome
+  pullPolicy: IfNotPresent
+  tag: 1.51.1-puppeteer-13.1.3@sha256:1a36d1f4f7646ec3c40a15b8150f1202fc66720e38c7001ab21018737ec04937
+
+imageSelector: "image"
+
+secret:
+  TOKEN: ""
+
+env:
+  WORKSPACE_DIR: "/downloads"
+  METRICS_JSON_PATH: "/metrics/metrics.json"
+  # User Defined
+  HOST: ""
+  WORKSPACE_DELETE_EXPIRED: false
+  WORKSPACE_EXPIRE_DAYS: 30
+  CHROME_REFRESH_TIME: 3600000
+  MAX_CONCURRENT_SESSIONS: 5
+  MAX_QUEUE_LENGTH: 5
+  CONNECTION_TIMEOUT: 30000
+  DEFAULT_BLOCK_ADS: true
+  DEFAULT_HEADLESS: false
+  DEFAULT_IGNORE_HTTPS_ERRORS: true
+  DEFAULT_IGNORE_DEFAULT_ARGS: true
+  ENABLE_API_GET: true
+  FUNCTION_ENABLE_INCOGNITO_MODE: true
+  EXIT_ON_HEALTH_FAILURE: true
+  DISABLE_AUTO_SET_DOWNLOAD_BEHAVIOR: false
+  ENABLE_DEBUGGER: true
+  ENABLE_CORS: false
+  ENABLE_XVBF: true
+  # Enabling those, makes probe/app fail
+  # KEEP_ALIVE: true
+  # PREBOOT_CHROME: true
+
+service:
+  main:
+    ports:
+      main:
+        port: 10194
+        targetPort: 3000
+
+probes:
+  liveness:
+    path: "/metrics"
+
+  readiness:
+    path: "/metrics"
+
+  startup:
+    path: "/metrics"
+
+
+persistence:
+  downloads:
+    enabled: true
+    mountPath: "/downloads"
+  metrics:
+    enabled: true
+    mountPath: "/metrics"
--- a/docs/_static/img/appicons/browserless-chrome.png
+++ b/docs/_static/img/appicons/browserless-chrome.png
--- a/docs/manual/default-ports.md
+++ b/docs/manual/default-ports.md
@@ -350,6 +350,7 @@ These defaults can of course be changed, but as we guarantee "sane, working defa
 | zerotier                   |      main       |      main       | 10190 |   UDP    |                                         |
 | rsshub                     |      main       |      main       | 10191 |   HTTP   |                                         |
 | verysync                   |      main       |      main       | 10193 |   HTTP   |                                         |
+| browserless                |      main       |      main       | 10194 |   TCP    |                                         |
 | kutt                       |      main       |      main       | 10195 |   TCP    |                                         |
 | storj-node                 |      main       |      main       | 14002 |   TCP    |                                         |
 | satisfactory               |     beacon      |     beacon      | 15000 |   UDP    |                                         |