values.schema.tmpl.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/janus-idp/helm-backstage/main/charts/backstage/values.schema.json",
    "type": "object",
    "title": "Root Schema",
    "properties": {
        "upstream": {
            "title": "Upstream Backstage chart schema.",
            "$ref": "https://raw.githubusercontent.com/backstage/charts/backstage-{{ dependencies | selectattr('name', 'equalto', 'backstage') | map(attribute='version') | list | join('') }}/charts/backstage/values.schema.json",
            "default": {
                "backstage": {
                    "image": {
                        "registry": "quay.io",
                        "repository": "janus-idp/redhat-backstage-build",
                        "tag": "latest"
                    }
                }
            }
        },
        "global": {
            "type": "object",
            "properties": {
                "clusterRouterBase": {
                    "title": "Shorthand for users who do not want to specify a custom HOSTNAME. Used ONLY with the DEFAULT upstream.backstage.appConfig value and with OCP Route enabled.",
                    "type": "string",
                    "default": "apps.example.com"
                },
                "host": {
                    "title": "Custom hostname shorthand, overrides `global.clusterRouterBase`, `upstream.ingress.host`, `route.host`, and url values in `upstream.backstage.appConfig`",
                    "type": "string",
                    "default": ""
                }
            }
        },
        "route": {
            "title": "OpenShift Route parameters.",
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "annotations": {
                    "title": "Route specific annotations.",
                    "type":  "object",
                    "default": {}
                },
                "enabled": {
                    "title": "Enable the creation of the route resource.",
                    "type": "boolean",
                    "default": false
                },
                "host": {
                    "title": "Set the host attribute to a custom value.",
                    "type": "string",
                    "default": "",
                    "examples": [
                        "https://bakstage.example.com"
                    ]
                },
                "path": {
                    "title": "Path that the router watches for, to route traffic for to the service.",
                    "type": "string",
                    "default": "/"
                },
                "wildcardPolicy": {
                    "title": "Wildcard policy if any for the route.",
                    "type": "string",
                    "default": "None",
                    "enum": [
                        "None",
                        "Subdomain"
                    ]
                },
                "tls": {
                    "title": "Route TLS parameters.",
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "enabled": {
                            "title": "Enable TLS configuration for the host defined at `route.host` parameter.",
                            "type": "boolean",
                            "default": false
                        },
                        "termination": {
                            "title": "Specify TLS termination.",
                            "type": "string",
                            "default": "edge",
                            "enum": [
                                "edge",
                                "reencrypt",
                                "passthrough"
                            ]
                        },
                        "certificate": {
                            "title": "Certificate contents.",
                            "type": "string",
                            "default": ""
                        },
                        "key": {
                            "title": "Key file contents.",
                            "type": "string",
                            "default": ""
                        },
                        "caCertificate": {
                            "title": "Cert authority certificate contents.",
                            "type": "string",
                            "default": ""
                        },
                        "destinationCACertificate": {
                            "title": "Contents of the ca certificate of the final destination.",
                            "type": "string",
                            "default": ""
                        },
                        "insecureEdgeTerminationPolicy": {
                            "title": "Indicates the desired behavior for insecure connections to a route.",
                            "type": "string",
                            "default": "Redirect",
                            "enum": [
                                "Redirect",
                                "None",
                                ""
                            ]
                        }
                    }
                }
            }
        }
    }
}