Allow external services to be used like Apps.
\nThis App is supplied by TrueCharts, for more information visit the manual: https://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
", "detailed_readme": "TrueCharts can be installed as both normal Helm Charts or as TrueNAS SCALE Apps.\nBoth solutions are fully supported, but we heavily advice the use of normal Helm Charts where possible
\nFor more information about this Chart, please check the docs on the TrueCharts website
\nThis chart is not maintained by the upstream project and any issues with the chart should be raised here
\nTo install TrueCharts Helm charts using Helm, you can use our OCI Repository.
\nhelm install mychart oci://tccr.io/truecharts/CHARTNAME
For more information on how to install TrueCharts Helm charts, checkout the instructions on the website: https://truecharts.org/helm/
\nFor more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the quick-start guides for TrueNAS SCALE.
\nAll our charts have dedicated documentation pages.\nThe documentation for this chart can be found here:\nhttps://truecharts.org/charts/stable/external-service
\nPlease note: For TrueNAS SCALE, only options available in the GUI are supported.\nHence most of these docs do not apply to TrueNAS SCALE
\nTo view the chart specific options, please view Values.yaml included in the chart.\nThe most recent version of which, is available here: https://github.com/truecharts/charts/charts/stable/external-service/values.yaml
\nAll our Charts use a shared \"common\" library chart that contains most of the templating and options.\nFor the complete overview of all available options, please checkout the documentation for them on the website: https://truecharts.org/common/
\nFor information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/truecharts/library-charts/blob/main/library/common/values.yaml
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
\nAll Rights Reserved - The TrueCharts Project
", "changelog": "for the complete changelog, please refer to the website
\nImportant:
" }, "14.1.1": { "healthy": true, "supported": true, "healthy_error": null, "location": "/home/runner/_work/catalog/catalog/stable/external-service/14.1.1", "last_update": "2024-05-29 12:35:14", "required_features": [], "human_version": "3.20.0_14.1.1", "version": "14.1.1", "chart_metadata": { "annotations": { "truecharts.org/category": "networking", "truecharts.org/max_helm_version": "3.14", "truecharts.org/min_helm_version": "3.11", "truecharts.org/train": "stable" }, "apiVersion": "v2", "appVersion": "3.20.0", "dependencies": [ { "name": "common", "version": "23.0.9", "repository": "oci://tccr.io/truecharts", "condition": "", "alias": "", "tags": [], "import-values": [] } ], "deprecated": false, "description": "Allow external services to be used like Apps.", "home": "https://truecharts.org/charts/stable/external-service", "icon": "https://truecharts.org/img/hotlink-ok/chart-icons/external-service.webp", "keywords": [ "external-service", "reverse-proxy" ], "kubeVersion": ">=1.24.0-0", "maintainers": [ { "name": "TrueCharts", "email": "info@truecharts.org", "url": "https://truecharts.org" } ], "name": "external-service", "sources": [ "https://github.com/truecharts/charts/tree/master/charts/stable/external-service", "https://hub.docker.com/_/alpine" ], "type": "application", "version": "14.1.1" }, "app_metadata": null, "schema": { "groups": [ { "name": "Image", "description": "Configured the images to be used for the Chart.\nIt's wise to use \"digest pinned\" tags and to avoid using \"latest\".\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/#images\n" }, { "name": "General", "description": "For TrueNAS SCALE We've grouped a number of settings here, that all effact how apps run in general.\n\nCheckout the following documentation for more information:\n - https://truecharts.org/common/global/\n - https://truecharts.org/common/#tz\n - https://truecharts.org/common/podoptions/\n - Image Pull Secrets\n" }, { "name": "Workload", "description": "These settings configure how the actual Pods and containers are running.\nGenerally, on SCALE, we only expose a limited subset of these settings for the primary workload and container.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/workload/\n- https://truecharts.org/common/container/\n" }, { "name": "App Configuration", "description": "Every application has different values that may be required to run or have multiple options that the user may choose to enable or disable to change the behavior of the application.\nMost options should have a Tooltip (Circled Question Mark) to further describe said option.\n\nTo find more information, lookup your chart-specific documentation in the Charts List: https://truecharts.org/charts/description-list/\n" }, { "name": "Services", "description": "Service and Networking options for any applications are contained here.\nSome applications may have complicated networking setups with multiple options or some may have no options here at all.\n\nOptions here include the service and port configurations for the application, and more may be enabled or changed under the Advanced Settings and Show Expert Config boxes.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/service/\n" }, { "name": "Networking", "description": "Contains advanced networking options that are not actively supported by the TrueCharts team.\nCurrently only contains scaleExternalInterfaces.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/scaleexternalinterface/\n" }, { "name": "Persistence", "description": "Many applications will have certain options for storage to be configurable by the user, the main two being PVC and hostpath but may include other types.\nThis storage is called Persistence since it is not deleted upon restart or upgrade of an application.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/persistence/\n- https://truecharts.org/scale/guides/nfs-share/\n- https://truecharts.org/general/faq/#why-pvc-is-recommended-over-hostpath\n" }, { "name": "Ingress", "description": "Ingress (more commonly known as Reverse Proxy) settings can be configured here. This is how Kubernetes connects your Applications in containers to FQDNs (fully qualified domain names).\nIf you choose to enable this you must have a \"Ingress Provider\" aka \"Reverse Proxy\" installed (We highly advice Traefik: https://truecharts.org/charts/premium/traefik/)\nIt also requiresa DNS service to actually resolve the DNS name of the FQDN specified.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/ingress/\n" }, { "name": "SecurityContext", "description": "The security settings for each application and/or permissions that each application may have for the files/directories created.\nEach application will come with predefined permissions but users may want to change certain setting depending on their usage or capabilities.\n\nUnless necessary users are advised to keep this section mostly to defaults.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/securitycontext/\n" }, { "name": "Resources", "description": "Resources limits that have been defined by each application are in this section.\nMost will have a specific default that some users may want to change based on their specific hardware or needs.\n\nThis also contains the options to mount GPUs or, more precisely, \"request\" GPU's to be mounted.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/resources/\n" }, { "name": "Devices", "description": "These are special \"mountpoints\" that can be used to mount miscelanious USB and PCI devices using special hostPath mounts.\nFor clearity we've decided to seperate this from persistence on SCALE.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/persistence/device/\n- https://truecharts.org/scale/guides/pci-passthrough/\n" }, { "name": "Middlewares", "description": "Traefik Middlewares" }, { "name": "StorageClass", "description": "StorageClasses define where to storage Storage.\n\nCheckout the following documentation for more information:\n" }, { "name": "Metrics", "description": "Contains options to configure Prometheus metrics for the application.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/metrics/\n" }, { "name": "Addons", "description": "Addons that are supplied by the TrueCharts team to add additional capabilities for users to use on top of the application\u2019s defaults.\nThings included here are VPN addons, Codeserver for editing files inside the application\u2019s container, Netshoot for network troubelshooting, etc.\n\nGenerally not required for use but may be necessary or usefull at times for specific applications.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/addons/\n- https://truecharts.org/scale/guides/vpn-setup/\n" }, { "name": "Experimental", "description": "Experimental Configuration Options\nOften these are not fully flushed-out, could randomly break or might not work at-all.\n" }, { "name": "Postgresql", "description": "For Postgresql we use \"CloudNative-PG\" as a backend, which has to be installed first.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/cnpg/\n- https://truecharts.org/scale/guides/sql-export/\n- https://truecharts.org/scale/guides/recover-cnpg/\n" }, { "name": "Dependencies", "description": "contains dependency setting for which we, currently, do not have seperate catagories (yet)\n" }, { "name": "Documentation", "description": "We added this section to make everyone aware that OpenSource isn't always easy.\nIt doesn't keep existing without signficant ongoing support, so please consider supporting TrueCharts and other OpenSource projects.\n\nBefore installing, be sure you've followed the https://truecharts.org/scale/guides/getting-started/\nWe would also advice going over our https://truecharts.org/scale/guides/scale-intro/\nand many of the other documentation pages...\n" } ], "portals": { "open": { "protocols": [ "$kubernetes-resource_configmap_tcportal-open_protocol" ], "host": [ "$kubernetes-resource_configmap_tcportal-open_host" ], "ports": [ "$kubernetes-resource_configmap_tcportal-open_port" ] } }, "questions": [ { "variable": "global", "group": "General", "label": "Global Settings", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "stopAll", "label": "Stop All", "description": "Stops All Running pods and hibernates cnpg", "schema": { "type": "boolean", "default": false } } ] } }, { "variable": "credentialsList", "group": "General", "label": "Credentials (Experimental)", "schema": { "type": "list", "default": [], "items": [ { "variable": "credentialsEntry", "label": "Enter Credentials", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "Name", "description": "Name", "schema": { "type": "string", "required": true, "default": "" } }, { "variable": "type", "label": "Type", "description": "Type of Credential", "schema": { "type": "string", "default": "s3", "enum": [ { "value": "s3", "description": "s3 Storage" } ] } }, { "variable": "url", "label": "url", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "path", "label": "path", "description": "Path Prefix not needed for most cases", "schema": { "type": "string", "default": "" } }, { "variable": "bucket", "label": "bucket", "schema": { "show_if": [ [ "type", "=", "s3" ] ], "type": "string", "default": "", "required": true } }, { "variable": "accessKey", "label": "accessKey", "schema": { "show_if": [ [ "type", "=", "s3" ] ], "type": "string", "default": "", "required": true } }, { "variable": "secretKey", "label": "secretKey", "schema": { "show_if": [ [ "type", "=", "s3" ] ], "type": "string", "default": "", "required": true } }, { "variable": "encrKey", "label": "encrKey", "description": "The Encryption key is needed for tools like volsync if not needed it will be ignored", "schema": { "show_if": [ [ "type", "=", "s3" ] ], "type": "string", "default": "MYSECRETPASSPHRASE", "required": true } } ] } } ] } }, { "variable": "service", "group": "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": [ { "variable": "enabled", "label": "Enable the service", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "type", "label": "Service Type", "description": "ExternalIP gets connected to using an IP and port, ExternalName gets connected to using a domain name", "schema": { "type": "string", "default": "ExternalIP", "enum": [ { "value": "ExternalName", "description": "ExternalName" }, { "value": "ExternalIP", "description": "ExternalIP" } ] } }, { "variable": "externalName", "label": "External Service Domainname", "description": "Domainname of External service", "schema": { "show_if": [ [ "type", "=", "ExternalName" ] ], "type": "string", "default": "google.com" } }, { "variable": "externalIP", "label": "External Service IP", "description": "IP of External service", "schema": { "show_if": [ [ "type", "=", "ExternalIP" ] ], "type": "string", "default": "1.1.1.1" } }, { "variable": "ports", "label": "Service's Port(s) Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Service Port Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable the port", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "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": "port", "label": "Service Port", "description": "Both the external service port and internal service port will be the same", "schema": { "type": "int", "default": 10003 } } ] } } ] } } ] } } ] } }, { "variable": "ingress", "label": "", "group": "Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": false, "show_subquestions_if": true, "subquestions": [ { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [ { "path": "/", "pathType": "Prefix" } ], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } } ] } } ] } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests (advanced)", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace (optional)", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name (Optional)", "description": "Defaults to chart name", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description (Optional)", "description": "Defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "icon", "label": "Icon (Optional)", "description": "Defaults to chart icon", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "widget", "label": "Widget Settings", "schema": { "type": "dict", "additional_attrs": true, "show_if": [ [ "enabled", "=", true ] ], "attrs": [ { "variable": "enabled", "label": "Enable Widget", "description": "When disabled all widget annotations are skipped.", "schema": { "type": "boolean", "default": true } }, { "variable": "custom", "label": "Options", "schema": { "type": "dict", "additional_attrs": true, "attrs": [ { "variable": "key", "label": "API-key (key)", "schema": { "type": "string", "default": "" } } ] } }, { "variable": "customkv", "label": "Custom Options", "schema": { "type": "list", "default": [], "items": [ { "variable": "option", "label": "Option", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "key", "label": "Key", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "value", "label": "Value", "schema": { "type": "string", "default": "", "required": true } } ] } } ] } } ] } } ] } } ] } }, { "variable": "advanced", "label": "Show Advanced Settings", "description": "Advanced settings are not covered by TrueCharts Support", "schema": { "type": "boolean", "default": false } }, { "variable": "ingressClassName", "label": "(Advanced/Optional) IngressClass Name", "schema": { "type": "string", "show_if": [ [ "advanced", "=", true ] ], "default": "" } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "show_if": [ [ "advanced", "=", true ] ], "default": [], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your cert-manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Certificate Secret (Advanced)", "schema": { "show_if": [ [ "certificateIssuer", "=", "" ] ], "type": "string", "default": "" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "ingressList", "label": "Add Manual Custom Ingresses", "group": "Ingress", "schema": { "type": "list", "default": [], "items": [ { "variable": "ingressListEntry", "label": "Custom Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "name", "label": "Name", "schema": { "type": "string", "default": "" } }, { "variable": "ingressClassName", "label": "IngressClass Name", "schema": { "type": "string", "default": "" } }, { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } }, { "variable": "overrideService", "label": "Linked Service", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "Service Name", "schema": { "type": "string", "default": "" } }, { "variable": "port", "label": "Service Port", "schema": { "type": "int" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "default": [], "show_if": [ [ "certificateIssuer", "=", "" ] ], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your Cert-Manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Secret (Advanced)", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description", "description": "defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } } ] } } ] } } ] } } ] } } ] }, "app_readme": "Allow external services to be used like Apps.
\nThis App is supplied by TrueCharts, for more information visit the manual: https://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
", "detailed_readme": "TrueCharts can be installed as both normal Helm Charts or as TrueNAS SCALE Apps.\nBoth solutions are fully supported, but we heavily advice the use of normal Helm Charts where possible
\nFor more information about this Chart, please check the docs on the TrueCharts website
\nThis chart is not maintained by the upstream project and any issues with the chart should be raised here
\nTo install TrueCharts Helm charts using Helm, you can use our OCI Repository.
\nhelm install mychart oci://tccr.io/truecharts/CHARTNAME
For more information on how to install TrueCharts Helm charts, checkout the instructions on the website: https://truecharts.org/helm/
\nFor more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the quick-start guides for TrueNAS SCALE.
\nAll our charts have dedicated documentation pages.\nThe documentation for this chart can be found here:\nhttps://truecharts.org/charts/stable/external-service
\nPlease note: For TrueNAS SCALE, only options available in the GUI are supported.\nHence most of these docs do not apply to TrueNAS SCALE
\nTo view the chart specific options, please view Values.yaml included in the chart.\nThe most recent version of which, is available here: https://github.com/truecharts/charts/charts/stable/external-service/values.yaml
\nAll our Charts use a shared \"common\" library chart that contains most of the templating and options.\nFor the complete overview of all available options, please checkout the documentation for them on the website: https://truecharts.org/common/
\nFor information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/truecharts/library-charts/blob/main/library/common/values.yaml
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
\nAll Rights Reserved - The TrueCharts Project
", "changelog": "for the complete changelog, please refer to the website
\nImportant:
" }, "13.8.14": { "healthy": true, "supported": true, "healthy_error": null, "location": "/home/runner/_work/catalog/catalog/stable/external-service/13.8.14", "last_update": "2024-05-29 12:35:14", "required_features": [], "human_version": "3.19.1_13.8.14", "version": "13.8.14", "chart_metadata": { "annotations": { "max_scale_version": "24.04.0", "min_scale_version": "23.10.0", "truecharts.org/category": "networking", "truecharts.org/max_helm_version": "3.14", "truecharts.org/min_helm_version": "3.11", "truecharts.org/train": "stable" }, "apiVersion": "v2", "appVersion": "3.19.1", "dependencies": [ { "name": "common", "version": "20.3.12", "repository": "oci://tccr.io/truecharts", "condition": "", "alias": "", "tags": [], "import-values": [] } ], "deprecated": false, "description": "Allow external services to be used like Apps.", "home": "https://truecharts.org/charts/stable/external-service", "icon": "https://truecharts.org/img/hotlink-ok/chart-icons/external-service.webp", "keywords": [ "external-service", "reverse-proxy" ], "kubeVersion": ">=1.24.0-0", "maintainers": [ { "name": "TrueCharts", "email": "info@truecharts.org", "url": "https://truecharts.org" } ], "name": "external-service", "sources": [ "https://github.com/truecharts/charts/tree/master/charts/stable/external-service", "https://hub.docker.com/_/alpine" ], "type": "application", "version": "13.8.14" }, "app_metadata": null, "schema": { "groups": [ { "name": "Image", "description": "Configured the images to be used for the Chart.\nIt's wise to use \"digest pinned\" tags and to avoid using \"latest\".\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/#images\n" }, { "name": "General", "description": "For TrueNAS SCALE We've grouped a number of settings here, that all effact how apps run in general.\n\nCheckout the following documentation for more information:\n - https://truecharts.org/common/global/\n - https://truecharts.org/common/#tz\n - https://truecharts.org/common/podoptions/\n - Image Pull Secrets\n" }, { "name": "Workload", "description": "These settings configure how the actual Pods and containers are running.\nGenerally, on SCALE, we only expose a limited subset of these settings for the primary workload and container.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/workload/\n- https://truecharts.org/common/container/\n" }, { "name": "App Configuration", "description": "Every application has different values that may be required to run or have multiple options that the user may choose to enable or disable to change the behavior of the application.\nMost options should have a Tooltip (Circled Question Mark) to further describe said option.\n\nTo find more information, lookup your chart-specific documentation in the Charts List: https://truecharts.org/charts/description-list/\n" }, { "name": "Services", "description": "Service and Networking options for any applications are contained here.\nSome applications may have complicated networking setups with multiple options or some may have no options here at all.\n\nOptions here include the service and port configurations for the application, and more may be enabled or changed under the Advanced Settings and Show Expert Config boxes.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/service/\n" }, { "name": "Networking", "description": "Contains advanced networking options that are not actively supported by the TrueCharts team.\nCurrently only contains scaleExternalInterfaces.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/scaleexternalinterface/\n" }, { "name": "Persistence", "description": "Many applications will have certain options for storage to be configurable by the user, the main two being PVC and hostpath but may include other types.\nThis storage is called Persistence since it is not deleted upon restart or upgrade of an application.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/persistence/\n- https://truecharts.org/scale/guides/nfs-share/\n- https://truecharts.org/general/faq/#why-pvc-is-recommended-over-hostpath\n" }, { "name": "Ingress", "description": "Ingress (more commonly known as Reverse Proxy) settings can be configured here. This is how Kubernetes connects your Applications in containers to FQDNs (fully qualified domain names).\nIf you choose to enable this you must have a \"Ingress Provider\" aka \"Reverse Proxy\" installed (We highly advice Traefik: https://truecharts.org/charts/premium/traefik/)\nIt also requiresa DNS service to actually resolve the DNS name of the FQDN specified.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/ingress/\n" }, { "name": "SecurityContext", "description": "The security settings for each application and/or permissions that each application may have for the files/directories created.\nEach application will come with predefined permissions but users may want to change certain setting depending on their usage or capabilities.\n\nUnless necessary users are advised to keep this section mostly to defaults.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/securitycontext/\n" }, { "name": "Resources", "description": "Resources limits that have been defined by each application are in this section.\nMost will have a specific default that some users may want to change based on their specific hardware or needs.\n\nThis also contains the options to mount GPUs or, more precisely, \"request\" GPU's to be mounted.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/resources/\n" }, { "name": "Devices", "description": "These are special \"mountpoints\" that can be used to mount miscelanious USB and PCI devices using special hostPath mounts.\nFor clearity we've decided to seperate this from persistence on SCALE.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/persistence/device/\n- https://truecharts.org/scale/guides/pci-passthrough/\n" }, { "name": "Middlewares", "description": "Traefik Middlewares" }, { "name": "StorageClass", "description": "StorageClasses define where to storage Storage.\n\nCheckout the following documentation for more information:\n" }, { "name": "Metrics", "description": "Contains options to configure Prometheus metrics for the application.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/metrics/\n" }, { "name": "Addons", "description": "Addons that are supplied by the TrueCharts team to add additional capabilities for users to use on top of the application\u2019s defaults.\nThings included here are VPN addons, Codeserver for editing files inside the application\u2019s container, Netshoot for network troubelshooting, etc.\n\nGenerally not required for use but may be necessary or usefull at times for specific applications.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/addons/\n- https://truecharts.org/scale/guides/vpn-setup/\n" }, { "name": "Experimental", "description": "Experimental Configuration Options\nOften these are not fully flushed-out, could randomly break or might not work at-all.\n" }, { "name": "Postgresql", "description": "For Postgresql we use \"CloudNative-PG\" as a backend, which has to be installed first.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/cnpg/\n- https://truecharts.org/scale/guides/sql-export/\n- https://truecharts.org/scale/guides/recover-cnpg/\n" }, { "name": "Dependencies", "description": "contains dependency setting for which we, currently, do not have seperate catagories (yet)\n" }, { "name": "Documentation", "description": "We added this section to make everyone aware that OpenSource isn't always easy.\nIt doesn't keep existing without signficant ongoing support, so please consider supporting TrueCharts and other OpenSource projects.\n\nBefore installing, be sure you've followed the https://truecharts.org/scale/guides/getting-started/\nWe would also advice going over our https://truecharts.org/scale/guides/scale-intro/\nand many of the other documentation pages...\n" } ], "portals": { "open": { "protocols": [ "$kubernetes-resource_configmap_tcportal-open_protocol" ], "host": [ "$kubernetes-resource_configmap_tcportal-open_host" ], "ports": [ "$kubernetes-resource_configmap_tcportal-open_port" ] } }, "questions": [ { "variable": "global", "group": "General", "label": "Global Settings", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "stopAll", "label": "Stop All", "description": "Stops All Running pods and hibernates cnpg", "schema": { "type": "boolean", "default": false } } ] } }, { "variable": "service", "group": "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": [ { "variable": "enabled", "label": "Enable the service", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "type", "label": "Service Type", "description": "ExternalIP gets connected to using an IP and port, ExternalName gets connected to using a domain name", "schema": { "type": "string", "default": "ExternalIP", "enum": [ { "value": "ExternalName", "description": "ExternalName" }, { "value": "ExternalIP", "description": "ExternalIP" } ] } }, { "variable": "externalName", "label": "External Service Domainname", "description": "Domainname of External service", "schema": { "show_if": [ [ "type", "=", "ExternalName" ] ], "type": "string", "default": "google.com" } }, { "variable": "externalIP", "label": "External Service IP", "description": "IP of External service", "schema": { "show_if": [ [ "type", "=", "ExternalIP" ] ], "type": "string", "default": "1.1.1.1" } }, { "variable": "ports", "label": "Service's Port(s) Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Service Port Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable the port", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "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": "port", "label": "Service Port", "description": "Both the external service port and internal service port will be the same", "schema": { "type": "int", "default": 10003 } } ] } } ] } } ] } } ] } }, { "variable": "ingress", "label": "", "group": "Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": false, "show_subquestions_if": true, "subquestions": [ { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [ { "path": "/", "pathType": "Prefix" } ], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } } ] } } ] } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests (advanced)", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace (optional)", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name (Optional)", "description": "Defaults to chart name", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description (Optional)", "description": "Defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "icon", "label": "Icon (Optional)", "description": "Defaults to chart icon", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "widget", "label": "Widget Settings", "schema": { "type": "dict", "additional_attrs": true, "show_if": [ [ "enabled", "=", true ] ], "attrs": [ { "variable": "enabled", "label": "Enable Widget", "description": "When disabled all widget annotations are skipped.", "schema": { "type": "boolean", "default": true } }, { "variable": "custom", "label": "Options", "schema": { "type": "dict", "additional_attrs": true, "attrs": [ { "variable": "key", "label": "API-key (key)", "schema": { "type": "string", "default": "" } } ] } }, { "variable": "customkv", "label": "Custom Options", "schema": { "type": "list", "default": [], "items": [ { "variable": "option", "label": "Option", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "key", "label": "Key", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "value", "label": "Value", "schema": { "type": "string", "default": "", "required": true } } ] } } ] } } ] } } ] } } ] } }, { "variable": "advanced", "label": "Show Advanced Settings", "description": "Advanced settings are not covered by TrueCharts Support", "schema": { "type": "boolean", "default": false } }, { "variable": "ingressClassName", "label": "(Advanced/Optional) IngressClass Name", "schema": { "type": "string", "show_if": [ [ "advanced", "=", true ] ], "default": "" } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "show_if": [ [ "advanced", "=", true ] ], "default": [], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your cert-manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Certificate Secret (Advanced)", "schema": { "show_if": [ [ "certificateIssuer", "=", "" ] ], "type": "string", "default": "" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "ingressList", "label": "Add Manual Custom Ingresses", "group": "Ingress", "schema": { "type": "list", "default": [], "items": [ { "variable": "ingressListEntry", "label": "Custom Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "name", "label": "Name", "schema": { "type": "string", "default": "" } }, { "variable": "ingressClassName", "label": "IngressClass Name", "schema": { "type": "string", "default": "" } }, { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } }, { "variable": "overrideService", "label": "Linked Service", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "Service Name", "schema": { "type": "string", "default": "" } }, { "variable": "port", "label": "Service Port", "schema": { "type": "int" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "default": [], "show_if": [ [ "certificateIssuer", "=", "" ] ], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your Cert-Manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Secret (Advanced)", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description", "description": "defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } } ] } } ] } } ] } } ] } } ] }, "app_readme": "Allow external services to be used like Apps.
\nThis App is supplied by TrueCharts, for more information visit the manual: https://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
", "detailed_readme": "TrueCharts can be installed as both normal Helm Charts or as TrueNAS SCALE Apps.\nBoth solutions are fully supported, but we heavily advice the use of normal Helm Charts where possible
\nFor more information about this Chart, please check the docs on the TrueCharts website
\nThis chart is not maintained by the upstream project and any issues with the chart should be raised here
\nTo install TrueCharts Helm charts using Helm, you can use our OCI Repository.
\nhelm install mychart oci://tccr.io/truecharts/CHARTNAME
For more information on how to install TrueCharts Helm charts, checkout the instructions on the website: https://truecharts.org/helm/
\nFor more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the quick-start guides for TrueNAS SCALE.
\nTo view the chart specific options, please view Values.yaml included in the chart.
\nAll our Charts use a shared \"common\" library chart that contains most of the templating and options.\nFor the complete overview of all available options, please checkout the documentation for them on the website: https://truecharts.org/common/
\nAll our charts have dedicated documentation pages.\nThe documentation for this chart can be found here:\nhttps://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
\nAll Rights Reserved - The TrueCharts Project
", "changelog": "for the complete changelog, please refer to the website
\nImportant:
" }, "13.8.13": { "healthy": true, "supported": true, "healthy_error": null, "location": "/home/runner/_work/catalog/catalog/stable/external-service/13.8.13", "last_update": "2024-05-29 12:35:14", "required_features": [], "human_version": "3.19.1_13.8.13", "version": "13.8.13", "chart_metadata": { "annotations": { "max_scale_version": "24.04.0", "min_scale_version": "23.10.0", "truecharts.org/category": "networking", "truecharts.org/max_helm_version": "3.14", "truecharts.org/min_helm_version": "3.11", "truecharts.org/train": "stable" }, "apiVersion": "v2", "appVersion": "3.19.1", "dependencies": [ { "name": "common", "version": "20.3.11", "repository": "oci://tccr.io/truecharts", "condition": "", "alias": "", "tags": [], "import-values": [] } ], "deprecated": false, "description": "Allow external services to be used like Apps.", "home": "https://truecharts.org/charts/stable/external-service", "icon": "https://truecharts.org/img/hotlink-ok/chart-icons/external-service.webp", "keywords": [ "external-service", "reverse-proxy" ], "kubeVersion": ">=1.24.0-0", "maintainers": [ { "name": "TrueCharts", "email": "info@truecharts.org", "url": "https://truecharts.org" } ], "name": "external-service", "sources": [ "https://github.com/truecharts/charts/tree/master/charts/stable/external-service", "https://hub.docker.com/_/alpine" ], "type": "application", "version": "13.8.13" }, "app_metadata": null, "schema": { "groups": [ { "name": "Image", "description": "Configured the images to be used for the Chart.\nIt's wise to use \"digest pinned\" tags and to avoid using \"latest\".\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/#images\n" }, { "name": "General", "description": "For TrueNAS SCALE We've grouped a number of settings here, that all effact how apps run in general.\n\nCheckout the following documentation for more information:\n - https://truecharts.org/common/global/\n - https://truecharts.org/common/#tz\n - https://truecharts.org/common/podoptions/\n - Image Pull Secrets\n" }, { "name": "Workload", "description": "These settings configure how the actual Pods and containers are running.\nGenerally, on SCALE, we only expose a limited subset of these settings for the primary workload and container.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/workload/\n- https://truecharts.org/common/container/\n" }, { "name": "App Configuration", "description": "Every application has different values that may be required to run or have multiple options that the user may choose to enable or disable to change the behavior of the application.\nMost options should have a Tooltip (Circled Question Mark) to further describe said option.\n\nTo find more information, lookup your chart-specific documentation in the Charts List: https://truecharts.org/charts/description-list/\n" }, { "name": "Services", "description": "Service and Networking options for any applications are contained here.\nSome applications may have complicated networking setups with multiple options or some may have no options here at all.\n\nOptions here include the service and port configurations for the application, and more may be enabled or changed under the Advanced Settings and Show Expert Config boxes.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/service/\n" }, { "name": "Networking", "description": "Contains advanced networking options that are not actively supported by the TrueCharts team.\nCurrently only contains scaleExternalInterfaces.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/scaleexternalinterface/\n" }, { "name": "Persistence", "description": "Many applications will have certain options for storage to be configurable by the user, the main two being PVC and hostpath but may include other types.\nThis storage is called Persistence since it is not deleted upon restart or upgrade of an application.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/persistence/\n- https://truecharts.org/scale/guides/nfs-share/\n- https://truecharts.org/general/faq/#why-pvc-is-recommended-over-hostpath\n" }, { "name": "Ingress", "description": "Ingress (more commonly known as Reverse Proxy) settings can be configured here. This is how Kubernetes connects your Applications in containers to FQDNs (fully qualified domain names).\nIf you choose to enable this you must have a \"Ingress Provider\" aka \"Reverse Proxy\" installed (We highly advice Traefik: https://truecharts.org/charts/premium/traefik/)\nIt also requiresa DNS service to actually resolve the DNS name of the FQDN specified.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/ingress/\n" }, { "name": "SecurityContext", "description": "The security settings for each application and/or permissions that each application may have for the files/directories created.\nEach application will come with predefined permissions but users may want to change certain setting depending on their usage or capabilities.\n\nUnless necessary users are advised to keep this section mostly to defaults.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/securitycontext/\n" }, { "name": "Resources", "description": "Resources limits that have been defined by each application are in this section.\nMost will have a specific default that some users may want to change based on their specific hardware or needs.\n\nThis also contains the options to mount GPUs or, more precisely, \"request\" GPU's to be mounted.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/resources/\n" }, { "name": "Devices", "description": "These are special \"mountpoints\" that can be used to mount miscelanious USB and PCI devices using special hostPath mounts.\nFor clearity we've decided to seperate this from persistence on SCALE.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/persistence/device/\n- https://truecharts.org/scale/guides/pci-passthrough/\n" }, { "name": "Middlewares", "description": "Traefik Middlewares" }, { "name": "StorageClass", "description": "StorageClasses define where to storage Storage.\n\nCheckout the following documentation for more information:\n" }, { "name": "Metrics", "description": "Contains options to configure Prometheus metrics for the application.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/metrics/\n" }, { "name": "Addons", "description": "Addons that are supplied by the TrueCharts team to add additional capabilities for users to use on top of the application\u2019s defaults.\nThings included here are VPN addons, Codeserver for editing files inside the application\u2019s container, Netshoot for network troubelshooting, etc.\n\nGenerally not required for use but may be necessary or usefull at times for specific applications.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/addons/\n- https://truecharts.org/scale/guides/vpn-setup/\n" }, { "name": "Experimental", "description": "Experimental Configuration Options\nOften these are not fully flushed-out, could randomly break or might not work at-all.\n" }, { "name": "Postgresql", "description": "For Postgresql we use \"CloudNative-PG\" as a backend, which has to be installed first.\n\nCheckout the following documentation for more information:\n- https://truecharts.org/common/cnpg/\n- https://truecharts.org/scale/guides/sql-export/\n- https://truecharts.org/scale/guides/recover-cnpg/\n" }, { "name": "Dependencies", "description": "contains dependency setting for which we, currently, do not have seperate catagories (yet)\n" }, { "name": "Documentation", "description": "We added this section to make everyone aware that OpenSource isn't always easy.\nIt doesn't keep existing without signficant ongoing support, so please consider supporting TrueCharts and other OpenSource projects.\n\nBefore installing, be sure you've followed the https://truecharts.org/scale/guides/getting-started/\nWe would also advice going over our https://truecharts.org/scale/guides/scale-intro/\nand many of the other documentation pages...\n" } ], "portals": { "open": { "protocols": [ "$kubernetes-resource_configmap_tcportal-open_protocol" ], "host": [ "$kubernetes-resource_configmap_tcportal-open_host" ], "ports": [ "$kubernetes-resource_configmap_tcportal-open_port" ] } }, "questions": [ { "variable": "global", "group": "General", "label": "Global Settings", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "stopAll", "label": "Stop All", "description": "Stops All Running pods and hibernates cnpg", "schema": { "type": "boolean", "default": false } } ] } }, { "variable": "service", "group": "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": [ { "variable": "enabled", "label": "Enable the service", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "type", "label": "Service Type", "description": "ExternalIP gets connected to using an IP and port, ExternalName gets connected to using a domain name", "schema": { "type": "string", "default": "ExternalIP", "enum": [ { "value": "ExternalName", "description": "ExternalName" }, { "value": "ExternalIP", "description": "ExternalIP" } ] } }, { "variable": "externalName", "label": "External Service Domainname", "description": "Domainname of External service", "schema": { "show_if": [ [ "type", "=", "ExternalName" ] ], "type": "string", "default": "google.com" } }, { "variable": "externalIP", "label": "External Service IP", "description": "IP of External service", "schema": { "show_if": [ [ "type", "=", "ExternalIP" ] ], "type": "string", "default": "1.1.1.1" } }, { "variable": "ports", "label": "Service's Port(s) Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Service Port Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable the port", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "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": "port", "label": "Service Port", "description": "Both the external service port and internal service port will be the same", "schema": { "type": "int", "default": 10003 } } ] } } ] } } ] } } ] } }, { "variable": "ingress", "label": "", "group": "Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": false, "show_subquestions_if": true, "subquestions": [ { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [ { "path": "/", "pathType": "Prefix" } ], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } } ] } } ] } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests (advanced)", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace (optional)", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name (Optional)", "description": "Defaults to chart name", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description (Optional)", "description": "Defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "icon", "label": "Icon (Optional)", "description": "Defaults to chart icon", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "widget", "label": "Widget Settings", "schema": { "type": "dict", "additional_attrs": true, "show_if": [ [ "enabled", "=", true ] ], "attrs": [ { "variable": "enabled", "label": "Enable Widget", "description": "When disabled all widget annotations are skipped.", "schema": { "type": "boolean", "default": true } }, { "variable": "custom", "label": "Options", "schema": { "type": "dict", "additional_attrs": true, "attrs": [ { "variable": "key", "label": "API-key (key)", "schema": { "type": "string", "default": "" } } ] } }, { "variable": "customkv", "label": "Custom Options", "schema": { "type": "list", "default": [], "items": [ { "variable": "option", "label": "Option", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "key", "label": "Key", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "value", "label": "Value", "schema": { "type": "string", "default": "", "required": true } } ] } } ] } } ] } } ] } } ] } }, { "variable": "advanced", "label": "Show Advanced Settings", "description": "Advanced settings are not covered by TrueCharts Support", "schema": { "type": "boolean", "default": false } }, { "variable": "ingressClassName", "label": "(Advanced/Optional) IngressClass Name", "schema": { "type": "string", "show_if": [ [ "advanced", "=", true ] ], "default": "" } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "show_if": [ [ "advanced", "=", true ] ], "default": [], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your cert-manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Certificate Secret (Advanced)", "schema": { "show_if": [ [ "certificateIssuer", "=", "" ] ], "type": "string", "default": "" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "ingressList", "label": "Add Manual Custom Ingresses", "group": "Ingress", "schema": { "type": "list", "default": [], "items": [ { "variable": "ingressListEntry", "label": "Custom Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "name", "label": "Name", "schema": { "type": "string", "default": "" } }, { "variable": "ingressClassName", "label": "IngressClass Name", "schema": { "type": "string", "default": "" } }, { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } }, { "variable": "overrideService", "label": "Linked Service", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "Service Name", "schema": { "type": "string", "default": "" } }, { "variable": "port", "label": "Service Port", "schema": { "type": "int" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "default": [], "show_if": [ [ "certificateIssuer", "=", "" ] ], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your Cert-Manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Secret (Advanced)", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description", "description": "defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } } ] } } ] } } ] } } ] } } ] }, "app_readme": "Allow external services to be used like Apps.
\nThis App is supplied by TrueCharts, for more information visit the manual: https://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
", "detailed_readme": "TrueCharts can be installed as both normal Helm Charts or as TrueNAS SCALE Apps.\nBoth solutions are fully supported, but we heavily advice the use of normal Helm Charts where possible
\nFor more information about this Chart, please check the docs on the TrueCharts website
\nThis chart is not maintained by the upstream project and any issues with the chart should be raised here
\nTo install TrueCharts Helm charts using Helm, you can use our OCI Repository.
\nhelm install mychart oci://tccr.io/truecharts/CHARTNAME
For more information on how to install TrueCharts Helm charts, checkout the instructions on the website: https://truecharts.org/helm/
\nFor more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the quick-start guides for TrueNAS SCALE.
\nTo view the chart specific options, please view Values.yaml included in the chart.
\nAll our Charts use a shared \"common\" library chart that contains most of the templating and options.\nFor the complete overview of all available options, please checkout the documentation for them on the website: https://truecharts.org/common/
\nAll our charts have dedicated documentation pages.\nThe documentation for this chart can be found here:\nhttps://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
\nAll Rights Reserved - The TrueCharts Project
", "changelog": "for the complete changelog, please refer to the website
\nImportant:
" }, "12.3.0": { "healthy": true, "supported": true, "healthy_error": null, "location": "/home/runner/_work/catalog/catalog/stable/external-service/12.3.0", "last_update": "2024-05-29 12:35:14", "required_features": [], "human_version": "3.19.1_12.3.0", "version": "12.3.0", "chart_metadata": { "annotations": { "max_scale_version": "24.04.0", "min_scale_version": "23.10.0", "truecharts.org/category": "networking", "truecharts.org/max_helm_version": "3.14", "truecharts.org/min_helm_version": "3.12", "truecharts.org/train": "stable" }, "apiVersion": "v2", "appVersion": "3.19.1", "dependencies": [ { "name": "common", "version": "17.5.0", "repository": "oci://tccr.io/truecharts", "condition": "", "alias": "", "tags": [], "import-values": [] } ], "deprecated": false, "description": "Allow external services to be used like Apps.", "home": "https://truecharts.org/charts/stable/external-service", "icon": "https://truecharts.org/img/hotlink-ok/chart-icons/external-service.png", "keywords": [ "external-service", "reverse-proxy" ], "kubeVersion": ">=1.24.0-0", "maintainers": [ { "name": "TrueCharts", "email": "info@truecharts.org", "url": "https://truecharts.org" } ], "name": "external-service", "sources": [ "https://github.com/truecharts/charts/tree/master/charts/stable/external-service", "https://hub.docker.com/_/alpine" ], "type": "application", "version": "12.3.0" }, "app_metadata": null, "schema": { "groups": [ { "name": "Container Image", "description": "Image to be used for container" }, { "name": "General Settings", "description": "General Deployment Settings" }, { "name": "Workload Settings", "description": "Workload Settings" }, { "name": "App Configuration", "description": "App Specific Config Options" }, { "name": "Networking and Services", "description": "Configure Network and Services for Container" }, { "name": "Storage and Persistence", "description": "Persist and Share Data that is Separate from the Container" }, { "name": "Ingress", "description": "Ingress Configuration" }, { "name": "Security and Permissions", "description": "Configure Security Context and Permissions" }, { "name": "Resources and Devices", "description": "Specify Resources/Devices to be Allocated to Workload" }, { "name": "Middlewares", "description": "Traefik Middlewares" }, { "name": "Metrics", "description": "Metrics" }, { "name": "Addons", "description": "Addon Configuration" }, { "name": "Backup Configuration", "description": "Configure Velero Backup Schedule" }, { "name": "Advanced", "description": "Advanced Configuration" }, { "name": "Postgresql", "description": "Postgresql" }, { "name": "Documentation", "description": "Documentation" } ], "portals": { "open": { "protocols": [ "$kubernetes-resource_configmap_tcportal-open_protocol" ], "host": [ "$kubernetes-resource_configmap_tcportal-open_host" ], "ports": [ "$kubernetes-resource_configmap_tcportal-open_port" ] } }, "questions": [ { "variable": "global", "group": "General Settings", "label": "Global Settings", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "stopAll", "label": "Stop All", "description": "Stops All Running pods and hibernates cnpg", "schema": { "type": "boolean", "default": false } } ] } }, { "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": [ { "variable": "enabled", "label": "Enable the service", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "type", "label": "Service Type", "description": "ExternalIP gets connected to using an IP and port, ExternalName gets connected to using a domain name", "schema": { "type": "string", "default": "ExternalIP", "enum": [ { "value": "ExternalName", "description": "ExternalName" }, { "value": "ExternalIP", "description": "ExternalIP" } ] } }, { "variable": "externalName", "label": "External Service Domainname", "description": "Domainname of External service", "schema": { "show_if": [ [ "type", "=", "ExternalName" ] ], "type": "string", "default": "google.com" } }, { "variable": "externalIP", "label": "External Service IP", "description": "IP of External service", "schema": { "show_if": [ [ "type", "=", "ExternalIP" ] ], "type": "string", "default": "1.1.1.1" } }, { "variable": "ports", "label": "Service's Port(s) Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Service Port Configuration", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable the port", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "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": "port", "label": "Service Port", "description": "Both the external service port and internal service port will be the same", "schema": { "type": "int", "default": 10003 } } ] } } ] } } ] } } ] } }, { "variable": "ingress", "label": "", "group": "Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "main", "label": "Main Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": false, "show_subquestions_if": true, "subquestions": [ { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [ { "path": "/", "pathType": "Prefix" } ], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } } ] } } ] } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests (advanced)", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace (optional)", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name (Optional)", "description": "Defaults to chart name", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description (Optional)", "description": "Defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "icon", "label": "Icon (Optional)", "description": "Defaults to chart icon", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "widget", "label": "Widget Settings", "schema": { "type": "dict", "additional_attrs": true, "show_if": [ [ "enabled", "=", true ] ], "attrs": [ { "variable": "enabled", "label": "Enable Widget", "description": "When disabled all widget annotations are skipped.", "schema": { "type": "boolean", "default": true } }, { "variable": "custom", "label": "Options", "schema": { "type": "dict", "additional_attrs": true, "attrs": [ { "variable": "key", "label": "API-key (key)", "schema": { "type": "string", "default": "" } } ] } }, { "variable": "customkv", "label": "Custom Options", "schema": { "type": "list", "default": [], "items": [ { "variable": "option", "label": "Option", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "key", "label": "Key", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "value", "label": "Value", "schema": { "type": "string", "default": "", "required": true } } ] } } ] } } ] } } ] } } ] } }, { "variable": "advanced", "label": "Show Advanced Settings", "description": "Advanced settings are not covered by TrueCharts Support", "schema": { "type": "boolean", "default": false } }, { "variable": "ingressClassName", "label": "(Advanced/Optional) IngressClass Name", "schema": { "type": "string", "show_if": [ [ "advanced", "=", true ] ], "default": "" } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "show_if": [ [ "advanced", "=", true ] ], "default": [], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your cert-manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Certificate Secret (Advanced)", "schema": { "show_if": [ [ "certificateIssuer", "=", "" ] ], "type": "string", "default": "" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "ingressList", "label": "Add Manual Custom Ingresses", "group": "Ingress", "schema": { "type": "list", "default": [], "items": [ { "variable": "ingressListEntry", "label": "Custom Ingress", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "Enable Ingress", "schema": { "type": "boolean", "default": true, "hidden": true } }, { "variable": "name", "label": "Name", "schema": { "type": "string", "default": "" } }, { "variable": "ingressClassName", "label": "IngressClass Name", "schema": { "type": "string", "default": "" } }, { "variable": "hosts", "label": "Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "hostEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "host", "label": "HostName", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "paths", "label": "Paths", "schema": { "type": "list", "default": [], "items": [ { "variable": "pathEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "path", "label": "Path", "schema": { "type": "string", "required": true, "default": "/" } }, { "variable": "pathType", "label": "Path Type", "schema": { "type": "string", "required": true, "default": "Prefix" } }, { "variable": "overrideService", "label": "Linked Service", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "Service Name", "schema": { "type": "string", "default": "" } }, { "variable": "port", "label": "Service Port", "schema": { "type": "int" } } ] } } ] } } ] } } ] } } ] } }, { "variable": "tls", "label": "TLS-Settings", "schema": { "type": "list", "default": [], "show_if": [ [ "certificateIssuer", "=", "" ] ], "items": [ { "variable": "tlsEntry", "label": "Host", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "hosts", "label": "Certificate Hosts", "schema": { "type": "list", "default": [], "items": [ { "variable": "host", "label": "Host", "schema": { "type": "string", "default": "", "required": true } } ] } }, { "variable": "certificateIssuer", "label": "Use Cert-Manager clusterIssuer", "description": "add the name of your Cert-Manager clusterIssuer here for automatic tls certificates.", "schema": { "type": "string", "default": "" } }, { "variable": "clusterCertificate", "label": "Cluster Certificate (Advanced)", "description": "Add the name of your cluster-wide certificate, that you set up in the ClusterIssuer chart.", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } }, { "variable": "secretName", "label": "Use Custom Secret (Advanced)", "schema": { "type": "string", "show_if": [ [ "certificateIssuer", "=", "" ] ], "default": "" } } ] } } ] } }, { "variable": "integrations", "label": "Integrations", "description": "Connect ingress with other charts", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "traefik", "label": "Traefik", "description": "Connect ingress with Traefik", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "allowCors", "label": "Allow Cross Origin Requests", "schema": { "type": "boolean", "default": false, "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "entrypoints", "label": "Entrypoints", "schema": { "type": "list", "default": [ "websecure" ], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "entrypoint", "label": "Entrypoint", "schema": { "type": "string" } } ] } }, { "variable": "middlewares", "label": "Middlewares", "schema": { "type": "list", "default": [], "show_if": [ [ "enabled", "=", true ] ], "items": [ { "variable": "middleware", "label": "Middleware", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "name", "label": "name", "schema": { "type": "string", "default": "", "required": true } }, { "variable": "namespace", "label": "namespace", "schema": { "type": "string", "default": "" } } ] } } ] } } ] } }, { "variable": "certManager", "label": "certManager", "description": "Connect ingress with certManager", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": true } }, { "variable": "certificateIssuer", "label": "certificateIssuer", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } } ] } }, { "variable": "homepage", "label": "Homepage", "description": "Connect ingress with Homepage", "schema": { "additional_attrs": true, "type": "dict", "attrs": [ { "variable": "enabled", "label": "enabled", "schema": { "type": "boolean", "default": false } }, { "variable": "name", "label": "Name", "description": "defaults to chartname", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "description", "label": "Description", "description": "defaults to chart description", "schema": { "type": "string", "default": "", "show_if": [ [ "enabled", "=", true ] ] } }, { "variable": "group", "label": "Group", "schema": { "type": "string", "required": true, "default": "default", "show_if": [ [ "enabled", "=", true ] ] } } ] } } ] } } ] } } ] } } ] }, "app_readme": "Allow external services to be used like Apps.
\nThis App is supplied by TrueCharts, for more information visit the manual: https://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
", "detailed_readme": "TrueCharts can be installed as both normal Helm Charts or as Apps on TrueNAS SCALE.\nHowever only installations using the TrueNAS SCALE Apps system are supported.
\nFor more information about this App, please check the docs on the TrueCharts website
\nThis chart is not maintained by the upstream project and any issues with the chart should be raised here
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
\nAll Rights Reserved - The TrueCharts Project
", "changelog": "for the complete changelog, please refer to the website
\nImportant:
\nAllow external services to be used like Apps.
\nThis App is supplied by TrueCharts, for more information visit the manual: https://truecharts.org/charts/stable/external-service
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
", "detailed_readme": "TrueCharts can be installed as both normal Helm Charts or as Apps on TrueNAS SCALE.\nHowever only installations using the TrueNAS SCALE Apps system are supported.
\nFor more information about this App, please check the docs on the TrueCharts website
\nThis chart is not maintained by the upstream project and any issues with the chart should be raised here
\nTrueCharts can only exist due to the incredible effort of our staff.\nPlease consider making a donation or contributing back to the project any way you can!
\nAll Rights Reserved - The TrueCharts Project
", "changelog": "for the complete changelog, please refer to the website
\nImportant:
\n